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