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
|
# TUWF.pm - the core module for TUWF
# The Ultimate Website Framework
package TUWF;
use strict;
use warnings;
use Carp 'croak';
our $VERSION = '1.0';
# Store the object in a global variable for some functions that don't get it
# passed as an argument. This will break when:
# - using a threaded environment (threading sucks anyway)
# - handling multiple requests asynchronously (which this framework can't do)
# - handling multiple sites in the same perl process. This may be useful in
# a mod_perl environment, which we don't support.
our $OBJ = bless {
_TUWF => {
# defaults
mail_from => '<noreply-yawf@blicky.net>',
mail_sendmail => '/usr/sbin/sendmail',
max_post_body => 10*1024*1024, # 10MB
error_400_handler => \&_error_400,
error_404_handler => \&_error_404,
error_405_handler => \&_error_405,
error_413_handler => \&_error_413,
error_500_handler => \&_error_500,
log_format => sub {
my($self, $uri, $msg) = @_;
sprintf "[%s] %s -> %s\n", scalar localtime(), $uri, $msg;
},
validate_templates => {},
}
}, 'TUWF::Object';
my @handlers;
sub import {
my $self = shift;
my $pack = caller();
# import requested functions from TUWF submodules
croak $@ if @_ && !eval "package $pack; import TUWF::func \@_; 1";
}
# get or set TUWF configuration variables
sub set {
return $OBJ->{_TUWF}{$_[0]} if @_ == 1;
$OBJ->{_TUWF} = { %{$OBJ->{_TUWF}}, @_ };
}
sub run {
# load the database module if requested
$OBJ->_load_module('TUWF::DB') if $OBJ->{_TUWF}{db_login};
# install a warning handler to write to the log file
$SIG{__WARN__} = sub { $TUWF::OBJ->log($_) for @_; };
# load optional modules
require Time::HiRes if $OBJ->debug || $OBJ->{_TUWF}{log_slow_pages};
# initialize DB connection
$OBJ->dbInit if $OBJ->{_TUWF}{db_login};
# plain old CGI
if($ENV{GATEWAY_INTERFACE} && $ENV{GATEWAY_INTERFACE} =~ /CGI/i) {
$OBJ->_handle_request;
}
# otherwise, assume a FastCGI environment
else {
require FCGI;
import FCGI;
my $r = FCGI::Request();
while($r->Accept() >= 0) {
$OBJ->_handle_request;
$r->Finish();
}
}
# close the DB connection
$OBJ->dbDisconnect if $OBJ->{_TUWF}{db_login};
}
# Maps URLs to handlers
sub register {
push @handlers, @_;
}
# Load modules
sub load {
$OBJ->_load_module($_) for (@_);
}
# Load modules, recursively
# All submodules should be under the same directory in @INC
sub load_recursive {
my $rec;
$rec = sub {
my($d, $f, $m) = @_;
for my $s (glob "$d/$f/*") {
$OBJ->_load_module("${m}::$1") if -f $s && $s =~ /([^\/]+)\.pm$/;
$rec->($d, "$f/$1", "${m}::$1") if -d $s && $s =~ /([^\/]+)$/;
}
};
for my $m (@_) {
(my $f = $m) =~ s/::/\//g;
my $d = (grep +(-d "$_/$f" or -s "$_/$f.pm"), @INC)[0];
croak "No module or submodules of '$m' found" if !$d;
$OBJ->_load_module($m) if -s "$d/$f.pm";
$rec->($d, $f, $m) if -d "$d/$f";
}
}
# the default error handlers are quite ugly and generic...
sub _error_400 { _very_simple_page($_[0], 400, '400 - Bad Request', 'Only UTF-8 encoded data is accepted.') }
sub _error_404 { _very_simple_page($_[0], 404, '404 - Page Not Found', 'The page you were looking for does not exist...') }
sub _error_405 { _very_simple_page($_[0], 405, '405 - Method not allowed', 'The only allowed methods are: HEAD, GET or POST.') }
sub _error_413 { _very_simple_page($_[0], 413, '413 - Request Entity Too Large', 'You were probably trying to upload a too large file.') }
sub _error_500 { _very_simple_page($_[0], 500, '500 - Internal Server Error', 'Oops! Looks like something went wrong on our side.') }
# a simple and ugly page for error messages
sub _very_simple_page {
my($s, $code, $title, $msg) = @_;
$s->resInit;
$s->resStatus($code);
$s->resHeader(Allow => 'GET, HEAD, POST') if $code == 405;
my $fd = $s->resFd;
print $fd <<__;
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>$title</title>
</head>
<body>
<h1>$title</h1>
<p>$msg</p>
</body>
</html>
__
}
# A 'redirection' namespace for all functions exported by TUWF submodules.
# This trick avoids having to write our own sophisticated import() function
package TUWF::func;
use Exporter 'import';
# don't 'use' the submodules, since they may export TUWF object methods by
# default. We're only interested in their non-method functions, which are all
# in @EXPORT_OK.
BEGIN {
require TUWF::DB;
require TUWF::Misc;
require TUWF::XML;
import TUWF::DB @TUWF::DB::EXPORT_OK;
import TUWF::Misc @TUWF::Misc::EXPORT_OK;
import TUWF::XML @TUWF::XML::EXPORT_OK;
}
our @EXPORT_OK = (
@TUWF::DB::EXPORT_OK,
@TUWF::Misc::EXPORT_OK,
@TUWF::XML::EXPORT_OK
);
our %EXPORT_TAGS = %TUWF::XML::EXPORT_TAGS;
# The namespace which inherits all functions to be available in the global
# object.
package TUWF::Object;
use TUWF::Response;
use TUWF::Request;
use TUWF::Misc;
require Carp; # but don't import()
our @CARP_NOT = ('TUWF');
sub _load_module {
my($self, $module) = @_;
Carp::croak $@ if !eval "use $module; 1";
}
# Handles a request (sounds pretty obvious to me...)
sub _handle_request {
my $self = shift;
my $start = [Time::HiRes::gettimeofday()] if $self->debug || $OBJ->{_TUWF}{log_slow_pages};
# put everything in an eval to catch any error, even
# those caused by a TUWF core module
my $eval = eval {
# initialize request
my $err = $self->reqInit();
if($err) {
warn "Client sent non-UTF-8-encoded data. Generating HTTP 400 response.\n" if $err eq 'utf8';
$self->{_TUWF}{error_400_handler}->($self) if $err eq 'utf8';
$self->{_TUWF}{error_405_handler}->($self) if $err eq 'method';
$self->{_TUWF}{error_413_handler}->($self) if $err eq 'maxpost';
return 1;
}
# initialze response
$self->resInit();
# initialize TUWF::XML
TUWF::XML->new(
write => sub { print { $self->resFd } $_ for @_ },
pretty => $self->{_TUWF}{xml_pretty},
default => 1,
);
# make sure our DB connection is still there and start a new transaction
$self->dbCheck() if $self->{_TUWF}{db_login};
# call pre request handler, if any
return 1 if $self->{_TUWF}{pre_request_handler} && !$self->{_TUWF}{pre_request_handler}->($self);
# find the handler
(my $loc = $self->reqPath) =~ s/^\///;
study $loc;
my $han = $self->{_TUWF}{error_404_handler};
my @args;
for (@handlers ? 0..$#handlers/2 : ()) {
if($loc =~ /^$handlers[$_*2]$/) {
@args = map defined $-[$_] ? substr $loc, $-[$_], $+[$_]-$-[$_] : undef, 1..$#- if $#-;
$han = $handlers[$_*2+1];
last;
}
}
# execute handler
$han->($self, @args);
# execute post request handler, if any
$self->{_TUWF}{post_request_handler}->($self) if $self->{_TUWF}{post_request_handler};
# commit changes
$self->dbCommit if $self->{_TUWF}{db_login};
1;
};
# error handling
if(!$eval) {
chomp( my $err = $@ );
# act as if the changes to the DB never happened
warn $@ if $self->{_TUWF}{db_login} && !eval { $self->dbRollBack; 1 };
# Call the error_500_handler
# The handler should manually call dbCommit if it makes any changes to the DB
my $eval500 = eval {
$self->resInit;
$self->{_TUWF}{error_500_handler}->($self, $err);
1;
};
if(!$eval500) {
chomp( my $m = $@ );
warn "Error handler died as well, something is seriously wrong with your code. ($m)\n";
TUWF::_error_500($self, $err);
}
# write detailed information about this error to the log
$self->log(
"FATAL ERROR!\n".
"HTTP Request Headers:\n".
join('', map sprintf(" %s: %s\n", $_, $self->reqHeader($_)), $self->reqHeader).
"POST dump:\n".
join('', map sprintf(" %s: %s\n", $_, join "\n ", $self->reqPosts($_)), $self->reqPosts).
"Error:\n $err\n"
);
}
# finalize response (flush output, etc)
warn $@ if !eval { $self->resFinish; 1 };
# log debug information in the form of:
# > 12ms (SQL: 8ms, 2 qs) for http://beta.vndb.org/v10
my $time = Time::HiRes::tv_interval($start)*1000 if $self->debug || $self->{_TUWF}{log_slow_pages};
if($self->debug || ($self->{_TUWF}{log_slow_pages} && $self->{_TUWF}{log_slow_pages} < $time)) {
# SQL stats (don't count the ping and commit as queries, but do count their time)
my($sqlt, $sqlc) = (0, 0);
if($self->{_TUWF}{db_login}) {
$sqlc = grep $_->[0] ne 'ping/rollback' && $_->[0] ne 'commit', @{$self->{_TUWF}{DB}{queries}};
$sqlt += $_->[1]*1000 for (@{$self->{_TUWF}{DB}{queries}});
}
$self->log(sprintf('%4dms (SQL:%4dms,%3d qs)', $time, $sqlt, $sqlc));
}
}
# convenience function
sub debug {
return shift->{_TUWF}{debug};
}
# writes a message to the log file. date, time and URL are automatically added
sub log {
my($self, $msg) = @_;
# temporarily disable the warnings-to-log, to avoid infinite recursion if
# this function throws a warning.
my $old = $SIG{__WARN__};
$SIG{__WARN__} = undef;
chomp $msg;
$msg =~ s/\n/\n | /g;
if($self->{_TUWF}{logfile} && open my $F, '>>:utf8', $self->{_TUWF}{logfile}) {
flock $F, 2;
seek $F, 0, 2;
print $F $self->{_TUWF}{log_format}->($self, $self->{_TUWF}{Req} ? $self->reqURI : '[init]', $msg);
flock $F, 4;
close $F;
}
$SIG{__WARN__} = $old;
}
1;
|
