-
Notifications
You must be signed in to change notification settings - Fork 42
/
WebGUI.pm
238 lines (179 loc) · 7.57 KB
/
WebGUI.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
package WebGUI;
our $VERSION = '8.0.1';
our $STATUS = 'beta';
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2012 Plain Black Corporation.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict;
use Moose;
use MooseX::NonMoose;
use Scalar::Util qw/blessed/;
use WebGUI::Config;
use WebGUI::Pluggable;
use WebGUI::Paths;
use WebGUI::Types;
use WebGUI::Exception;
extends 'Plack::Component';
=head1 NAME
Package WebGUI
=head1 DESCRIPTION
PSGI handler for WebGUI.
=head1 SYNOPSIS
use WebGUI;
=head1 SUBROUTINES
These subroutines are available from this package:
=cut
has config => (
is => 'ro',
required => 1,
isa => 'WebGUI::Type::Config',
coerce => 1,
);
=head2 call( $env )
Every web requests results in a call to this subroutine.
=head3 $env
=cut
sub call {
my $self = shift;
my $env = shift;
##Enable size limiting
$env->{'psgix.harakiri'} = 1;
my $session = $env->{'webgui.session'}
or die 'Missing WebGUI Session - check WebGUI::Middleware::Session';
# Handle the request
$self->handle($session);
my $response = $session->response;
my $psgi_response = $response->finalize;
if ( ! $response->streaming ) {
# Not streaming, so immediately tell the callback to return
# the response. In the future we could use an Event framework here
# to make this a non-blocking delayed response.
return $psgi_response;
}
else {
# Use the PSGI callback style response, which allows for nice things like
# delayed response/streaming body (server push).
# Delayed response prevents any nice MiddleWare::StackTrace-like modules from
# engaging so minimal error handling is done here.
return sub {
my $responder = shift;
# Construct the PSGI response
eval {
# Ask PSGI server for a streaming writer object by returning only the first
# two elements of the array reference
my $writer = $responder->( [ $psgi_response->[0], $psgi_response->[1] ] );
# Store the writer object in the WebGUI::Session::Response object
$response->writer($writer);
# Now call the callback that does the streaming
$response->streamer->($session);
# And finally, clean up
$writer->close;
# Close the session, because the WebGUI::Middleware::Session didn't
$session->close;
delete $env->{'webgui.session'};
};
if ( my $e = WebGUI::Error->caught ) {
if ($response->writer) {
# Response has already been started, so log error and close writer
$session->request->TRACE(
"Error detected after streaming response started: " . $e->message . "\n" . $e->trace->as_string
);
$response->writer->close;
}
else {
$responder->( [ 500, [ 'Content-Type' => 'text/plain' ], [ "Internal Server Error" ] ] );
}
}
}
}
}
=head2 handle ($session)
Process the list of content handlers from the config file and then evaluate any Template objects which
may have been returned.
=head3 $session
A WebGUI::Session object.
=cut
sub handle {
my ( $self, $session ) = @_;
# uncomment the following to short-circuit contentHandlers (for benchmarking PSGI scaffolding vs. modperl)
# $session->output->print("WebGUI PSGI with contentHandlers short-circuited for benchmarking\n");
# return;
# contentHandlers that return text will have that content returned as the response
# Alternatively, contentHandlers can stream the response body by calling:
# $session->response->stream_write()
# inside of a callback registered via:
# $session->response->stream( sub { } )
# This is generally a good thing to do, unless you want to send a file.
# uncomment the following to short-circuit contentHandlers with a streaming response:
# $session->response->stream(
# sub {
# my $session = shift;
# $session->output->print("WebGUI PSGI with contentHandlers short-circuited for benchmarking (streaming)\n");
# #sleep 1;
# $session->output->print("...see?\n");
# }
# );
# return;
local $SIG{__DIE__} = sub { WebGUI::Error::RunTime->throw( message => $_[0] ); };
# Look for the template preview HTTP headers
WebGUI::Asset::Template->processVariableHeaders($session);
# TODO: refactor the following loop, find all instances of "chunked" and "empty" in codebase, etc..
for my $handler (@{$session->config->get("contentHandlers")}) {
my $output = eval { WebGUI::Pluggable::run($handler, "handler", [ $session ] )};
if ( $@ ) {
# re-throwing errors back out to plack is useless; to get the exception through to any middleware that
# want to report on it, we have to stash it in $env
# as long as our $SIG{__DIE__} is in effect, errors should always be objects
my $e = WebGUI::Error->caught;
$session->request->env->{'webgui.error'} = $e if $session->request->env->{'webgui.debug'};
$session->log->error($e->package.":".$e->line." - ".$e->full_message, $@);
$session->log->debug($e->package.":".$e->line." - ".$e->trace, $@);
}
else {
# Not an error
# Stop if the contentHandler is going to stream the response body
return if $session->response->streaming;
# We decide what to do next depending on what the contentHandler returned
# A WebGUI::Asset::Template object means we should process it
if ( defined $output && blessed $output && $output->isa( 'WebGUI::Asset::Template' ) ) {
$session->response->sendHeader;
$session->output->print( $output->process );
last;
}
# "chunked" or "empty" means it took care of its own output needs
elsif (defined $output && ( $output eq "chunked" || $output eq "empty" )) {
#warn "chunked and empty no longer stream, use session->response->stream() instead";
last;
}
# other non-empty output should be used as the response body
elsif (defined $output && $output ne "") {
# Auto-set the headers
$session->response->sendHeader;
# Use contentHandler's return value as the output
$session->output->print($output);
last;
}
# Keep processing for success codes
elsif ($session->response->status < 200 || $session->response->status > 299) {
$session->response->sendHeader;
last;
}
}
}
# Print out the template preview variables
$session->output->print(
WebGUI::Asset::Template->getVariableJson($session), 1
);
return;
}
no Moose;
__PACKAGE__->meta->make_immutable;
1;