Mercurial > pub > Impl
annotate Lib/IMPL/Web/Application/ControllerUnit.pm @ 172:068acfe903c3
corrected schema resolution mechanism
author | sourcer |
---|---|
date | Mon, 20 Jun 2011 23:42:44 +0400 |
parents | 59e5fcb59d86 |
children | aaab45153411 |
rev | line source |
---|---|
133 | 1 use strict; |
110 | 2 package IMPL::Web::Application::ControllerUnit; |
166 | 3 use parent qw(IMPL::Object); |
110 | 4 |
5 use IMPL::Class::Property; | |
112 | 6 use IMPL::DOM::Transform::PostToDOM; |
7 use IMPL::DOM::Schema; | |
113 | 8 use Class::Inspector; |
9 use File::Spec; | |
133 | 10 use Sub::Name; |
112 | 11 |
12 use constant { | |
13 CONTROLLER_METHODS => 'controller_methods', | |
14 STATE_CORRECT => 'correct', | |
15 STATE_NEW => 'new', | |
16 STATE_INVALID => 'invalid' | |
17 }; | |
110 | 18 |
19 BEGIN { | |
20 public property action => prop_get | owner_set; | |
21 public property application => prop_get | owner_set; | |
22 public property query => prop_get | owner_set; | |
144
b56ebc31bf18
Empty nodes no more created while transforming a post request to the DOM document
wizard
parents:
142
diff
changeset
|
23 public property response => prop_get | owner_set; |
111 | 24 public property formData => prop_get | owner_set; |
25 public property formSchema => prop_get | owner_set; | |
26 public property formErrors => prop_get | owner_set; | |
110 | 27 } |
28 | |
170 | 29 my %publicProps = map {$_->Name , 1} __PACKAGE__->get_meta(typeof IMPL::Class::PropertyInfo); |
133 | 30 |
113 | 31 __PACKAGE__->class_data(CONTROLLER_METHODS,{}); |
32 | |
170 | 33 our @schemaInc; |
34 | |
110 | 35 sub CTOR { |
112 | 36 my ($this,$action,$args) = @_; |
110 | 37 |
38 $this->action($action); | |
39 $this->application($action->application); | |
40 $this->query($action->query); | |
144
b56ebc31bf18
Empty nodes no more created while transforming a post request to the DOM document
wizard
parents:
142
diff
changeset
|
41 $this->response($action->response); |
112 | 42 |
43 $this->$_($args->{$_}) foreach qw(formData formSchema formErrors); | |
44 } | |
45 | |
134 | 46 sub unitNamespace() { |
47 "" | |
48 } | |
49 | |
50 sub transactions { | |
51 my ($self,%methods) = @_; | |
52 | |
53 while (my ($method,$info) = each %methods) { | |
54 if ($info and ref $info ne 'HASH') { | |
55 warn "Bad transaction $method description"; | |
56 $info = {}; | |
57 } | |
58 | |
59 $info->{wrapper} = 'TransactionWrapper'; | |
172 | 60 $info->{method} ||= $method; |
134 | 61 $self->class_data(CONTROLLER_METHODS)->{$method} = $info; |
62 } | |
63 } | |
64 | |
112 | 65 sub forms { |
66 my ($self,%forms) = @_; | |
67 | |
68 while ( my ($method,$info) = each %forms ) { | |
69 die new IMPL::Exception("A method doesn't exists in the controller",$self,$method) unless $self->can($method); | |
70 if ( not ref $info ) { | |
71 $self->class_data(CONTROLLER_METHODS)->{$method} = { | |
72 wrapper => 'FormWrapper', | |
172 | 73 schema => $info, |
74 method => $method | |
112 | 75 }; |
76 } elsif (ref $info eq 'HASH') { | |
148
e6447ad85cb4
DOM objects now have a schema and schemaSource properties
wizard
parents:
146
diff
changeset
|
77 $info->{wrapper} = 'FormWrapper'; |
172 | 78 $info->{method} ||= $method; |
148
e6447ad85cb4
DOM objects now have a schema and schemaSource properties
wizard
parents:
146
diff
changeset
|
79 |
e6447ad85cb4
DOM objects now have a schema and schemaSource properties
wizard
parents:
146
diff
changeset
|
80 $self->class_data(CONTROLLER_METHODS)->{$method} = $info; |
112 | 81 } else { |
82 die new IMPL::Exception("Unsupported method information",$self,$method); | |
83 } | |
84 } | |
85 } | |
86 | |
110 | 87 sub InvokeAction { |
88 my ($self,$method,$action) = @_; | |
89 | |
112 | 90 if (my $methodInfo = $self->class_data(CONTROLLER_METHODS)->{$method}) { |
91 if (my $wrapper = $methodInfo->{wrapper}) { | |
92 return $self->$wrapper($method,$action,$methodInfo); | |
93 } else { | |
94 return $self->TransactionWrapper($method,$action,$methodInfo); | |
95 } | |
110 | 96 } else { |
97 die new IMPL::InvalidOperationException("Invalid method call",$self,$method); | |
98 } | |
111 | 99 } |
100 | |
133 | 101 sub MakeParams { |
102 my ($this,$methodInfo) = @_; | |
103 | |
104 my $params; | |
105 if ($params = $methodInfo->{parameters} and ref $params eq 'ARRAY') { | |
146 | 106 return map $this->ResolveParam($_,$methodInfo->{inflate}{$_}), @$params; |
133 | 107 } |
108 return(); | |
109 } | |
110 | |
111 sub ResolveParam { | |
146 | 112 my ($this,$param,$inflate) = @_; |
133 | 113 |
114 if ( $param =~ /^::(\w+)$/ and $publicProps{$1}) { | |
115 return $this->$1(); | |
116 } else { | |
146 | 117 my $value; |
118 if ( my $rx = $inflate->{rx} ) { | |
119 $value = $this->action->param($param,$rx); | |
120 } else { | |
121 $value = $this->query->param($param); | |
122 } | |
123 | |
124 if (my $method = $inflate->{method}) { | |
125 $value = $this->$method($value); | |
126 } | |
127 return $value; | |
133 | 128 } |
129 } | |
130 | |
112 | 131 sub TransactionWrapper { |
132 my ($self,$method,$action,$methodInfo) = @_; | |
133 | |
134 my $unit = $self->new($action); | |
172 | 135 my $handler = $methodInfo->{method}; |
136 return $unit->$handler($unit->MakeParams($methodInfo)); | |
112 | 137 } |
138 | |
139 sub FormWrapper { | |
113 | 140 my ($self,$method,$action,$methodInfo) = @_; |
141 | |
171
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
142 my $schema = $methodInfo->{schema} ? $self->loadSchema($methodInfo->{schema}) : $self->unitSchema; |
113 | 143 |
144 my $process = $action->query->param('process') || 0; | |
145 my $form = $methodInfo->{form} | |
146 || $action->query->param('form') | |
171
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
147 || $method; |
112 | 148 |
113 | 149 my %result; |
112 | 150 |
113 | 151 my $transform = IMPL::DOM::Transform::PostToDOM->new( |
152 undef, | |
153 $schema, | |
154 $form | |
155 ); | |
156 | |
172 | 157 my $handler = $methodInfo->{method}; |
158 | |
138 | 159 $result{formName} = $form; |
113 | 160 $result{formSchema} = $schema; |
112 | 161 |
113 | 162 if ($process) { |
171
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
163 $result{formData} = $transform->Transform($action->query); |
113 | 164 $result{formErrors} = $transform->Errors->as_list; |
165 if ($transform->Errors->Count) { | |
166 $result{state} = STATE_INVALID; | |
167 } else { | |
168 $result{state} = STATE_CORRECT; | |
169 my $unit = $self->new($action,\%result); | |
127
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
170 |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
171 eval { |
172 | 172 $result{result} = $unit->$handler($unit->MakeParams($methodInfo)); |
127
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
173 }; |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
174 if (my $err = $@) { |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
175 $result{state} = STATE_INVALID; |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
176 if (eval { $err->isa(typeof IMPL::WrongDataException) } ) { |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
177 $result{formErrors} = $err->Args; |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
178 } else { |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
179 die $err; |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
180 } |
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
181 } |
113 | 182 } |
183 } else { | |
171
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
184 if (my $initMethod = $methodInfo->{init}) { |
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
185 my $unit = $self->new($action,\%result); |
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
186 $result{formData} = $transform->Transform( $unit->$initMethod($unit->MakeParams($methodInfo)) ); |
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
187 } else { |
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
188 $result{formData} = $transform->Transform($action->query); |
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
189 } |
59e5fcb59d86
Рсправления, изменена концепция веб-форм
sourcer
parents:
170
diff
changeset
|
190 |
172 | 191 # ignore errors for new forms |
192 #$result{formErrors} = $transform->Errors->as_list; | |
113 | 193 $result{state} = STATE_NEW; |
194 } | |
112 | 195 |
113 | 196 return \%result; |
197 } | |
198 | |
199 sub loadSchema { | |
200 my ($self,$name) = @_; | |
170 | 201 |
202 foreach my $path (map File::Spec->catfile($_,$name) ,@schemaInc) { | |
203 return IMPL::DOM::Schema->LoadSchema($path) if -f $path; | |
204 } | |
113 | 205 |
170 | 206 die new IMPL::Exception("A schema isn't found", $name); |
207 } | |
208 | |
209 sub unitSchema { | |
210 my ($self) = @_; | |
211 | |
212 my $class = ref $self || $self; | |
213 | |
214 my @parts = split(/:+/, $class); | |
215 | |
216 my $file = pop @parts; | |
217 $file = "${file}.schema.xml"; | |
218 | |
219 foreach my $inc ( @schemaInc ) { | |
220 my $path = File::Spec->catfile($inc,@parts,$file); | |
126 | 221 |
170 | 222 return IMPL::DOM::Schema->LoadSchema($path) if -f $path; |
126 | 223 } |
170 | 224 |
225 return undef; | |
112 | 226 } |
227 | |
134 | 228 sub discover { |
229 my ($this) = @_; | |
230 | |
231 my $methods = $this->class_data(CONTROLLER_METHODS); | |
232 | |
233 my $namespace = $this->unitNamespace; | |
234 (my $module = typeof $this) =~ s/^$namespace//; | |
133 | 235 |
134 | 236 my %smd = ( |
237 module => [grep $_, split /::/, $module ], | |
238 ); | |
133 | 239 |
134 | 240 while (my ($method,$info) = each %$methods) { |
241 my %methodInfo = ( | |
242 name => $method | |
243 ); | |
160 | 244 $methodInfo{parameters} = [ grep /^[^\:]/, @{ $info->{parameters} } ] if ref $info->{parameters} eq 'ARRAY'; |
134 | 245 push @{$smd{methods}},\%methodInfo; |
246 } | |
247 return \%smd; | |
133 | 248 } |
249 | |
134 | 250 __PACKAGE__->transactions( |
251 discover => undef | |
252 ); | |
133 | 253 |
111 | 254 1; |
255 | |
256 __END__ | |
257 | |
258 =pod | |
259 | |
260 =head1 NAME | |
261 | |
262 C<IMPL::Web::Application::ControllerUnit> - базовый класс для обработчика транзакций в модели контроллера. | |
263 | |
264 =head1 DESCRIPTION | |
265 | |
113 | 266 Классы, наследуемые от данного класса называется пакетом транзакций. Часть методов в таком классе |
267 объявляются как транзакции при помощи методов C<transaction>, C<form>. | |
111 | 268 |
269 Перед выполнением транзакции создается экземпляр объекта, в рамках которого будет выполнена транзакция. | |
270 Для этого вызывается метод C<InvokeAction($method,$action)>, который создает/восстанавливает контекст | |
271 транзакции. | |
272 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
273 Транзакции на данный момент делятся на простые и формы. Различные типы транзакций выполняются при помощи |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
274 различных оберток (C<TransactionWrapper> и C<FormWrapper>). Каждая обертка отвечает за конструирование |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
275 экземпляра объекта и вызов метода для выполнения транзакции, а также за возврат результата выполнения. |
111 | 276 |
277 =head2 Простые транзакции | |
278 | |
279 Простые транзакции получаю только запрос, без предварительной обработки, и возвращенный результат напрямую | |
280 передается пользователю. | |
281 | |
282 =head2 Формы | |
283 | |
284 При использовании форм запрос предварительно обрабатывается, для получения DOM документа с данными формы. | |
285 Для постороенния DOM документа используется схема. При этом становятся доступны дополнительные свойства | |
286 C<formData>, C<formSchema>, C<formErrors>. | |
287 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
288 Результат выполнения транзакции не возвращается наверх напрямую, а включается в структуру, которая |
111 | 289 выглядит следующим образом |
290 | |
291 =begin code | |
292 | |
293 { | |
294 state => '{ new | correct | invalid }', | |
295 result => $transactionResult, | |
296 formData => $formDOM, | |
297 formSchema => $formSchema, | |
298 formErrors => @errors | |
299 } | |
300 | |
301 =end code | |
302 | |
303 =over | |
304 | |
305 =item C<state> | |
306 | |
307 Состояние верификации формы. | |
308 | |
309 =over | |
310 | |
311 =item C<new> | |
312 | |
313 Первоначальное содержимое формы, оно может быть некорректным, но это нормально. | |
314 В данном состоянии транзакция обычно не выполняется. | |
315 | |
316 =item C<correct> | |
317 | |
318 Данные формы корректны, транзакция выполнена, и ее результат доступен через поле C<result> | |
319 | |
320 =item C<invalid> | |
321 | |
322 Содержимое формы не прошло верификацию, ошибки доступны через поле C<formErrors>. Транзакция | |
323 не выполнялась. | |
324 | |
325 =back | |
326 | |
327 =item C<result> | |
328 | |
329 Результат выполнения транзакции, если конечно таковая выполнялась. | |
330 | |
331 =item C<formData> | |
332 | |
333 ДОМ документ с данными формами. Документ существует всегда, не зависимо от его корректности, | |
334 может быть использован для построения формы, уже заполненную параметрами. | |
335 | |
336 =item C<formSchema> | |
337 | |
338 Схема данных формы, может использоваться для построения динамических форм. | |
339 | |
340 =item C<formErrors> | |
341 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
342 Ссылка на массив с ошибками при проверки формы. |
111 | 343 |
344 =back | |
345 | |
346 =head1 MEMBERS | |
347 | |
348 =over | |
349 | |
350 =item C<[get] application> | |
351 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
352 Объект приложения, которое обрабатывает запрос. |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
353 |
111 | 354 =item C<[get] query> |
355 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
356 Текущий запрос. |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
357 |
111 | 358 =item C<[get] response> |
359 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
360 Текущий ответ. |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
361 |
111 | 362 =item C<[get] formData> |
363 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
364 C<IMPL::DOM::Document> документ с данныим, если данный запрос является формой. |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
365 |
111 | 366 =item C<[get] formSchema> |
367 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
368 C<IMPL::DOM::Schema> документ со схемой формы данного запроса. |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
369 |
111 | 370 =item C<[get] formErrors> |
371 | |
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
372 Ошибки верификации данных, если таковые были. Обычно при наличии ошибок в форме, транзакция |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
373 не выполняется, а эти ошибки передаются в ответ. |
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
374 |
111 | 375 =item C<InvokeAction($method,$action)> |
376 | |
377 Конструирует контекст выполнения транзакции, может быть переопределен для конструирования контекста по | |
112 | 378 своим правилам. |
379 | |
380 =item C<TransactionWrapper($method,$action,$methodInfo)> | |
381 | |
382 Обертка для конструирования простых транзакций, может быть переопределен для конструирования контекста по | |
383 своим правилам. | |
384 | |
385 =item C<FormWrapper($method,$action,$methodInfo)> | |
386 | |
387 Обертка для конструирования форм, может быть переопределен для конструирования контекста по | |
388 своим правилам. | |
111 | 389 |
134 | 390 =item C<discover()> |
391 | |
392 Метод, опубликованный для вызова контроллером, возвращает описание методов в формате C<Simple Module Definition>. | |
393 | |
394 =begin code | |
395 | |
396 # SMD structure | |
397 { | |
398 module => ['Foo','Bar'], | |
399 methods => [ | |
400 { | |
401 name => 'search', | |
402 parameters => ['text','limit'] #optional | |
403 } | |
404 ] | |
405 } | |
406 | |
407 =end code | |
408 | |
111 | 409 =back |
410 | |
411 =head1 EXAMPLE | |
412 | |
413 =begin code | |
414 | |
415 package MyBooksUnit; | |
416 use strict; | |
166 | 417 use parent qw(IMPL::Web::Application::ControllerUnit); |
111 | 418 |
419 __PACKAGE__->PassThroughArgs; | |
420 | |
134 | 421 sub unitDataClass { 'My::Books' } |
422 | |
423 __PACKAGE__->transactions( | |
424 find => { | |
425 parameters => [qw(author)] | |
426 }, | |
427 info => { | |
428 parameters => [qw(id)] | |
429 } | |
430 ); | |
111 | 431 __PACKAGE__->forms( |
432 create => 'books.create.xml' | |
433 ); | |
434 | |
435 sub find { | |
134 | 436 my ($this,$author) = @_; |
111 | 437 |
134 | 438 return $this->ds->find({author => $author}); |
111 | 439 } |
440 | |
441 sub info { | |
134 | 442 my ($this,$id) = @_; |
111 | 443 |
134 | 444 return $this->ds->find({id => $id}); |
111 | 445 } |
446 | |
447 sub create { | |
448 my ($this) = @_; | |
449 | |
450 my %book = map { | |
134 | 451 $_->nodeName, $_->nodeValue |
452 } $this->formData->selectNodes([qw(author_id title year ISBN)]); | |
111 | 453 |
134 | 454 return $this->ds->create(\%book); |
111 | 455 } |
456 | |
457 =end code | |
458 | |
459 =cut |