/
Buffer.pm
1668 lines (1471 loc) · 50 KB
/
Buffer.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package FCGI::Buffer;
use strict;
use warnings;
# FIXME: save_to treats ?arg1=a&arg2=b and ?arg2=b&arg1=a as different
# FIXME: save_to treats /cgi-bin/foo.fcgi and /cgi-bin2/foo.fcgi as the same
use Digest::MD5;
use File::Path;
use File::Spec;
use IO::String;
use CGI::Info;
use Carp;
use HTTP::Date;
use DBI;
=head1 NAME
FCGI::Buffer - Verify, Cache and Optimise FCGI Output
=head1 VERSION
Version 0.15
=cut
our $VERSION = '0.15';
=head1 SYNOPSIS
FCGI::Buffer verifies the HTML that you produce by passing it through
C<HTML::Lint>.
FCGI::Buffer optimises FCGI programs by reducing, filtering and compressing
output to speed up the transmission and by nearly seamlessly making use of
client and server caches.
To make use of client caches, that is to say to reduce needless calls
to your server asking for the same data:
use FCGI;
use FCGI::Buffer;
# ...
my $request = FCGI::Request();
while($request->FCGI::Accept() >= 0) {
my $buffer = FCGI::Buffer->new();
$buffer->init(
optimise_content => 1,
lint_content => 0,
);
# ...
}
To also make use of server caches, that is to say to save regenerating
output when different clients ask you for the same data, you will need
to create a cache.
But that's simple:
use FCGI;
use CHI;
use FCGI::Buffer;
# ...
my $request = FCGI::Request();
while($request->FCGI::Accept() >= 0) {
my $buffer = FCGI::Buffer->new();
$buffer->init(
optimise_content => 1,
lint_content => 0,
cache => CHI->new(driver => 'File')
);
if($buffer->is_cached()) {
# Nothing has changed - use the version in the cache
$request->Finish();
next;
# ...
}
}
To temporarily prevent the use of server-side caches, for example whilst
debugging before publishing a code change, set the NO_CACHE environment variable
to any non-zero value.
If you get errors about Wide characters in print it means that you've
forgotten to emit pure HTML on non-ascii characters.
See L<HTML::Entities>.
As a hack work around you could also remove accents and the like by using
L<Text::Unidecode>,
which works well but isn't really what you want.
=head1 SUBROUTINES/METHODS
=cut
use constant MIN_GZIP_LEN => 32;
=head2 new
Create an FCGI::Buffer object. Do one of these for each FCGI::Accept.
=cut
# FIXME: Call init() on any arguments that are given
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
# Use FCGI::Buffer->new(), not FCGI::Buffer::new()
if(!defined($class)) {
carp(__PACKAGE__, ' use ->new() not ::new() to instantiate');
return;
}
my $buf = IO::String->new();
my $rc = {
buf => $buf,
old_buf => select($buf),
generate_304 => 1,
generate_last_modified => 1,
compress_content => 1,
optimise_content => 0,
lint_content => 0,
};
# $rc->{o} = ();
if($ENV{'SERVER_PROTOCOL'} &&
($ENV{'SERVER_PROTOCOL'} eq 'HTTP/1.1')) {
$rc->{generate_etag} = 1;
} else {
$rc->{generate_etag} = 0;
}
return bless $rc, $class;
}
sub DESTROY {
if(defined($^V) && ($^V ge 'v5.14.0')) {
return if ${^GLOBAL_PHASE} eq 'DESTRUCT'; # >= 5.14.0 only
}
my $self = shift;
if($self->{'logger'}) {
$self->{'logger'}->info('In DESTROY');
}
select($self->{old_buf});
if((!defined($self->{buf})) || (!defined($self->{buf}->getpos()))) {
# Unlikely
if($self->{'logger'}) {
$self->{'logger'}->info('Nothing to send');
}
return;
}
my $pos = $self->{buf}->getpos();
$self->{buf}->setpos(0);
my $buf;
read($self->{buf}, $buf, $pos);
my $headers;
($headers, $self->{body}) = split /\r?\n\r?\n/, $buf, 2;
if($self->{'logger'}) {
if($ENV{'HTTP_IF_NONE_MATCH'}) {
$self->{logger}->debug("HTTP_IF_NONE_MATCH: $ENV{HTTP_IF_NONE_MATCH}");
}
if($ENV{'HTTP_IF_MODIFIED_SINCE'}) {
$self->{logger}->debug("HTTP_IF_MODIFIED_SINCE: $ENV{HTTP_IF_MODIFIED_SINCE}");
}
$self->{logger}->debug("Generate_etag = $self->{generate_etag}",
"Generate_304 = $self->{generate_304}",
"Generate_last_modified = $self->{generate_last_modified}");
}
unless($headers || $self->is_cached()) {
if($self->{'logger'}) {
$self->{'logger'}->debug('There was no output');
}
return;
}
if($ENV{'REQUEST_METHOD'} && ($ENV{'REQUEST_METHOD'} eq 'HEAD')) {
$self->{send_body} = 0;
} else {
$self->{send_body} = 1;
}
if($headers) {
$self->_set_content_type($headers);
}
if(defined($self->{body}) && ($self->{body} eq '')) {
# E.g. if header of Location is given with no body, for
# redirection
delete $self->{body};
if($self->{cache}) {
# Don't try to retrieve it below from the cache
$self->{send_body} = 0;
}
} elsif(defined($self->{content_type})) {
my @content_type = @{$self->{content_type}};
if(defined($content_type[0]) && (lc($content_type[0]) eq 'text') && (lc($content_type[1]) =~ /^html/) && defined($self->{body})) {
if($self->{optimise_content}) {
# require HTML::Clean;
require HTML::Packer; # Overkill using HTML::Clean and HTML::Packer...
if($self->{'logger'}) {
$self->{'logger'}->trace('Packer');
}
my $oldlength = length($self->{body});
my $newlength;
if($self->{optimise_content} == 1) {
$self->_optimise_content();
} else {
while(1) {
$self->_optimise_content();
$newlength = length($self->{body});
last if ($newlength >= $oldlength);
$oldlength = $newlength;
}
}
# If we're on http://www.example.com and have a link
# to http://www.example.com/foo/bar.htm, change the
# link to /foo/bar.htm - there's no need to include
# the site name in the link
unless(defined($self->{info})) {
if($self->{cache}) {
$self->{info} = CGI::Info->new({ cache => $self->{cache} });
} else {
$self->{info} = CGI::Info->new();
}
}
my $href = $self->{info}->host_name();
my $protocol = $self->{info}->protocol();
unless($protocol) {
$protocol = 'http';
}
$self->{body} =~ s/<a\s+?href="$protocol:\/\/$href"/<a href="\/"/gim;
$self->{body} =~ s/<a\s+?href="$protocol:\/\/$href/<a href="/gim;
$self->{body} =~ s/<a\s+?href="$protocol:\/\//<a href="\/\//gim;
# If we're in "/cgi-bin/foo.cgi?arg1=a" replace
# "/cgi-bin/foo.cgi?arg2=b" with "?arg2=b"
if(my $script_name = $ENV{'SCRIPT_NAME'}) {
if($script_name =~ /^\//) {
$self->{body} =~ s/<a\s+?href="$script_name(\?.+)?"/<a href="$1"/gim;
}
}
# TODO use URI->path_segments to change links in
# /aa/bb/cc/dd.htm which point to /aa/bb/ff.htm to
# ../ff.htm
# TODO: <img border=0 src=...>
$self->{body} =~ s/<img\s+?src="$protocol:\/\/$href"/<img src="\/"/gim;
$self->{body} =~ s/<img\s+?src="$protocol:\/\/$href/<img src="/gim;
# Don't use HTML::Clean because of RT402
# my $h = new HTML::Clean(\$self->{body});
# # $h->compat();
# $h->strip();
# my $ref = $h->data();
# Don't always do javascript 'best' since it's confused
# by the common <!-- HIDE technique.
my $options = {
remove_comments => 1,
remove_newlines => 0,
do_stylesheet => 'minify'
};
if($self->{optimise_content} >= 2) {
$options->{do_javascript} = 'best';
$self->{body} =~ s/(<script.*?>)\s*<!--/$1/gi;
$self->{body} =~ s/\/\/-->\s*<\/script>/<\/script>/gi;
$self->{body} =~ s/(<script.*?>)\s+/$1/gi;
}
$self->{body} = HTML::Packer->init()->minify(\$self->{body}, $options);
if($self->{optimise_content} >= 2) {
# Change document.write("a"); document.write("b")
# into document.write("a"+"b");
while(1) {
$self->{body} =~ s/<script\s*?type\s*?=\s*?"text\/javascript"\s*?>(.*?)document\.write\((.+?)\);\s*?document\.write\((.+?)\)/<script type="text\/JavaScript">${1}document.write($2+$3)/igs;
$newlength = length($self->{body});
last if ($newlength >= $oldlength);
$oldlength = $newlength;
}
}
}
if($self->{lint_content}) {
require HTML::Lint;
HTML::Lint->import;
if($self->{'logger'}) {
$self->{'logger'}->trace('Lint');
}
my $lint = HTML::Lint->new();
$lint->parse($self->{body});
$lint->eof();
if($lint->errors) {
$headers = 'Status: 500 Internal Server Error';
@{$self->{o}} = ('Content-type: text/plain');
$self->{body} = '';
foreach my $error ($lint->errors) {
my $errtext = $error->where() . ': ' . $error->errtext() . "\n";
warn($errtext);
$self->{body} .= $errtext;
}
}
}
}
}
if(defined($headers) && ($headers =~ /^Status: (\d+)/m)) {
$self->{status} = $1;
} elsif(defined($self->{info})) {
$self->{status} = $self->{info}->status();
} else {
$self->{status} = 200;
}
if($self->{'logger'}) {
$self->{'logger'}->debug("Initial status = $self->{status}");
}
# Generate the eTag before compressing, since the compressed data
# includes the mtime field which changes thus causing a different
# Etag to be generated
if($ENV{'SERVER_PROTOCOL'} &&
($ENV{'SERVER_PROTOCOL'} eq 'HTTP/1.1') &&
$self->{generate_etag} && defined($self->{body})) {
# encode to avoid "Wide character in subroutine entry"
require Encode;
$self->{_encode_loaded} = 1;
$self->{etag} = '"' . Digest::MD5->new->add(Encode::encode_utf8($self->{body}))->hexdigest() . '"';
if($ENV{'HTTP_IF_NONE_MATCH'} && $self->{generate_304} && ($self->{status} == 200)) {
$self->_check_if_none_match();
}
}
my $dbh;
if(my $save_to = $self->{save_to}) {
my $sqlite_file = File::Spec->catfile($save_to->{directory}, 'fcgi.buffer.sql');
if($self->{logger}) {
$self->{logger}->debug("save_to sqlite file: $sqlite_file");
}
if(!-r $sqlite_file) {
if(!-d $save_to->{directory}) {
mkdir $save_to->{directory};
}
$dbh = DBI->connect("dbi:SQLite:dbname=$sqlite_file", undef, undef);
if($self->{save_to}->{create_table}) {
$dbh->prepare('CREATE TABLE fcgi_buffer(key char PRIMARY KEY, language char, browser_type char, path char UNIQUE NOT NULL, uri char NOT NULL, creation timestamp NOT NULL)')->execute();
}
} else {
$dbh = DBI->connect("dbi:SQLite:dbname=$sqlite_file", undef, undef);
}
}
my $encoding = $self->_should_gzip();
my $unzipped_body = $self->{body};
if(defined($unzipped_body)) {
my $range = $ENV{'Range'} ? $ENV{'Range'} : $ENV{'HTTP_RANGE'};
if($range && !$self->{cache}) {
# TODO: Partials
if($range =~ /^bytes=(\d*)-(\d*)/) {
if($1 && $2) {
$self->{body} = substr($self->{body}, $1, $2-$1);
} elsif($1) {
$self->{body} = substr($self->{body}, $1);
} elsif($2) {
$self->{body} = substr($self->{body}, 0, $2);
}
$unzipped_body = $self->{body};
$self->{'status'} = 206;
}
}
$self->_compress({ encoding => $encoding });
}
if($self->{cache}) {
require Storable;
my $cache_hash;
my $key = $self->_generate_key();
# Cache unzipped version
if(!defined($self->{body})) {
if($self->{send_body}) {
$self->{cobject} = $self->{cache}->get_object($key);
if(defined($self->{cobject})) {
$cache_hash = Storable::thaw($self->{cobject}->value());
$headers = $cache_hash->{'headers'};
$self->_set_content_type($headers);
@{$self->{o}} = ("X-FCGI-Buffer-$VERSION: Hit");
if($self->{info}) {
my $host_name = $self->{info}->host_name();
push @{$self->{o}}, "X-Cache: HIT from $host_name";
push @{$self->{o}}, "X-Cache-Lookup: HIT from $host_name";
} else {
push @{$self->{o}}, 'X-Cache: HIT';
push @{$self->{o}}, 'X-Cache-Lookup: HIT';
}
} else {
carp( __PACKAGE__, ": error retrieving data for key $key");
}
}
# Nothing has been output yet, so we can check if it's
# OK to send 304 if possible
if($self->{send_body} && $ENV{'SERVER_PROTOCOL'} &&
($ENV{'SERVER_PROTOCOL'} eq 'HTTP/1.1') &&
$self->{generate_304} && ($self->{status} == 200)) {
if($ENV{'HTTP_IF_MODIFIED_SINCE'}) {
$self->_check_modified_since({
since => $ENV{'HTTP_IF_MODIFIED_SINCE'},
modified => $self->{cobject}->created_at()
});
}
}
if($self->{send_body} && ($self->{status} == 200)) {
$self->{body} = $cache_hash->{'body'};
if($dbh) {
my $changes = $self->_save_to($self->{body}, $dbh);
if($changes && (my $ttl = $self->{save_to}->{ttl})) {
push @{$self->{o}}, 'Expires: ' . HTTP::Date::time2str(time + $ttl);
}
}
if(!defined($self->{body})) {
# Panic
$headers = 'Status: 500 Internal Server Error';
@{$self->{o}} = ('Content-type: text/plain');
$self->{body} = "Can't retrieve body for key $key, cache_hash contains:\n";
foreach my $k (keys %{$cache_hash}) {
$self->{body} .= "\t$k\n";
}
if($dbh) {
my $query = "SELECT DISTINCT path FROM fcgi_buffer WHERE key = '$key'";
my $sth = $dbh->prepare($query);
if($self->{logger}) {
$self->{logger}->debug($query);
}
if($sth->execute() && (my $href = $sth->fetchrow_hashref())) {
if(my $path = $href->{'path'}) {
unlink($path);
}
}
$query = "DELETE FROM fcgi_buffer WHERE key = '$key'";
$dbh->do($query);
if($self->{logger}) {
$self->{logger}->debug($query);
}
}
$self->{cache}->remove($key);
if($self->{logger}) {
$self->{logger}->error("Can't retrieve body for key $key");
} else {
carp "Can't retrieve body for key $key";
}
warn($self->{body});
$self->{send_body} = 0;
$self->{status} = 500;
}
}
if($self->{send_body} && $ENV{'SERVER_PROTOCOL'} &&
($ENV{'SERVER_PROTOCOL'} eq 'HTTP/1.1') &&
($self->{status} == 200)) {
if($ENV{'HTTP_IF_NONE_MATCH'} && $self->{generate_etag}) {
if(!defined($self->{etag})) {
unless($self->{_encode_loaded}) {
require Encode;
$self->{_encode_loaded} = 1;
}
$self->{etag} = '"' . Digest::MD5->new->add(Encode::encode_utf8($self->{body}))->hexdigest() . '"';
}
$self->_check_if_none_match();
}
}
if($self->{status} == 200) {
$encoding = $self->_should_gzip();
if($self->{send_body}) {
if($self->{generate_etag} && !defined($self->{etag}) && ((!defined($headers)) || ($headers !~ /^ETag: /m))) {
$self->{etag} = '"' . Digest::MD5->new->add(Encode::encode_utf8($self->{body}))->hexdigest() . '"';
}
$self->_compress({ encoding => $encoding });
}
}
my $cannot_304 = !$self->{generate_304};
unless($self->{etag}) {
if(defined($headers) && ($headers =~ /^ETag: "([a-z0-9]{32})"/m)) {
$self->{etag} = $1;
} else {
$self->{etag} = $cache_hash->{'etag'};
}
}
if($ENV{'HTTP_IF_NONE_MATCH'} && $self->{send_body} && ($self->{status} != 304) && $self->{generate_304}) {
if(!$self->_check_if_none_match()) {
$cannot_304 = 1;
}
}
if($self->{cobject}) {
if($ENV{'HTTP_IF_MODIFIED_SINCE'} && ($self->{status} != 304) && !$cannot_304) {
$self->_check_modified_since({
since => $ENV{'HTTP_IF_MODIFIED_SINCE'},
modified => $self->{cobject}->created_at()
});
}
if(($self->{status} == 200) && $self->{generate_last_modified}) {
if($self->{logger}) {
$self->{logger}->debug('Set Last-Modified to ', HTTP::Date::time2str($self->{cobject}->created_at()));
}
push @{$self->{o}}, "Last-Modified: " . HTTP::Date::time2str($self->{cobject}->created_at());
}
}
} else {
# Not in the server side cache
if($self->{status} == 200) {
my $changes = $self->_save_to($unzipped_body, $dbh);
unless($self->{cache_age}) {
# It would be great if CHI::set()
# allowed the time to be 'lru' for least
# recently used.
$self->{cache_age} = '10 minutes';
}
$cache_hash->{'body'} = $unzipped_body;
if($changes && $encoding) {
$self->_compress({ encoding => $encoding });
}
if($self->{o} && scalar(@{$self->{o}})) {
# Remember, we're storing the UNzipped
# version in the cache
my $c;
if(defined($headers) && length($headers)) {
$c = "$headers\r\n" . join("\r\n", @{$self->{o}});
} else {
$c = join("\r\n", @{$self->{o}});
}
$c =~ s/^Content-Encoding: .+$//mg;
$c =~ s/^Vary: Accept-Encoding.*\r?$//mg;
$c =~ s/\n+/\n/gs;
if(length($c)) {
$cache_hash->{'headers'} = $c;
}
} elsif(defined($headers) && length($headers)) {
$headers =~ s/^Content-Encoding: .+$//mg;
$headers =~ s/^Vary: Accept-Encoding.*\r?$//mg;
$headers =~ s/\n+/\n/gs;
if(length($headers)) {
$cache_hash->{'headers'} = $headers;
}
}
if($self->{generate_etag} && defined($self->{etag})) {
$cache_hash->{'etag'} = $self->{etag};
}
# TODO: Support the Expires header
# if($headers !~ /^Expires: /m))) {
# }
if($self->{logger}) {
$self->{logger}->debug("Store $key in the cache, age = ", $self->{cache_age}, ' ', length($cache_hash->{'body'}), ' bytes');
}
$self->{cache}->set($key, Storable::freeze($cache_hash), $self->{cache_age});
# Create a static page with the information and link to that in the output
# HTML
if($dbh && $self->{info} && $self->{save_to} && (my $request_uri = $ENV{'REQUEST_URI'})) {
my $query = "SELECT DISTINCT creation FROM fcgi_buffer WHERE key = ?";
if($self->{logger}) {
$self->{logger}->debug("$query: $key");
}
my $sth = $dbh->prepare($query);
$sth->execute($key);
if(my $href = $sth->fetchrow_hashref()) {
if(my $ttl = $self->{save_to}->{ttl}) {
push @{$self->{o}}, 'Expires: ' .
HTTP::Date::time2str($href->{'creation'} + $ttl);
}
} else {
my $dir = $self->{save_to}->{directory};
my $browser_type = $self->{info}->browser_type();
my $language;
if($self->{'lingua'}) {
$language = $self->{lingua}->language();
if($language =~ /([\w\s]+)/i) {
$language = $1; # Untaint
}
} else {
$language = 'default';
}
my $bdir = File::Spec->catfile($dir, $browser_type);
if($bdir =~ /^([\/\\])(.+)$/) {
$bdir = "$1$2"; # Untaint
}
my $ldir = File::Spec->catfile($bdir, $language);
my $sdir = File::Spec->catfile($ldir, $self->{info}->script_name());
if($self->{logger}) {
$self->{logger}->debug("Create paths to $sdir");
}
File::Path::make_path($sdir);
my $path = File::Spec->catfile($sdir, $self->{info}->as_string() . '.html');
if($path =~ /^(.+)$/) {
$path = $1; # Untaint
$path =~ tr/[\|;]/_/;
}
if(open(my $fout, '>', $path)) {
my $u = $request_uri;
$u =~ s/\?/\\?/g;
$u =~ s/\)/\\)/g;
my $copy = $unzipped_body;
my $changes = ($copy =~ s/<a\s+href="$u"/<a href="$path"/gi);
# handle <a href="?arg3=4">Call self with different args</a>
my $script_name = $ENV{'SCRIPT_NAME'};
$copy =~ s/<a\s+href="(\?.+?)"/<a href="$script_name$1"/gi;
# Avoide Wide character
unless($self->{_encode_loaded}) {
require Encode;
$self->{_encode_loaded} = 1;
}
print $fout Encode::encode_utf8($copy);
close $fout;
# Do INSERT OR REPLACE in case another program has
# got in first,
$query = "INSERT OR REPLACE INTO fcgi_buffer(key, language, browser_type, path, uri, creation) VALUES('$key', '$language', '$browser_type', '$path', '$request_uri', strftime('\%s','now'))";
if($self->{logger}) {
$self->{logger}->debug($query);
}
$dbh->prepare($query)->execute();
if($changes && (my $ttl = $self->{save_to}->{ttl})) {
push @{$self->{o}}, 'Expires: ' . HTTP::Date::time2str(time + $ttl);
}
} else {
if($self->{logger}) {
$self->{logger}->warn("Can't create $path");
}
}
}
}
if($self->{generate_last_modified}) {
$self->{cobject} = $self->{cache}->get_object($key);
if(defined($self->{cobject})) {
push @{$self->{o}}, "Last-Modified: " . HTTP::Date::time2str($self->{cobject}->created_at());
} else {
push @{$self->{o}}, "Last-Modified: " . HTTP::Date::time2str(time);
}
}
}
if($self->{info}) {
my $host_name = $self->{info}->host_name();
if(defined($self->{x_cache})) {
push @{$self->{o}}, 'X-Cache: ' . $self->{x_cache} . " from $host_name";
} else {
push @{$self->{o}}, "X-Cache: MISS from $host_name";
}
push @{$self->{o}}, "X-Cache-Lookup: MISS from $host_name";
} else {
if(defined($self->{x_cache})) {
push @{$self->{o}}, 'X-Cache: ' . $self->{x_cache};
} else {
push @{$self->{o}}, 'X-Cache: MISS';
}
push @{$self->{o}}, 'X-Cache-Lookup: MISS';
}
push @{$self->{o}}, "X-FCGI-Buffer-$VERSION: Miss";
}
# We don't need it any more, so give Perl a chance to
# tidy it up seeing as we're in the destructor
delete $self->{cache};
} elsif($self->{info}) {
my $host_name = $self->{info}->host_name();
push @{$self->{o}}, ("X-Cache: MISS from $host_name", "X-Cache-Lookup: MISS from $host_name");
if($self->_save_to($unzipped_body, $dbh) && $encoding) {
$self->_compress({ encoding => $encoding });
}
} else {
push @{$self->{o}}, ('X-Cache: MISS', 'X-Cache-Lookup: MISS');
}
if($self->{generate_etag} && ((!defined($headers)) || ($headers !~ /^ETag: /m))) {
if(defined($self->{etag})) {
push @{$self->{o}}, "ETag: $self->{etag}";
if($self->{logger}) {
$self->{logger}->debug("Set ETag to $self->{etag}");
}
} elsif($self->{logger} && (($self->{status} == 200) || $self->{status} == 304) && $self->{body} && !$self->is_cached()) {
# open(my $fout, '>>', '/tmp/FCGI-bug');
# print $fout "BUG: ETag not generated, status $self->{status}:\n",
# $headers,
# 'x' x 40,
# defined($self->{body}) ? $self->{body} : "body is empty\n",
# 'x' x 40,
# "\n";
$self->{logger}->warn("BUG: ETag not generated, status $self->{status}");
}
}
my $body_length;
if(defined($self->{body})) {
if(utf8::is_utf8($self->{body})) {
utf8::encode($self->{body});
}
$body_length = length($self->{body});
} else {
$body_length = 0;
}
if(defined($headers) && length($headers)) {
# Put the original headers first, then those generated within
# FCGI::Buffer
unshift @{$self->{o}}, split(/\r\n/, $headers);
if($self->{body} && $self->{send_body}) {
unless(grep(/^Content-Length: \d/, @{$self->{o}})) {
push @{$self->{o}}, "Content-Length: $body_length";
}
}
unless(grep(/^Status: \d/, @{$self->{o}})) {
require HTTP::Status;
HTTP::Status->import();
push @{$self->{o}}, 'Status: ' . $self->{status} . ' ' . HTTP::Status::status_message($self->{status});
}
} else {
push @{$self->{o}}, "X-FCGI-Buffer-$VERSION: No headers";
}
if($body_length && $self->{send_body}) {
push @{$self->{o}}, ('', $self->{body});
}
# XXXXXXXXXXXXXXXXXXXXXXX
if(0) {
# This code helps to debug Wide character prints
my $wideCharWarningsIssued = 0;
my $widemess;
$SIG{__WARN__} = sub {
$wideCharWarningsIssued += "@_" =~ /Wide character in .../;
$widemess = "@_";
if($self->{logger}) {
$self->{logger}->fatal($widemess);
my $i = 1;
$self->{logger}->trace('Stack Trace');
while((my @call_details = (caller($i++)))) {
$self->{logger}->trace($call_details[1], ':', $call_details[2], ' in function ', $call_details[3]);
}
}
CORE::warn(@_); # call the builtin warn as usual
};
if(scalar @{$self->{o}}) {
print join("\r\n", @{$self->{o}});
if($wideCharWarningsIssued) {
my $mess = join("\r\n", @{$self->{o}});
$mess =~ /[^\x00-\xFF]/;
open(my $fout, '>>', '/tmp/NJH');
print $fout "$widemess:\n",
$mess,
'x' x 40,
"\n";
close $fout;
}
}
} elsif(scalar @{$self->{o}}) {
print join("\r\n", @{$self->{o}});
}
# XXXXXXXXXXXXXXXXXXXXXXX
if((!$self->{send_body}) || !defined($self->{body})) {
print "\r\n\r\n";
}
}
sub _check_modified_since {
my $self = shift;
if($self->{logger}) {
$self->{logger}->trace('In _check_modified_since');
}
if(!$self->{generate_304}) {
return;
}
my $params = shift;
if(!defined($$params{since})) {
return;
}
my $s = HTTP::Date::str2time($$params{since});
if(!defined($s)) {
if($self->{logger}) {
$self->{logger}->info("$$params{since} is not a valid date");
}
return;
}
my $age = $self->_my_age();
if(!defined($age)) {
if($self->{logger}) {
$self->{logger}->info("Can't determine my age");
}
return;
}
if($age > $s) {
if($self->{logger}) {
$self->{logger}->debug('_check_modified_since: script has been modified');
}
# Script has been updated so it may produce different output
return;
}
if($self->{logger}) {
$self->{logger}->debug("_check_modified_since: Compare $$params{modified} with $s");
}
if($$params{modified} <= $s) {
push @{$self->{o}}, "Status: 304 Not Modified";
$self->{status} = 304;
$self->{send_body} = 0;
if($self->{logger}) {
$self->{logger}->debug('Set status to 304');
}
}
}
# Reduce output, e.g. remove superfluous white-space.
sub _optimise_content {
my $self = shift;
# FIXME: regex bad, HTML parser good
# Regexp::List - wow!
$self->{body} =~ s/(((\s+|\r)\n|\n(\s+|\+)))/\n/g;
# $self->{body} =~ s/\r\n/\n/gs;
# $self->{body} =~ s/\s+\n/\n/gs;
# $self->{body} =~ s/\n+/\n/gs;
# $self->{body} =~ s/\n\s+|\s+\n/\n/g;
$self->{body} =~ s/\<\/div\>\s+\<div/\<\/div\>\<div/gis;
# $self->{body} =~ s/\<\/p\>\s\<\/div/\<\/p\>\<\/div/gis;
# $self->{body} =~ s/\<div\>\s+/\<div\>/gis; # Remove spaces after <div>
$self->{body} =~ s/(<div>\s+|\s+<div>)/<div>/gis;
$self->{body} =~ s/\s+<\/div\>/\<\/div\>/gis; # Remove spaces before </div>
$self->{body} =~ s/\s+\<p\>|\<p\>\s+/\<p\>/im; # TODO <p class=
$self->{body} =~ s/\s+\<\/p\>|\<\/p\>\s+/\<\/p\>/gis;
$self->{body} =~ s/<html>\s+<head>/<html><head>/is;
$self->{body} =~ s/\s*<\/head>\s+<body>\s*/<\/head><body>/is;
$self->{body} =~ s/<html>\s+<body>/<html><body>/is;
$self->{body} =~ s/<body>\s+/<body>/is;
$self->{body} =~ s/\s+\<\/html/\<\/html/is;
$self->{body} =~ s/\s+\<\/body/\<\/body/is;
$self->{body} =~ s/\s(\<.+?\>\s\<.+?\>)/$1/;
# $self->{body} =~ s/(\<.+?\>\s\<.+?\>)\s/$1/g;
$self->{body} =~ s/\<p\>\s/\<p\>/gi;
$self->{body} =~ s/\<\/p\>\s\<p\>/\<\/p\>\<p\>/gi;
$self->{body} =~ s/\<\/tr\>\s\<tr\>/\<\/tr\>\<tr\>/gi;
$self->{body} =~ s/\<\/td\>\s\<\/tr\>/\<\/td\>\<\/tr\>/gi;
$self->{body} =~ s/\<\/td\>\s*\<td\>/\<\/td\>\<td\>/gis;
$self->{body} =~ s/\<\/tr\>\s\<\/table\>/\<\/tr\>\<\/table\>/gi;
$self->{body} =~ s/\<br\s?\/?\>\s?\<p\>/\<p\>/gi;
$self->{body} =~ s/\<br\>\s+/\<br\>/gi;
$self->{body} =~ s/\s+\<br/\<br/gi;
$self->{body} =~ s/\<br\s?\/\>\s/\<br \/\>/gi;
$self->{body} =~ s/[ \t]+/ /gs; # Remove duplicate space, don't use \s+ it breaks JavaScript
$self->{body} =~ s/\s\<p\>/\<p\>/gi;
$self->{body} =~ s/\s\<script/\<script/gi;
$self->{body} =~ s/(<script>\s|\s<script>)/<script>/gis;
$self->{body} =~ s/(<\/script>\s|\s<\/script>)/<\/script>/gis;
$self->{body} =~ s/\<td\>\s/\<td\>/gi;
$self->{body} =~ s/\s+\<a\shref="(.+?)"\>\s?/ <a href="$1">/gis;
$self->{body} =~ s/\s?<a\shref=\s"(.+?)"\>/ <a href="$1">/gis;
$self->{body} =~ s/\s+<\/a\>\s+/<\/a> /gis;
$self->{body} =~ s/(\s?<hr>\s+|\s+<hr>\s?)/<hr>/gis;
# $self->{body} =~ s/\s<hr>/<hr>/gis;
# $self->{body} =~ s/<hr>\s/<hr>/gis;
$self->{body} =~ s/<\/li>\s+<li>/<\/li><li>/gis;
$self->{body} =~ s/<\/li>\s+<\/ul>/<\/li><\/ul>/gis;
$self->{body} =~ s/<ul>\s+<li>/<ul><li>/gis;
$self->{body} =~ s/\s+<\/li>/<\/li>/gis;
$self->{body} =~ s/\<\/option\>\s+\<option/\<\/option\>\<option/gis;
$self->{body} =~ s/<title>\s*(.+?)\s*<\/title>/<title>$1<\/title>/is;
$self->{body} =~ s/<\/center>\s+<center>/ /gis;
}
# Create a key for the cache
sub _generate_key {
my $self = shift;
if($self->{cache_key}) {
return $self->{cache_key};
}
unless(defined($self->{info})) {
$self->{info} = CGI::Info->new({ cache => $self->{cache} });
}
my $key = $self->{info}->browser_type() . '::' . $self->{info}->domain_name() . '::' . $self->{info}->script_name() . '::' . $self->{info}->as_string();
if($self->{lingua}) {
$key .= '::' . $self->{lingua}->language();
}
if($ENV{'HTTP_COOKIE'}) {
# Different states of the client are stored in different caches
# Don't put different Google Analytics in different caches, and anyway they
# would be wrong
foreach my $cookie(split(/;/, $ENV{'HTTP_COOKIE'})) {
unless($cookie =~ /^__utm[abcz]/) {
$key .= "::$cookie";
}
}
}
# Honour the Vary headers
my $headers = $self->{'headers'};
if($headers && ($headers =~ /^Vary: .*$/m)) {
if(defined($self->{logger})) {
$self->{logger}->debug('Found Vary header');
}
foreach my $h1(split(/\r?\n/, $headers)) {
my ($h1_name, $h1_value) = split /\:\s*/, $h1, 2;
if(lc($h1_name) eq 'vary') {
foreach my $h2(split(/\r?\n/, $headers)) {
my ($h2_name, $h2_value) = split /\:\s*/, $h2, 2;
if($h2_name eq $h1_value) {
$key .= "::$h2_value";
last;
}
}
}
}
}
$key =~ s/\//::/g;
$key =~ s/::::/::/g;
$key =~ s/::$//;
if(defined($self->{logger})) {
$self->{logger}->trace("Returning $key");
}
$self->{cache_key} = $key;
return $key;
}
=head2 init
Set various options and override default values.
# Put this toward the top of your program before you do anything
# By default, generate_tag, generate_304 and compress_content are ON,
# optimise_content and lint_content are OFF. Set optimise_content to 2 to
# do aggressive JavaScript optimisations which may fail.
use FCGI::Buffer;
my $buffer = FCGI::Buffer->new()->init({
generate_etag => 1, # make good use of client's cache
generate_last_modified => 1, # more use of client's cache
compress_content => 1, # if gzip the output
optimise_content => 0, # optimise your program's HTML, CSS and JavaScript
cache => CHI->new(driver => 'File'), # cache requests
cache_key => 'string', # key for the cache
cache_age => '10 minutes', # how long to store responses in the cache
logger => $self->{logger},
lint_content => 0, # Pass through HTML::Lint
generate_304 => 1, # When appropriate, generate 304: Not modified
save_to => { directory => '/var/www/htdocs/save_to', ttl => 600, create_table => 1 },
info => CGI::Info->new(),
lingua => CGI::Lingua->new(),
});
If no cache_key is given, one will be generated which may not be unique.
The cache_key should be a unique value dependent upon the values set by the
browser.
The cache object will be an object that understands get_object(),
set(), remove() and created_at() messages, such as an L<CHI> object. It is
used as a server-side cache to reduce the need to rerun database accesses.
Items stay in the server-side cache by default for 10 minutes.
This can be overridden by the cache_control HTTP header in the request, and
the default can be changed by the cache_age argument to init().
Save_to is feature which stores output of dynamic pages to your
htdocs tree and replaces future links that point to that page with static links
to avoid going through CGI at all.
Ttl is set to the number of seconds that the static pages are deemed to
be live for, the default is 10 minutes.
If set to 0, the page is live forever.
To enable save_to, a info and lingua arguments must also be given.
It works best when cache is also given.
Only use where output is guaranteed to be the same with a given set of arguments
(the same criteria for enabling generate_304).
You can turn it off on a case by case basis thus:
my $params = CGI::Info->new()->params();
if($params->{'send_private_email'}) {
$buffer->init('save_to' => undef);
}
Info is an optional argument to give information about the FCGI environment, e.g.