Mercurial > pub > Impl

annotate Lib/IMPL/Web/HttpResponse.pm @ 230:6d8092d8ce1b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
*reworked IMPL::Security *reworked IMPL::Web::Security *refactoring
author sergey
date Mon, 08 Oct 2012 03:37:37 +0400
parents 47f77e6409f7
children 23daf2fae33a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
213
sergey
parents:
diff changeset
1 use strict;
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
2 package IMPL::Web::HttpResponse;
213
sergey
parents:
diff changeset
3
sergey
parents:
diff changeset
4 use CGI();
sergey
parents:
diff changeset
5 use IMPL::lang qw(:declare);
sergey
parents:
diff changeset
6 use IMPL::declare {
sergey
parents:
diff changeset
7 require => {
sergey
parents:
diff changeset
8 Exception => 'IMPL::Exception',
sergey
parents:
diff changeset
9 ArgumentException => '-IMPL::InvalidArgumentException'
sergey
parents:
diff changeset
10 },
sergey
parents:
diff changeset
11 base => [
sergey
parents:
diff changeset
12 'IMPL::Object' => undef,
sergey
parents:
diff changeset
13 'IMPL::Object::Autofill' => '@_'
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
14 ],
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
15 props => [
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
16 status => PROP_ALL,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
17 type => PROP_ALL,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
18 charset => PROP_ALL,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
19 cookies => PROP_ALL,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
20 headers => PROP_ALL,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
21 body => PROP_ALL
213
sergey
parents:
diff changeset
22 ]
sergey
parents:
diff changeset
23 };
sergey
parents:
diff changeset
24
sergey
parents:
diff changeset
25 sub CTOR {
sergey
parents:
diff changeset
26 my ($this) = @_;
sergey
parents:
diff changeset
27
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
28 $this->headers({}) unless $this->headers();
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
29 $this->cookies({}) unless $this->cookies();
213
sergey
parents:
diff changeset
30 }
sergey
parents:
diff changeset
31
sergey
parents:
diff changeset
32 sub PrintResponse {
sergey
parents:
diff changeset
33 my ($this,$out) = @_;
sergey
parents:
diff changeset
34
sergey
parents:
diff changeset
35 my $q = CGI->new({});
sergey
parents:
diff changeset
36
sergey
parents:
diff changeset
37 my %headers = %{$this->headers};
sergey
parents:
diff changeset
38
sergey
parents:
diff changeset
39 if(my $cookies = $this->cookies) {
sergey
parents:
diff changeset
40 $headers{-cookie} = [map _createCookie($_,$cookies->{$_}), keys %$cookies] if $cookies;
sergey
parents:
diff changeset
41 }
sergey
parents:
diff changeset
42
sergey
parents:
diff changeset
43 $headers{'-status'} = $this->status || '200 OK';
sergey
parents:
diff changeset
44 $headers{'-type'} = $this->type || 'text/html';
sergey
parents:
diff changeset
45
sergey
parents:
diff changeset
46 if(my $charset = $this->charset) {
sergey
parents:
diff changeset
47 $q->charset($charset);
sergey
parents:
diff changeset
48 binmode $out, ":encoding($charset)";
sergey
parents:
diff changeset
49 }
sergey
parents:
diff changeset
50
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
51 print $out $q->header(\%headers);
213
sergey
parents:
diff changeset
52
sergey
parents:
diff changeset
53 if(my $body = $this->body) {
sergey
parents:
diff changeset
54 if(ref $body eq 'CODE') {
sergey
parents:
diff changeset
55 $body->($out);
sergey
parents:
diff changeset
56 } else {
sergey
parents:
diff changeset
57 print $out $body;
sergey
parents:
diff changeset
58 }
sergey
parents:
diff changeset
59 }
sergey
parents:
diff changeset
60 }
sergey
parents:
diff changeset
61
sergey
parents:
diff changeset
62 #used to map a pair name valie to a valid cookie object
sergey
parents:
diff changeset
63 sub _createCookie {
sergey
parents:
diff changeset
64 return UNIVERSAL::isa($_[1], 'CGI::Cookie') ? $_[1] : CGI::Cookie->new(-name => $_[0], -value => $_[1] );
sergey
parents:
diff changeset
65 }
sergey
parents:
diff changeset
66
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
67 sub InternalError {
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
68 my ($self,%args) = @_;
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
69
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
70 $args{status} ||= '500 Internal Server Error';
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
71
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
72 return $self->new(%args);
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
73 }
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
74
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
75 sub Redirect {
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
76 my ($self,%args) = @_;
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
77
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
78 return $self->new(
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
79 status => $args{status} || '303 See other',
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
80 headers => {
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
81 location => $args{location}
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
82 }
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
83 );
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
84 }
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
85
213
sergey
parents:
diff changeset
86 1;
sergey
parents:
diff changeset
87
sergey
parents:
diff changeset
88 __END__
sergey
parents:
diff changeset
89
sergey
parents:
diff changeset
90 =pod
sergey
parents:
diff changeset
91
sergey
parents:
diff changeset
92 =head1 NAME
sergey
parents:
diff changeset
93
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
94 C<IMPL::Web::HttpResponse> - Результат обработки C<HTTP> запроса.
213
sergey
parents:
diff changeset
95
sergey
parents:
diff changeset
96 =head1 SYNOPSIS
sergey
parents:
diff changeset
97
sergey
parents:
diff changeset
98 =head1 DESCRIPTION
sergey
parents:
diff changeset
99
sergey
parents:
diff changeset
100 Базовый класс для ответов приложения на C<HTTP> запрос. Каждый вид ответа,
sergey
parents:
diff changeset
101 например
sergey
parents:
diff changeset
102
sergey
parents:
diff changeset
103 Данный объект используется для формирования и передачи данных C<HTTP> ответа
sergey
parents:
diff changeset
104 напрямую. Основными полями являются C<body> и C<status>.
sergey
parents:
diff changeset
105
sergey
parents:
diff changeset
106 Кроме свойств относящихся непосредственно к самому C<HTTP> ответу, данный объект
sergey
parents:
diff changeset
107 может содержать свойства относящиеся к процессу обработки запроса, например
sergey
parents:
diff changeset
108 механизму формирования представления.
sergey
parents:
diff changeset
109
sergey
parents:
diff changeset
110 =head1 MEMBERS
sergey
parents:
diff changeset
111
sergey
parents:
diff changeset
112 =head2 C<[get,set]status>
sergey
parents:
diff changeset
113
sergey
parents:
diff changeset
114 Статус который будет отправлен сервером клиенту, например, C<200 OK> или
sergey
parents:
diff changeset
115 C<204 No response>. Если не указан, то будет C<200 OK>.
sergey
parents:
diff changeset
116
sergey
parents:
diff changeset
117 =head2 C<[get,set]type>
sergey
parents:
diff changeset
118
sergey
parents:
diff changeset
119 Тип содержимого, которое будет передано клиенту, если не указано, будет
sergey
parents:
diff changeset
120 C<text/html>.
sergey
parents:
diff changeset
121
sergey
parents:
diff changeset
122 =head2 C<[get,set]charset>
sergey
parents:
diff changeset
123
sergey
parents:
diff changeset
124 Кодировка в которой будут переданны данные. Следует задавать если и только, если
sergey
parents:
diff changeset
125 передается текстовая информация. Если указана кодировка, то она будет
sergey
parents:
diff changeset
126 автоматически применена к потоку, который будет передан методу C<PrintResponse>.
sergey
parents:
diff changeset
127
sergey
parents:
diff changeset
128 =head2 C<[get,set]cookies>
sergey
parents:
diff changeset
129
sergey
parents:
diff changeset
130 Опционально. Ссылка на хеш с печеньками.
sergey
parents:
diff changeset
131
sergey
parents:
diff changeset
132 =head2 C<[get,set]headers>
sergey
parents:
diff changeset
133
sergey
parents:
diff changeset
134 Опционально. Ссылка на хеш с дополнительными полями заголовка ответа. Формат
sergey
parents:
diff changeset
135 имен полей как у модуля C<CGI>.
sergey
parents:
diff changeset
136
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
137 =begin code
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
138
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
139 $response->header->{custom_header} = "my value";
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
140
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
141 #will produce the following header
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
142
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
143 Custom-header: my value
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
144
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
145 =end code
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 213
diff changeset
146
213
sergey
parents:
diff changeset
147 =head2 C<[get,set]body>
sergey
parents:
diff changeset
148
sergey
parents:
diff changeset
149 Тело ответа. Может быть как простой скаляр, который будет приведен к строке и
sergey
parents:
diff changeset
150 выдан в поток вывода метода C<PrintResponse>. Также может быть ссылкой на
sergey
parents:
diff changeset
151 процедуру, в таком случае будет вызвана эта процедура и ей будет передан
sergey
parents:
diff changeset
152 первым параметром поток для вывода тела ответа.
sergey
parents:
diff changeset
153
sergey
parents:
diff changeset
154 =head2 C<PrintResponse($outStream)>
sergey
parents:
diff changeset
155
sergey
parents:
diff changeset
156 Формирует заголовок и выводит ответ сервера в указанный параметром поток.
sergey
parents:
diff changeset
157
sergey
parents:
diff changeset
158 =cut