|
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
|
|
|
68 sub InvokeAction {
|
|
|
69 my ($self,$method,$action) = @_;
|
|
|
70
|
|
112
|
71 if (my $methodInfo = $self->class_data(CONTROLLER_METHODS)->{$method}) {
|
|
|
72 if (my $wrapper = $methodInfo->{wrapper}) {
|
|
|
73 return $self->$wrapper($method,$action,$methodInfo);
|
|
|
74 } else {
|
|
|
75 return $self->TransactionWrapper($method,$action,$methodInfo);
|
|
|
76 }
|
|
110
|
77 } else {
|
|
|
78 die new IMPL::InvalidOperationException("Invalid method call",$self,$method);
|
|
|
79 }
|
|
111
|
80 }
|
|
|
81
|
|
112
|
82 sub TransactionWrapper {
|
|
|
83 my ($self,$method,$action,$methodInfo) = @_;
|
|
|
84
|
|
|
85 my $unit = $self->new($action);
|
|
|
86 return $unit->$method();
|
|
|
87 }
|
|
|
88
|
|
|
89 sub FormWrapper {
|
|
113
|
90 my ($self,$method,$action,$methodInfo) = @_;
|
|
|
91
|
|
|
92 my $schema = $self->loadSchema($methodInfo->{schema});
|
|
|
93
|
|
|
94 my $process = $action->query->param('process') || 0;
|
|
|
95 my $form = $methodInfo->{form}
|
|
|
96 || $action->query->param('form')
|
|
|
97 || $schema->selectSingleNode('ComplexNode')->name
|
|
|
98 or die new IMPL::Exception('No situable form name could be determined',$self,$method);
|
|
112
|
99
|
|
113
|
100 my %result;
|
|
112
|
101
|
|
113
|
102 my $transform = IMPL::DOM::Transform::PostToDOM->new(
|
|
|
103 undef,
|
|
|
104 $schema,
|
|
|
105 $form
|
|
|
106 );
|
|
|
107
|
|
|
108 $result{formSchema} = $schema;
|
|
|
109 $result{formData} = $transform->Transform($self->query);
|
|
112
|
110
|
|
113
|
111 if ($process) {
|
|
|
112 $result{formErrors} = $transform->Errors->as_list;
|
|
|
113 if ($transform->Errors->Count) {
|
|
|
114 $result{state} = STATE_INVALID;
|
|
|
115 } else {
|
|
|
116 $result{state} = STATE_CORRECT;
|
|
|
117 my $unit = $self->new($action,\%result);
|
|
|
118 $result{result} = $unit->method();
|
|
|
119 }
|
|
|
120 } else {
|
|
|
121 $result{state} = STATE_NEW;
|
|
|
122 }
|
|
112
|
123
|
|
113
|
124 return \%result;
|
|
|
125 }
|
|
|
126
|
|
|
127 sub loadSchema {
|
|
|
128 my ($self,$name) = @_;
|
|
|
129
|
|
|
130 my ($vol,$dir,$file) = File::Spec->splitpath( Class::Inspector->resolved_filename(ref $self || $self) );
|
|
|
131
|
|
|
132 return IMPL::DOM::Schema->LoadSchema(File::Spec->catfile($vol,$dir,$name));
|
|
112
|
133 }
|
|
|
134
|
|
111
|
135 1;
|
|
|
136
|
|
|
137 __END__
|
|
|
138
|
|
|
139 =pod
|
|
|
140
|
|
|
141 =head1 NAME
|
|
|
142
|
|
|
143 C<IMPL::Web::Application::ControllerUnit> - базовый класс для обработчика транзакций в модели контроллера.
|
|
|
144
|
|
|
145 =head1 DESCRIPTION
|
|
|
146
|
|
113
|
147 Классы, наследуемые от данного класса называется пакетом транзакций. Часть методов в таком классе
|
|
|
148 объявляются как транзакции при помощи методов C<transaction>, C<form>.
|
|
111
|
149
|
|
|
150 Перед выполнением транзакции создается экземпляр объекта, в рамках которого будет выполнена транзакция.
|
|
|
151 Для этого вызывается метод C<InvokeAction($method,$action)>, который создает/восстанавливает контекст
|
|
|
152 транзакции.
|
|
|
153
|
|
|
154 Транзакции на данный момент делятся на простые и формы.
|
|
|
155
|
|
|
156 =head2 Простые транзакции
|
|
|
157
|
|
|
158 Простые транзакции получаю только запрос, без предварительной обработки, и возвращенный результат напрямую
|
|
|
159 передается пользователю.
|
|
|
160
|
|
|
161 =head2 Формы
|
|
|
162
|
|
|
163 При использовании форм запрос предварительно обрабатывается, для получения DOM документа с данными формы.
|
|
|
164 Для постороенния DOM документа используется схема. При этом становятся доступны дополнительные свойства
|
|
|
165 C<formData>, C<formSchema>, C<formErrors>.
|
|
|
166
|
|
|
167 Результат выполнения транзакции не возвращается напрямую пользователю, а включается в общий ответ, который
|
|
|
168 выглядит следующим образом
|
|
|
169
|
|
|
170 =begin code
|
|
|
171
|
|
|
172 {
|
|
|
173 state => '{ new | correct | invalid }',
|
|
|
174 result => $transactionResult,
|
|
|
175 formData => $formDOM,
|
|
|
176 formSchema => $formSchema,
|
|
|
177 formErrors => @errors
|
|
|
178 }
|
|
|
179
|
|
|
180 =end code
|
|
|
181
|
|
|
182 =over
|
|
|
183
|
|
|
184 =item C<state>
|
|
|
185
|
|
|
186 Состояние верификации формы.
|
|
|
187
|
|
|
188 =over
|
|
|
189
|
|
|
190 =item C<new>
|
|
|
191
|
|
|
192 Первоначальное содержимое формы, оно может быть некорректным, но это нормально.
|
|
|
193 В данном состоянии транзакция обычно не выполняется.
|
|
|
194
|
|
|
195 =item C<correct>
|
|
|
196
|
|
|
197 Данные формы корректны, транзакция выполнена, и ее результат доступен через поле C<result>
|
|
|
198
|
|
|
199 =item C<invalid>
|
|
|
200
|
|
|
201 Содержимое формы не прошло верификацию, ошибки доступны через поле C<formErrors>. Транзакция
|
|
|
202 не выполнялась.
|
|
|
203
|
|
|
204 =back
|
|
|
205
|
|
|
206 =item C<result>
|
|
|
207
|
|
|
208 Результат выполнения транзакции, если конечно таковая выполнялась.
|
|
|
209
|
|
|
210 =item C<formData>
|
|
|
211
|
|
|
212 ДОМ документ с данными формами. Документ существует всегда, не зависимо от его корректности,
|
|
|
213 может быть использован для построения формы, уже заполненную параметрами.
|
|
|
214
|
|
|
215 =item C<formSchema>
|
|
|
216
|
|
|
217 Схема данных формы, может использоваться для построения динамических форм.
|
|
|
218
|
|
|
219 =item C<formErrors>
|
|
|
220
|
|
|
221 Ошибки верификации данных, если таковые были
|
|
|
222
|
|
|
223 =back
|
|
|
224
|
|
|
225 =head1 MEMBERS
|
|
|
226
|
|
|
227 =over
|
|
|
228
|
|
|
229 =item C<[get] application>
|
|
|
230
|
|
|
231 =item C<[get] query>
|
|
|
232
|
|
|
233 =item C<[get] response>
|
|
|
234
|
|
|
235 =item C<[get] formData>
|
|
|
236
|
|
|
237 =item C<[get] formSchema>
|
|
|
238
|
|
|
239 =item C<[get] formErrors>
|
|
|
240
|
|
|
241 =item C<InvokeAction($method,$action)>
|
|
|
242
|
|
|
243 Конструирует контекст выполнения транзакции, может быть переопределен для конструирования контекста по
|
|
112
|
244 своим правилам.
|
|
|
245
|
|
|
246 =item C<TransactionWrapper($method,$action,$methodInfo)>
|
|
|
247
|
|
|
248 Обертка для конструирования простых транзакций, может быть переопределен для конструирования контекста по
|
|
|
249 своим правилам.
|
|
|
250
|
|
|
251 =item C<FormWrapper($method,$action,$methodInfo)>
|
|
|
252
|
|
|
253 Обертка для конструирования форм, может быть переопределен для конструирования контекста по
|
|
|
254 своим правилам.
|
|
111
|
255
|
|
|
256 =back
|
|
|
257
|
|
|
258 =head1 EXAMPLE
|
|
|
259
|
|
|
260 =begin code
|
|
|
261
|
|
|
262 package MyBooksUnit;
|
|
|
263 use strict;
|
|
|
264 use base qw(IMPL::Web::Application::ControllerUnit);
|
|
|
265
|
|
|
266 __PACKAGE__->PassThroughArgs;
|
|
|
267
|
|
|
268 __PACKAGE__->transactions(qw(
|
|
|
269 find
|
|
|
270 info
|
|
|
271 ));
|
|
|
272 __PACKAGE__->forms(
|
|
|
273 create => 'books.create.xml'
|
|
|
274 );
|
|
|
275
|
|
|
276 sub find {
|
|
|
277 my ($this) = @_;
|
|
|
278
|
|
|
279 return $this->application->dataSource->resultset('Books')->find({author => $this->query->param('author')});
|
|
|
280 }
|
|
|
281
|
|
|
282 sub info {
|
|
|
283 my ($this) = @_;
|
|
|
284
|
|
|
285 return $this->application->dataSource->resultset('Books')->find({id => $this->query->param('id')});
|
|
|
286 }
|
|
|
287
|
|
|
288 sub create {
|
|
|
289 my ($this) = @_;
|
|
|
290
|
|
|
291 my %book = map {
|
|
|
292 $_ => $this->formData->selectSingleNode($_)->nodeValue
|
|
|
293 } qw(author_id title year ISBN);
|
|
|
294
|
|
|
295 return $this->application->datasource->resultset('Books')->create(\%book);
|
|
|
296 }
|
|
|
297
|
|
|
298 =end code
|
|
|
299
|
|
|
300 =cut |
