Mercurial > pub > Impl
annotate Lib/IMPL/Web/Application.pm @ 128:08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
A complete documentation for a IMPL::Web::Application::ControllerUnit
| author | wizard |
|---|---|
| date | Tue, 15 Jun 2010 02:41:07 +0400 |
| parents | 6dd659f6f66c |
| children | e4f15cbc3f1a |
| 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 ($@) { | |
|
99
6dd659f6f66c
Minor changes, DOM schema is in development (in the aspect of a forms)
wizard
parents:
97
diff
changeset
|
54 my $e = $@; |
|
6dd659f6f66c
Minor changes, DOM schema is in development (in the aspect of a forms)
wizard
parents:
97
diff
changeset
|
55 # we are expect that this method is safe otherwise we can trust nothing in this wolrd |
|
6dd659f6f66c
Minor changes, DOM schema is in development (in the aspect of a forms)
wizard
parents:
97
diff
changeset
|
56 $this->handlerError()->($this,$action,$e); |
| 97 | 57 } |
| 49 | 58 } |
| 59 } | |
| 60 | |
| 97 | 61 sub FetchRequest { |
| 62 my ($this) = @_; | |
| 63 | |
| 64 if( ref $this->fetchRequestMethod eq 'CODE' ) { | |
| 65 return $this->fetchRequestMethod->($this); | |
| 66 } else { | |
| 67 die new IMPL::Exception("Unknown fetchRequestMethod type",ref $this->fetchRequestMethod); | |
| 68 } | |
| 69 } | |
| 70 | |
| 57 | 71 { |
| 72 my $hasFetched = 0; | |
| 73 | |
| 97 | 74 sub defaultFetchRequest { |
| 57 | 75 return undef if $hasFetched; |
| 76 $hasFetched = 1; | |
| 77 return CGI->new(); | |
| 78 } | |
| 79 } | |
| 80 | |
| 97 | 81 sub defaultHandlerError { |
| 82 my ($this,$action,$e) = @_; | |
| 83 warn $e; | |
| 84 if ( eval { $action->ReinitResponse(); 1; } ) { | |
| 85 $action->response->contentType('text/plain'); | |
| 86 $action->response->charset($this->responseCharset); | |
| 87 $action->response->status(500); | |
| 88 my $hout = $action->response->streamBody; | |
| 89 print $hout $e; | |
| 90 $action->response->Complete(); | |
| 91 } | |
| 92 } | |
| 93 | |
| 49 | 94 1; |
| 95 | |
| 52 | 96 __END__ |
| 97 | |
| 49 | 98 =pod |
| 99 | |
| 100 =head1 SYNOPSIS | |
| 101 | |
| 67 | 102 =begin code |
| 103 | |
| 49 | 104 require MyApp; |
| 67 | 105 |
| 106 my $instance = spawn MyApp('app.config'); | |
| 107 | |
| 108 $instance->Run(); | |
| 109 | |
| 110 =end code | |
| 49 | 111 |
| 112 =head1 DESCRIPTION | |
| 113 | |
| 73 | 114 C< use base qw( IMPL::Config IMPL::Object::Singleton )> |
| 115 | |
| 49 | 116 Зкземпляр приложения содержит в себе глобальные настройки, реализует контроллер запросов, |
| 52 | 117 в качестве источника запросов используется CGI или иной совместимый модуль. |
| 49 | 118 |
| 52 | 119 Процесс обработки запроса состоит из следующих частей |
| 49 | 120 |
| 67 | 121 =over |
| 122 | |
| 123 =item 1 | |
| 124 | |
| 125 Получение cgi запроса | |
| 126 | |
| 127 =item 2 | |
| 52 | 128 |
| 67 | 129 Создание объекта C<IMPL::Web::Application::Action> |
| 52 | 130 |
| 67 | 131 =item 3 |
| 52 | 132 |
| 67 | 133 Формирование цепочки вызовов при помощи C<< IMPL::Web::Application::Action->ChainHandler >> |
| 134 | |
| 135 =item 4 | |
| 136 | |
| 137 Выполнение запроса C<< IMPL::Web::Application::Action->Invoke >> | |
| 49 | 138 |
| 139 =cut | |
| 67 | 140 |
| 141 Также приложение поддерживает отложенное создание объектов, которые по первому обращению | |
| 142 к свойствам. Это реализовано в базовом классе C< IMPL::Configuration >. Для настройки | |
| 143 активаторов можно использовать свойство C<options>, в которое должен быть помещен хеш | |
| 144 со ссылками на активаторы, см. пример ниже C<CONFIGURATION>. | |
| 145 | |
| 146 =head2 CONFIGURATION | |
| 147 | |
| 148 Ниже приведен пример конфигурации приложения | |
| 149 | |
| 150 =begin code xml | |
| 151 | |
| 152 <?xml version="1.0" encoding="UTF-8"?> | |
| 153 <Application id='app' type="Test::Web::Application::Instance"> | |
| 154 | |
| 155 <!-- Begin custom properties --> | |
| 156 <name>Sample application</name> | |
| 157 <dataSource type='IMPL::Config::Activator' id='ds'> | |
| 158 <factory>IMPL::Object</factory> | |
| 159 <parameters type='HASH'> | |
| 160 <db>data</db> | |
| 161 <user>nobody</user> | |
| 162 </parameters> | |
| 163 </dataSource> | |
| 164 <securityMod type='IMPL::Config::Activator'> | |
| 165 <factory>IMPL::Object</factory> | |
| 166 <parameters type='HASH'> | |
| 167 <ds refid='ds'/> | |
| 168 </parameters> | |
| 169 </securityMod> | |
| 170 <!-- End custom properties --> | |
| 171 | |
| 172 <!-- direct access to the activators --> | |
| 173 <options type="HASH"> | |
| 174 <dataSource refid='ds'/> | |
| 175 </options> | |
| 176 | |
| 177 <!-- Set default output encoding, can be changed due query handling --> | |
| 178 <responseCharset>utf-8</responseCharset> | |
| 179 | |
| 180 <!-- Actions creation configuration --> | |
| 181 <actionFactory type="IMPL::Object::Factory"> | |
| 182 | |
| 183 <!-- Construct actions --> | |
| 184 <factory>IMPL::Web::Application::Action</factory> | |
| 185 <parameters type='HASH'> | |
| 186 | |
| 187 <!-- with special responseFactory --> | |
| 188 <responseFactory type='IMPL::Object::Factory'> | |
| 189 | |
| 190 <!-- Where resopnses have a special streamOut --> | |
| 191 <factory>IMPL::Web::Application::Response</factory> | |
| 192 <parameters type='HASH'> | |
| 193 | |
| 194 <!-- in memory dummy output instead of STDOUT --> | |
| 195 <streamOut>memory</streamOut> | |
| 196 | |
| 197 </parameters> | |
| 198 </responseFactory> | |
| 199 </parameters> | |
| 200 </actionFactory> | |
| 201 | |
| 202 <!-- Query processing chain --> | |
| 203 <handlersQuery type="IMPL::Object::List"> | |
| 204 <item type="IMPL::Web::QueryHandler::PageFormat"> | |
| 205 <templatesCharset>cp1251</templatesCharset> | |
| 206 </item> | |
| 207 </handlersQuery> | |
| 208 </Application> | |
| 209 | |
| 210 =end code xml | |
| 211 | |
| 73 | 212 =head1 MEMBERS |
| 213 | |
| 214 =over | |
| 215 | |
| 216 =item C<[get,set] handlerError> | |
| 217 | |
| 218 Обработчик который будет вызван в случае возникновения необработанной ошибки | |
| 219 в процессе работы приложения. После чего приложение корректно завершается. | |
| 220 | |
| 221 =item C<[get,set] actionFactory> | |
| 222 | |
| 223 Фабрика объектов, которая используется приложением, для создания объектов | |
| 224 типа C<IMPL::Web::Application::Action> при обработки C<CGI> запросов. | |
| 225 | |
| 226 =begin code | |
| 227 | |
| 228 my $action = $this->actionFactory->new( | |
| 229 query => $query, | |
| 230 application => $this, | |
| 231 ); | |
| 232 | |
| 233 =end code | |
| 234 | |
| 97 | 235 =item C< [get,set] fetchRequestMethod > |
| 236 | |
| 237 Метод получения CGI запроса. Возвращает C<CGI> объект следующего запроса, если | |
| 238 запросов больше нет, то возвращает C<undef>. По-умолчанию использует C<defaultFetchRequest>. | |
| 239 | |
| 240 Может быть как ссылкой на функцию, так и объектом типа C<IMPL::Web::Application::RequestFetcher>. | |
| 241 | |
| 73 | 242 =item C< [get,set,list] handlersQuery > |
| 243 | |
| 244 Список обработчиков запросов, которые будут переданы созданному объекту-действию. | |
| 245 | |
| 246 =item C< [get,set] responseCharset> | |
| 247 | |
| 248 Кодировка ответа клиенту. | |
| 249 | |
| 250 =item C< [get,set] security > | |
| 251 | |
| 252 Объект C<IMPL::Web::Security>, для работы с инфраструктурой безопасности. | |
| 253 | |
| 254 =item C< [get,set] options > | |
| 255 | |
| 256 Обычно ссылка на хеш с настраиваемыми объектами, используется для возможности | |
| 257 програмной настройки активаторов, т.к. напрямую через свойства приложения получить | |
| 258 к ним доступ не получится. | |
| 259 | |
| 260 =back | |
| 261 | |
| 262 =cut |