Mercurial > pub > Impl
annotate Lib/IMPL/Web/Application/ControllerUnit.pm @ 133:a07a66fd8d5c
Added IMPL::Class::MethodInfo
IMPL::Class::Property::Base optimizations
| author | wizard |
|---|---|
| date | Fri, 18 Jun 2010 16:27:28 +0400 |
| parents | 42fbb38d4a48 |
| children | 44977efed303 |
| 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 | |
| 42 sub forms { | |
| 43 my ($self,%forms) = @_; | |
| 44 | |
| 45 while ( my ($method,$info) = each %forms ) { | |
| 46 die new IMPL::Exception("A method doesn't exists in the controller",$self,$method) unless $self->can($method); | |
| 47 if ( not ref $info ) { | |
| 48 $self->class_data(CONTROLLER_METHODS)->{$method} = { | |
| 49 wrapper => 'FormWrapper', | |
| 50 schema => $info | |
| 51 }; | |
| 52 } elsif (ref $info eq 'HASH') { | |
| 53 die new IMPL::Exception("A schema must be specified",$self,$method) unless $info->{schema}; | |
| 54 | |
| 55 $self->class_data(CONTROLLER_METHODS)->{$method} = { | |
| 56 wrapper => 'FormWrapper', | |
| 57 schema => $info->{schema} | |
| 58 }; | |
| 59 } else { | |
| 60 die new IMPL::Exception("Unsupported method information",$self,$method); | |
| 61 } | |
| 62 } | |
| 63 } | |
| 64 | |
| 110 | 65 sub InvokeAction { |
| 66 my ($self,$method,$action) = @_; | |
| 67 | |
| 112 | 68 if (my $methodInfo = $self->class_data(CONTROLLER_METHODS)->{$method}) { |
| 69 if (my $wrapper = $methodInfo->{wrapper}) { | |
| 70 return $self->$wrapper($method,$action,$methodInfo); | |
| 71 } else { | |
| 72 return $self->TransactionWrapper($method,$action,$methodInfo); | |
| 73 } | |
| 110 | 74 } else { |
| 75 die new IMPL::InvalidOperationException("Invalid method call",$self,$method); | |
| 76 } | |
| 111 | 77 } |
| 78 | |
| 133 | 79 sub MakeParams { |
| 80 my ($this,$methodInfo) = @_; | |
| 81 | |
| 82 my $params; | |
| 83 if ($params = $methodInfo->{parameters} and ref $params eq 'ARRAY') { | |
| 84 return map $this->ResolveParam($_), @$params; | |
| 85 } | |
| 86 return(); | |
| 87 } | |
| 88 | |
| 89 sub ResolveParam { | |
| 90 my ($this,$param) = @_; | |
| 91 | |
| 92 if ( $param =~ /^::(\w+)$/ and $publicProps{$1}) { | |
| 93 return $this->$1(); | |
| 94 } else { | |
| 95 return $this->query->param($param); | |
| 96 } | |
| 97 } | |
| 98 | |
| 112 | 99 sub TransactionWrapper { |
| 100 my ($self,$method,$action,$methodInfo) = @_; | |
| 101 | |
| 102 my $unit = $self->new($action); | |
| 133 | 103 return $unit->$method($unit->MakeParams($methodInfo)); |
| 112 | 104 } |
| 105 | |
| 106 sub FormWrapper { | |
| 113 | 107 my ($self,$method,$action,$methodInfo) = @_; |
| 108 | |
| 109 my $schema = $self->loadSchema($methodInfo->{schema}); | |
| 110 | |
| 111 my $process = $action->query->param('process') || 0; | |
| 112 my $form = $methodInfo->{form} | |
| 113 || $action->query->param('form') | |
| 114 || $schema->selectSingleNode('ComplexNode')->name | |
| 115 or die new IMPL::Exception('No situable form name could be determined',$self,$method); | |
| 112 | 116 |
| 113 | 117 my %result; |
| 112 | 118 |
| 113 | 119 my $transform = IMPL::DOM::Transform::PostToDOM->new( |
| 120 undef, | |
| 121 $schema, | |
| 122 $form | |
| 123 ); | |
| 124 | |
| 125 $result{formSchema} = $schema; | |
| 126 | 126 $result{formData} = $transform->Transform($action->query); |
| 127 | |
| 112 | 128 |
| 113 | 129 if ($process) { |
| 130 $result{formErrors} = $transform->Errors->as_list; | |
| 131 if ($transform->Errors->Count) { | |
| 132 $result{state} = STATE_INVALID; | |
| 133 } else { | |
| 134 $result{state} = STATE_CORRECT; | |
| 135 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
|
136 |
|
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
|
137 eval { |
| 133 | 138 $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
|
139 }; |
|
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
|
140 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
|
141 $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
|
142 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
|
143 $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
|
144 } 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
|
145 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
|
146 } |
|
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
|
147 } |
| 113 | 148 } |
| 149 } else { | |
| 150 $result{state} = STATE_NEW; | |
| 151 } | |
| 112 | 152 |
| 113 | 153 return \%result; |
| 154 } | |
| 155 | |
| 156 sub loadSchema { | |
| 157 my ($self,$name) = @_; | |
| 158 | |
| 126 | 159 if (-f $name) { |
| 160 return IMPL::DOM::Schema->LoadSchema($name); | |
| 161 } else { | |
| 162 my ($vol,$dir,$file) = File::Spec->splitpath( Class::Inspector->resolved_filename(ref $self || $self) ); | |
| 163 | |
| 164 return IMPL::DOM::Schema->LoadSchema(File::Spec->catfile($vol,$dir,$name)); | |
| 165 } | |
| 112 | 166 } |
| 167 | |
| 133 | 168 sub webMethod($$;$$) { |
| 169 my ($name,$args,$body,$options) = @_; | |
| 170 | |
| 171 my %info = %$options; | |
| 172 $info{parameters} = $args; | |
| 173 $info{name} = $name; | |
| 174 $info{module} = scalar caller; | |
| 175 | |
| 176 | |
| 177 } | |
| 178 | |
| 179 public webMethod discover => sub { | |
| 180 | |
| 181 }, { schema => 'some schema', returns => 'HASH' } ; | |
| 182 | |
| 111 | 183 1; |
| 184 | |
| 185 __END__ | |
| 186 | |
| 187 =pod | |
| 188 | |
| 189 =head1 NAME | |
| 190 | |
| 191 C<IMPL::Web::Application::ControllerUnit> - базовый класс для обработчика транзакций в модели контроллера. | |
| 192 | |
| 193 =head1 DESCRIPTION | |
| 194 | |
| 113 | 195 Классы, наследуемые от данного класса называется пакетом транзакций. Часть методов в таком классе |
| 196 объявляются как транзакции при помощи методов C<transaction>, C<form>. | |
| 111 | 197 |
| 198 Перед выполнением транзакции создается экземпляр объекта, в рамках которого будет выполнена транзакция. | |
| 199 Для этого вызывается метод C<InvokeAction($method,$action)>, который создает/восстанавливает контекст | |
| 200 транзакции. | |
| 201 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
202 Транзакции на данный момент делятся на простые и формы. Различные типы транзакций выполняются при помощи |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
203 различных оберток (C<TransactionWrapper> и C<FormWrapper>). Каждая обертка отвечает за конструирование |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
204 экземпляра объекта и вызов метода для выполнения транзакции, а также за возврат результата выполнения. |
| 111 | 205 |
| 206 =head2 Простые транзакции | |
| 207 | |
| 208 Простые транзакции получаю только запрос, без предварительной обработки, и возвращенный результат напрямую | |
| 209 передается пользователю. | |
| 210 | |
| 211 =head2 Формы | |
| 212 | |
| 213 При использовании форм запрос предварительно обрабатывается, для получения DOM документа с данными формы. | |
| 214 Для постороенния DOM документа используется схема. При этом становятся доступны дополнительные свойства | |
| 215 C<formData>, C<formSchema>, C<formErrors>. | |
| 216 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
217 Результат выполнения транзакции не возвращается наверх напрямую, а включается в структуру, которая |
| 111 | 218 выглядит следующим образом |
| 219 | |
| 220 =begin code | |
| 221 | |
| 222 { | |
| 223 state => '{ new | correct | invalid }', | |
| 224 result => $transactionResult, | |
| 225 formData => $formDOM, | |
| 226 formSchema => $formSchema, | |
| 227 formErrors => @errors | |
| 228 } | |
| 229 | |
| 230 =end code | |
| 231 | |
| 232 =over | |
| 233 | |
| 234 =item C<state> | |
| 235 | |
| 236 Состояние верификации формы. | |
| 237 | |
| 238 =over | |
| 239 | |
| 240 =item C<new> | |
| 241 | |
| 242 Первоначальное содержимое формы, оно может быть некорректным, но это нормально. | |
| 243 В данном состоянии транзакция обычно не выполняется. | |
| 244 | |
| 245 =item C<correct> | |
| 246 | |
| 247 Данные формы корректны, транзакция выполнена, и ее результат доступен через поле C<result> | |
| 248 | |
| 249 =item C<invalid> | |
| 250 | |
| 251 Содержимое формы не прошло верификацию, ошибки доступны через поле C<formErrors>. Транзакция | |
| 252 не выполнялась. | |
| 253 | |
| 254 =back | |
| 255 | |
| 256 =item C<result> | |
| 257 | |
| 258 Результат выполнения транзакции, если конечно таковая выполнялась. | |
| 259 | |
| 260 =item C<formData> | |
| 261 | |
| 262 ДОМ документ с данными формами. Документ существует всегда, не зависимо от его корректности, | |
| 263 может быть использован для построения формы, уже заполненную параметрами. | |
| 264 | |
| 265 =item C<formSchema> | |
| 266 | |
| 267 Схема данных формы, может использоваться для построения динамических форм. | |
| 268 | |
| 269 =item C<formErrors> | |
| 270 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
271 Ссылка на массив с ошибками при проверки формы. |
| 111 | 272 |
| 273 =back | |
| 274 | |
| 275 =head1 MEMBERS | |
| 276 | |
| 277 =over | |
| 278 | |
| 279 =item C<[get] application> | |
| 280 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
281 Объект приложения, которое обрабатывает запрос. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
282 |
| 111 | 283 =item C<[get] query> |
| 284 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
285 Текущий запрос. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
286 |
| 111 | 287 =item C<[get] response> |
| 288 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
289 Текущий ответ. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
290 |
| 111 | 291 =item C<[get] formData> |
| 292 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
293 C<IMPL::DOM::Document> документ с данныим, если данный запрос является формой. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
294 |
| 111 | 295 =item C<[get] formSchema> |
| 296 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
297 C<IMPL::DOM::Schema> документ со схемой формы данного запроса. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
298 |
| 111 | 299 =item C<[get] formErrors> |
| 300 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
301 Ошибки верификации данных, если таковые были. Обычно при наличии ошибок в форме, транзакция |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
302 не выполняется, а эти ошибки передаются в ответ. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
303 |
| 111 | 304 =item C<InvokeAction($method,$action)> |
| 305 | |
| 306 Конструирует контекст выполнения транзакции, может быть переопределен для конструирования контекста по | |
| 112 | 307 своим правилам. |
| 308 | |
| 309 =item C<TransactionWrapper($method,$action,$methodInfo)> | |
| 310 | |
| 311 Обертка для конструирования простых транзакций, может быть переопределен для конструирования контекста по | |
| 312 своим правилам. | |
| 313 | |
| 314 =item C<FormWrapper($method,$action,$methodInfo)> | |
| 315 | |
| 316 Обертка для конструирования форм, может быть переопределен для конструирования контекста по | |
| 317 своим правилам. | |
| 111 | 318 |
| 319 =back | |
| 320 | |
| 321 =head1 EXAMPLE | |
| 322 | |
| 323 =begin code | |
| 324 | |
| 325 package MyBooksUnit; | |
| 326 use strict; | |
| 327 use base qw(IMPL::Web::Application::ControllerUnit); | |
| 328 | |
| 329 __PACKAGE__->PassThroughArgs; | |
| 330 | |
| 331 __PACKAGE__->transactions(qw( | |
| 332 find | |
| 333 info | |
| 334 )); | |
| 335 __PACKAGE__->forms( | |
| 336 create => 'books.create.xml' | |
| 337 ); | |
| 338 | |
| 339 sub find { | |
| 340 my ($this) = @_; | |
| 341 | |
| 342 return $this->application->dataSource->resultset('Books')->find({author => $this->query->param('author')}); | |
| 343 } | |
| 344 | |
| 345 sub info { | |
| 346 my ($this) = @_; | |
| 347 | |
| 348 return $this->application->dataSource->resultset('Books')->find({id => $this->query->param('id')}); | |
| 349 } | |
| 350 | |
| 351 sub create { | |
| 352 my ($this) = @_; | |
| 353 | |
| 354 my %book = map { | |
| 355 $_ => $this->formData->selectSingleNode($_)->nodeValue | |
| 356 } qw(author_id title year ISBN); | |
| 357 | |
| 358 return $this->application->datasource->resultset('Books')->create(\%book); | |
| 359 } | |
| 360 | |
| 361 =end code | |
| 362 | |
| 363 =cut |