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