Mercurial > pub > Impl

comparison Lib/IMPL/Web/HttpResponse.pm @ 229:47f77e6409f7

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