Mercurial > pub > Impl
annotate Lib/IMPL/Web/Application.pm @ 97:964587c5183c
Added SecureCall to Web QueryHandlers stack
many bug fixes to Security and Web Application modules
| author | wizard |
|---|---|
| date | Tue, 04 May 2010 04:04:37 +0400 |
| parents | 2f31ecabe9ea |
| children | 6dd659f6f66c |
| rev | line source |
|---|---|
| 49 | 1 package IMPL::Web::Application; |
| 2 use strict; | |
| 3 use warnings; | |
| 4 | |
|
60
b0c068da93ac
Lazy activation for the configuration objects (final concept)
wizard
parents:
59
diff
changeset
|
5 use base qw(IMPL::Config IMPL::Object::Singleton); |
| 58 | 6 |
| 7 require IMPL::Web::Application::Action; | |
| 8 require IMPL::Web::Application::Response; | |
| 9 | |
| 49 | 10 use IMPL::Class::Property; |
| 57 | 11 use CGI; |
| 49 | 12 |
|
60
b0c068da93ac
Lazy activation for the configuration objects (final concept)
wizard
parents:
59
diff
changeset
|
13 __PACKAGE__->PassThroughArgs; |
|
b0c068da93ac
Lazy activation for the configuration objects (final concept)
wizard
parents:
59
diff
changeset
|
14 |
| 49 | 15 BEGIN { |
| 52 | 16 public property handlerError => prop_all; |
| 67 | 17 public property actionFactory => prop_all; |
|
59
0f3e369553bd
Rewritten property implementation (probably become slower but more flexible)
wizard
parents:
58
diff
changeset
|
18 public property handlersQuery => prop_all | prop_list; |
| 65 | 19 public property responseCharset => prop_all; |
| 73 | 20 public property security => prop_all; |
|
63
76b878ad6596
Added serialization support for the IMPL::Object::List
wizard
parents:
62
diff
changeset
|
21 public property options => prop_all; |
| 97 | 22 public property fetchRequestMethod => prop_all; |
| 49 | 23 } |
| 24 | |
| 62 | 25 sub CTOR { |
| 26 my ($this) = @_; | |
| 27 | |
| 67 | 28 $this->actionFactory('IMPL::Web::Application::Action') unless $this->actionFactory; |
| 65 | 29 $this->responseCharset('utf-8') unless $this->responseCharset; |
| 97 | 30 $this->fetchRequestMethod(\&defaultFetchRequest) unless $this->fetchRequestMethod; |
| 31 $this->handlerError(\&defaultHandlerError) unless $this->handlerError; | |
| 62 | 32 } |
| 33 | |
| 49 | 34 sub Run { |
| 35 my ($this) = @_; | |
| 36 | |
| 58 | 37 while (my $query = $this->FetchRequest()) { |
| 38 | |
| 67 | 39 my $action = $this->actionFactory->new( |
| 62 | 40 query => $query, |
| 58 | 41 application => $this, |
| 65 | 42 ); |
| 43 | |
| 97 | 44 eval { |
| 45 $action->response->charset($this->responseCharset); | |
| 46 | |
| 47 $action->ChainHandler($_) foreach $this->handlersQuery; | |
| 48 | |
| 49 $action->Invoke(); | |
| 50 | |
| 51 $action->response->Complete; | |
| 52 }; | |
| 53 if ($@) { | |
| 54 my $e = $@; | |
| 55 eval { $this->handlerError()->($this,$action,$e); 1;} or warn "Error in handlerError: ",$@; | |
| 56 } | |
| 49 | 57 } |
| 58 } | |
| 59 | |
| 97 | 60 sub FetchRequest { |
| 61 my ($this) = @_; | |
| 62 | |
| 63 if( ref $this->fetchRequestMethod eq 'CODE' ) { | |
| 64 return $this->fetchRequestMethod->($this); | |
| 65 } else { | |
| 66 die new IMPL::Exception("Unknown fetchRequestMethod type",ref $this->fetchRequestMethod); | |
| 67 } | |
| 68 } | |
| 69 | |
| 57 | 70 { |
| 71 my $hasFetched = 0; | |
| 72 | |
| 97 | 73 sub defaultFetchRequest { |
| 57 | 74 return undef if $hasFetched; |
| 75 $hasFetched = 1; | |
| 76 return CGI->new(); | |
| 77 } | |
| 78 } | |
| 79 | |
| 97 | 80 sub defaultHandlerError { |
| 81 my ($this,$action,$e) = @_; | |
| 82 warn $e; | |
| 83 if ( eval { $action->ReinitResponse(); 1; } ) { | |
| 84 $action->response->contentType('text/plain'); | |
| 85 $action->response->charset($this->responseCharset); | |
| 86 $action->response->status(500); | |
| 87 my $hout = $action->response->streamBody; | |
| 88 print $hout $e; | |
| 89 $action->response->Complete(); | |
| 90 } | |
| 91 } | |
| 92 | |
| 49 | 93 1; |
| 94 | |
| 52 | 95 __END__ |
| 96 | |
| 49 | 97 =pod |
| 98 | |
| 99 =head1 SYNOPSIS | |
| 100 | |
| 67 | 101 =begin code |
| 102 | |
| 49 | 103 require MyApp; |
| 67 | 104 |
| 105 my $instance = spawn MyApp('app.config'); | |
| 106 | |
| 107 $instance->Run(); | |
| 108 | |
| 109 =end code | |
| 49 | 110 |
| 111 =head1 DESCRIPTION | |
| 112 | |
| 73 | 113 C< use base qw( IMPL::Config IMPL::Object::Singleton )> |
| 114 | |
| 49 | 115 Зкземпляр приложения содержит в себе глобальные настройки, реализует контроллер запросов, |
| 52 | 116 в качестве источника запросов используется CGI или иной совместимый модуль. |
| 49 | 117 |
| 52 | 118 Процесс обработки запроса состоит из следующих частей |
| 49 | 119 |
| 67 | 120 =over |
| 121 | |
| 122 =item 1 | |
| 123 | |
| 124 Получение cgi запроса | |
| 125 | |
| 126 =item 2 | |
| 52 | 127 |
| 67 | 128 Создание объекта C<IMPL::Web::Application::Action> |
| 52 | 129 |
| 67 | 130 =item 3 |
| 52 | 131 |
| 67 | 132 Формирование цепочки вызовов при помощи C<< IMPL::Web::Application::Action->ChainHandler >> |
| 133 | |
| 134 =item 4 | |
| 135 | |
| 136 Выполнение запроса C<< IMPL::Web::Application::Action->Invoke >> | |
| 49 | 137 |
| 138 =cut | |
| 67 | 139 |
| 140 Также приложение поддерживает отложенное создание объектов, которые по первому обращению | |
| 141 к свойствам. Это реализовано в базовом классе C< IMPL::Configuration >. Для настройки | |
| 142 активаторов можно использовать свойство C<options>, в которое должен быть помещен хеш | |
| 143 со ссылками на активаторы, см. пример ниже C<CONFIGURATION>. | |
| 144 | |
| 145 =head2 CONFIGURATION | |
| 146 | |
| 147 Ниже приведен пример конфигурации приложения | |
| 148 | |
| 149 =begin code xml | |
| 150 | |
| 151 <?xml version="1.0" encoding="UTF-8"?> | |
| 152 <Application id='app' type="Test::Web::Application::Instance"> | |
| 153 | |
| 154 <!-- Begin custom properties --> | |
| 155 <name>Sample application</name> | |
| 156 <dataSource type='IMPL::Config::Activator' id='ds'> | |
| 157 <factory>IMPL::Object</factory> | |
| 158 <parameters type='HASH'> | |
| 159 <db>data</db> | |
| 160 <user>nobody</user> | |
| 161 </parameters> | |
| 162 </dataSource> | |
| 163 <securityMod type='IMPL::Config::Activator'> | |
| 164 <factory>IMPL::Object</factory> | |
| 165 <parameters type='HASH'> | |
| 166 <ds refid='ds'/> | |
| 167 </parameters> | |
| 168 </securityMod> | |
| 169 <!-- End custom properties --> | |
| 170 | |
| 171 <!-- direct access to the activators --> | |
| 172 <options type="HASH"> | |
| 173 <dataSource refid='ds'/> | |
| 174 </options> | |
| 175 | |
| 176 <!-- Set default output encoding, can be changed due query handling --> | |
| 177 <responseCharset>utf-8</responseCharset> | |
| 178 | |
| 179 <!-- Actions creation configuration --> | |
| 180 <actionFactory type="IMPL::Object::Factory"> | |
| 181 | |
| 182 <!-- Construct actions --> | |
| 183 <factory>IMPL::Web::Application::Action</factory> | |
| 184 <parameters type='HASH'> | |
| 185 | |
| 186 <!-- with special responseFactory --> | |
| 187 <responseFactory type='IMPL::Object::Factory'> | |
| 188 | |
| 189 <!-- Where resopnses have a special streamOut --> | |
| 190 <factory>IMPL::Web::Application::Response</factory> | |
| 191 <parameters type='HASH'> | |
| 192 | |
| 193 <!-- in memory dummy output instead of STDOUT --> | |
| 194 <streamOut>memory</streamOut> | |
| 195 | |
| 196 </parameters> | |
| 197 </responseFactory> | |
| 198 </parameters> | |
| 199 </actionFactory> | |
| 200 | |
| 201 <!-- Query processing chain --> | |
| 202 <handlersQuery type="IMPL::Object::List"> | |
| 203 <item type="IMPL::Web::QueryHandler::PageFormat"> | |
| 204 <templatesCharset>cp1251</templatesCharset> | |
| 205 </item> | |
| 206 </handlersQuery> | |
| 207 </Application> | |
| 208 | |
| 209 =end code xml | |
| 210 | |
| 73 | 211 =head1 MEMBERS |
| 212 | |
| 213 =over | |
| 214 | |
| 215 =item C<[get,set] handlerError> | |
| 216 | |
| 217 Обработчик который будет вызван в случае возникновения необработанной ошибки | |
| 218 в процессе работы приложения. После чего приложение корректно завершается. | |
| 219 | |
| 220 =item C<[get,set] actionFactory> | |
| 221 | |
| 222 Фабрика объектов, которая используется приложением, для создания объектов | |
| 223 типа C<IMPL::Web::Application::Action> при обработки C<CGI> запросов. | |
| 224 | |
| 225 =begin code | |
| 226 | |
| 227 my $action = $this->actionFactory->new( | |
| 228 query => $query, | |
| 229 application => $this, | |
| 230 ); | |
| 231 | |
| 232 =end code | |
| 233 | |
| 97 | 234 =item C< [get,set] fetchRequestMethod > |
| 235 | |
| 236 Метод получения CGI запроса. Возвращает C<CGI> объект следующего запроса, если | |
| 237 запросов больше нет, то возвращает C<undef>. По-умолчанию использует C<defaultFetchRequest>. | |
| 238 | |
| 239 Может быть как ссылкой на функцию, так и объектом типа C<IMPL::Web::Application::RequestFetcher>. | |
| 240 | |
| 73 | 241 =item C< [get,set,list] handlersQuery > |
| 242 | |
| 243 Список обработчиков запросов, которые будут переданы созданному объекту-действию. | |
| 244 | |
| 245 =item C< [get,set] responseCharset> | |
| 246 | |
| 247 Кодировка ответа клиенту. | |
| 248 | |
| 249 =item C< [get,set] security > | |
| 250 | |
| 251 Объект C<IMPL::Web::Security>, для работы с инфраструктурой безопасности. | |
| 252 | |
| 253 =item C< [get,set] options > | |
| 254 | |
| 255 Обычно ссылка на хеш с настраиваемыми объектами, используется для возможности | |
| 256 програмной настройки активаторов, т.к. напрямую через свойства приложения получить | |
| 257 к ним доступ не получится. | |
| 258 | |
| 259 =back | |
| 260 | |
| 261 =cut |