|
373
|
1 package IMPL::Web::Application::Resource;
|
|
|
2 use strict;
|
|
|
3
|
|
|
4 use constant {
|
|
|
5 ResourceClass => __PACKAGE__
|
|
|
6 };
|
|
|
7 use Scalar::Util qw(blessed);
|
|
|
8
|
|
|
9 use IMPL::lang qw(:hash :base);
|
|
|
10 use IMPL::Const qw(:prop);
|
|
|
11 use IMPL::declare {
|
|
|
12 require => {
|
|
|
13 Exception => 'IMPL::Exception',
|
|
|
14 OpException => '-IMPL::InvalidOperationException',
|
|
|
15 NotFoundException => 'IMPL::Web::NotFoundException',
|
|
|
16 ResourceInterface => '-IMPL::Web::Application',
|
|
|
17 Loader => 'IMPL::Code::Loader'
|
|
|
18 },
|
|
|
19 base => [
|
|
|
20 'IMPL::Object' => undef,
|
|
|
21 'IMPL::Web::Application::ResourceBase' => '@_'
|
|
|
22 ],
|
|
|
23 props => [
|
|
|
24 access => PROP_RW,
|
|
|
25 verbs => PROP_RW,
|
|
|
26 children => PROP_RW
|
|
|
27 ]
|
|
|
28 };
|
|
|
29
|
|
|
30 __PACKAGE__->static_accessor(verbNames => [qw(get post put delete options head)]);
|
|
|
31 __PACKAGE__->static_accessor(httpMethodPrefix => 'Http');
|
|
|
32
|
|
|
33 sub CTOR {
|
|
|
34 my ($this, %args) = @_;
|
|
|
35
|
|
|
36 my %verbs;
|
|
|
37 my $httpPrefix = $this->httpMethodPrefix;
|
|
|
38
|
|
|
39 foreach my $verb (@{$this->verbNames}) {
|
|
|
40 my $method = exists $args{$verb} ? $args{$verb} : $this->can($httpPrefix . ucfirst($verb));
|
|
|
41 $verbs{$verb} = $method
|
|
|
42 if $method;
|
|
|
43 }
|
|
|
44
|
|
|
45 hashApply(\%verbs,$args{verbs})
|
|
|
46 if ref($args{verbs}) eq 'HASH' ;
|
|
|
47
|
|
|
48 $this->children($args{children} || $this->GetChildResources());
|
|
|
49
|
|
|
50 $this->access($args{access})
|
|
|
51 if $args{access};
|
|
|
52
|
|
|
53 $this->verbs(\%verbs);
|
|
|
54 }
|
|
|
55
|
|
|
56 sub _isInvokable {
|
|
|
57 my ($this,$method) = @_;
|
|
|
58
|
|
|
59 return
|
|
|
60 (blessed($method) and $method->can('Invoke')) ||
|
|
|
61 ref($method) eq 'CODE'
|
|
|
62 }
|
|
|
63
|
|
|
64 sub _invoke {
|
|
|
65 my ($this,$method,@args) = @_;
|
|
|
66
|
|
|
67 if(blessed($method) and $method->can('Invoke')) {
|
|
|
68 return $method->Invoke($this,@args);
|
|
|
69 } elsif(ref($method) eq 'CODE' || (not(ref($method)) and $this->can($method))) {
|
|
|
70 return $this->$method(@args);
|
|
|
71 } else {
|
|
|
72 die OpException->new("Can't invoke the specified method: $method");
|
|
|
73 }
|
|
|
74 }
|
|
|
75
|
|
|
76 sub HttpGet {
|
|
|
77 shift->model;
|
|
|
78 }
|
|
|
79
|
|
|
80 sub Fetch {
|
|
|
81 my ($this,$childId) = @_;
|
|
|
82
|
|
|
83 my $children = $this->children
|
|
|
84 or die NotFoundException->new( $this->location->url, $childId );
|
|
|
85
|
|
|
86 if (ref($children) eq 'HASH') {
|
|
375
|
87 if(my $child = $children->{$childId}) {
|
|
|
88 return $this->_isInvokable($child) ? $this->_invoke($child, $childId) : $child;
|
|
|
89 } else {
|
|
|
90 die NotFoundException->new( $this->location->url, $childId );
|
|
|
91 }
|
|
374
|
92 } elsif($this->_isInvokable($children)) {
|
|
|
93 return $this->_invoke($children,$childId);
|
|
373
|
94 } else {
|
|
374
|
95 die OpException->new("Invalid resource description", $childId, $children);
|
|
373
|
96 }
|
|
|
97 }
|
|
|
98
|
|
|
99 sub FetchChildResource {
|
|
|
100 my ($this,$childId) = @_;
|
|
|
101
|
|
|
102 my $info = $this->Fetch($childId);
|
|
|
103
|
|
|
104 return $info
|
|
|
105 if (is($info,ResourceInterface));
|
|
|
106
|
|
|
107 return $this->CreateChildResource($info, $childId)
|
|
|
108 if ref($info) eq 'HASH';
|
|
|
109
|
|
|
110 die OpException->new("Invalid resource description", $childId, $info);
|
|
|
111 }
|
|
|
112
|
|
|
113 sub CreateChildResource {
|
|
|
114 my ($this,$info, $childId) = @_;
|
|
|
115
|
|
|
116 my $params = hashApply(
|
|
|
117 {
|
|
|
118 parent => $this,
|
|
|
119 id => $childId,
|
|
|
120 request => $this->request,
|
|
|
121 class => ResourceClass
|
|
|
122 },
|
|
|
123 $info
|
|
|
124 );
|
|
|
125
|
|
|
126 $params->{model} = $this->_invoke($params->{model})
|
|
|
127 if $this->_isInvokable($params->{model});
|
|
|
128
|
|
|
129 my $factory = Loader->default->Require($params->{class});
|
|
|
130
|
|
|
131 return $factory->new(%$params);
|
|
|
132 }
|
|
|
133
|
|
|
134 sub GetChildResources {
|
|
|
135 return {};
|
|
|
136 }
|
|
|
137
|
|
|
138 1;
|
|
|
139
|
|
|
140 __END__
|
|
|
141
|
|
|
142 =pod
|
|
|
143
|
|
|
144 =head1 NAME
|
|
|
145
|
|
|
146 C<IMPL::Web::Application::Resource> - Ресурс C<REST> веб приложения
|
|
|
147
|
|
|
148 =head1 SYNOPSIS
|
|
|
149
|
|
|
150 =begin code
|
|
|
151
|
|
|
152 use IMPL::require {
|
|
|
153 Resource => 'IMPL::Web::Application::Resource',
|
|
|
154 Security => 'IMPL::Security',
|
|
|
155 NotFoundException => 'IMPL::Web::NotFoundException',
|
|
|
156 ForbiddenException => 'IMPL::Web::ForbiddenException'
|
|
|
157 };
|
|
|
158
|
|
|
159 my $model = Resource->new(
|
|
|
160 get => sub { },
|
|
|
161 verbs => {
|
|
|
162 # non-standart verbs placed here
|
|
|
163 myverb => sub { }
|
|
|
164 },
|
|
|
165 #child resources can be a hash
|
|
391
|
166 children => {
|
|
373
|
167 user => {
|
|
|
168 # a resource class may be specified optionally
|
|
|
169 # class => Resource,
|
|
|
170 model => sub {
|
|
|
171 return Security->principal
|
|
|
172 },
|
|
|
173 # the default get implementation is implied
|
|
|
174 # get => sub { shift->model },
|
|
|
175 access => sub {
|
|
|
176 my ($this,$verb) = @_;
|
|
|
177 die ForbiddenException->new()
|
|
|
178 if Security->principal->isNobody
|
|
|
179 }
|
|
|
180 },
|
|
|
181 catalog => {
|
|
|
182 get => sub {
|
|
|
183 my $ctx = shift->application->ConnectDb()->AutoPtr();
|
|
|
184
|
|
|
185 return $ctx->products->find_rs({ in_stock => 1 });
|
|
|
186 },
|
|
|
187 # chid resource may be created dynamically
|
|
|
188 children => sub {
|
|
|
189 # binds model against the parent reource and id
|
|
|
190 my ($this,$id) = @_;
|
|
|
191
|
|
|
192 ($id) = ($id =~ /^(\w+)$/)
|
|
|
193 or die NotFoundException->new($id);
|
|
|
194
|
|
|
195 my $ctx = shift->application->ConnectDb()->AutoPtr();
|
|
|
196
|
|
|
197 my $item = $ctx->products->fetch($id);
|
|
|
198
|
|
|
199 die NotFoundException->new()
|
|
|
200 unless $item;
|
|
|
201
|
|
|
202 # return parameters for the new resource
|
|
|
203 return {
|
|
|
204 model => $item,
|
|
|
205 get => sub { shift->model }
|
|
|
206 };
|
|
|
207 }
|
|
|
208 },
|
|
|
209 # dynamically binds whole child resource. The result of binding is
|
|
|
210 # the new resource or a hash with arguments to create one
|
|
|
211 posts => sub {
|
|
|
212 my ($this,$id) = @_;
|
|
|
213
|
|
|
214 # this approach can be used to create a dynamic resource relaying
|
|
|
215 # on the type of the model
|
|
|
216
|
|
|
217 return Resource->new(
|
|
|
218 id => $id,
|
|
|
219 parent => $this,
|
|
|
220 get => sub { shift->model }
|
|
|
221 );
|
|
|
222
|
|
|
223 # ditto
|
|
|
224 # parent and id will be mixed in automagically
|
|
|
225 # return { get => sub { shift->model} }
|
|
|
226 },
|
|
|
227 post_only => {
|
|
|
228 get => undef, # remove GET verb implicitly
|
|
|
229 post => sub {
|
|
|
230 my ($this) = @_;
|
|
|
231 }
|
|
|
232 }
|
|
|
233 }
|
|
|
234 );
|
|
|
235
|
|
|
236 =end code
|
|
|
237
|
|
|
238 Альтернативный вариант для создания класса ресурса.
|
|
|
239
|
|
|
240 =begin code
|
|
|
241
|
|
|
242 package MyResource;
|
|
|
243
|
|
|
244 use IMPL::declare {
|
|
|
245 require => {
|
|
|
246 ForbiddenException => 'IMPL::Web::ForbiddenException'
|
|
|
247 },
|
|
|
248 base => [
|
|
|
249 'IMPL::Web::Application::Resource' => '@_'
|
|
|
250 ]
|
|
|
251 };
|
|
|
252
|
|
|
253 sub ds {
|
|
|
254 my ($this) = @_;
|
|
|
255
|
|
|
256 $this->context->{ds} ||= $this->application->ConnectDb();
|
|
|
257 }
|
|
|
258
|
|
|
259 sub InvokeHttpVerb {
|
|
|
260 my $this = shift;
|
|
|
261
|
|
|
262 $this->ds->Begin();
|
|
|
263
|
|
|
264 my $result = $this->next::method(@_);
|
|
|
265
|
|
|
266 # in case of error the data context will be disposed and the transaction
|
|
|
267 # will be reverted
|
|
|
268 $this->ds->Commit();
|
|
|
269
|
|
|
270 return $result;
|
|
|
271 }
|
|
|
272
|
|
|
273 # this method is inherited by default
|
|
|
274 # sub HttpGet {
|
|
|
275 # shift->model
|
|
|
276 #
|
|
|
277 # }
|
|
|
278
|
|
|
279 sub HttpPost {
|
|
|
280 my ($this) = @_;
|
|
|
281
|
|
|
282 my %data = map {
|
|
|
283 $_,
|
|
|
284 $this->request->param($_)
|
|
|
285 } qw(name description value);
|
|
|
286
|
|
|
287 die ForbiddenException->new("The item with the scpecified name can't be created'")
|
|
|
288 if(not $data{name} or $this->ds->items->find({ name => $data{name}))
|
|
|
289
|
|
|
290 $this->ds->items->insert(\%data);
|
|
|
291
|
|
|
292 return $this->NoContent();
|
|
|
293 }
|
|
|
294
|
|
|
295 sub Fetch {
|
|
|
296 my ($this,$childId) = @_;
|
|
|
297
|
|
|
298 my $item = $this->ds->items->find({name => $childId})
|
|
|
299 or die NotFoundException->new();
|
|
|
300
|
|
|
301 # return parameters for the child resource
|
|
|
302 return { model => $item, role => "item food" };
|
|
|
303 }
|
|
|
304
|
|
|
305 =end code
|
|
|
306
|
|
374
|
307 =head1 MEMBERS
|
|
|
308
|
|
375
|
309 =head2 C<[get,set]verbs>
|
|
|
310
|
|
|
311 Хеш с C<HTTP> методами. При попытке вызова C<HTTP> метода, которого нет в этом
|
|
|
312 хеше приводит к исключению C<IMPL::Web::NotAllowedException>.
|
|
|
313
|
|
|
314 =head2 C<[get,set]access>
|
|
|
315
|
|
|
316 Метод для проверки прав доступа. Если не задан, то доспуп возможен для всех.
|
|
|
317
|
|
|
318 =head2 C<[get,set]children>
|
|
|
319
|
|
|
320 Дочерние ресурсы. Дочерние ресурсы могут быть описаны либо в виде хеша, либо
|
|
|
321 в виде метода.
|
|
|
322
|
|
|
323 =head3 C<HASH>
|
|
|
324
|
|
|
325 Данный хещ содержит в себе таблицу идентификаторов дочерних ресурсов и их
|
|
|
326 описаний.
|
|
|
327
|
|
|
328 Описание каждого ресурса представляет собой либо функцию, либо параметры для
|
|
|
329 создания ресурса C<CraeteChildResource>. Если описание в виде функции, то она
|
|
|
330 должна возвращать либо объект типа ресурс либо параметры для его создания.
|
|
|
331
|
|
|
332 =head3 C<CODE>
|
|
|
333
|
|
|
334 Если дочерние ресурсы описаны в виде функции (возможно использовать имя метода
|
|
|
335 класса текущего ресурса), то для получения дочернего ресурса будет вызвана
|
|
|
336 функция с параметрами C<($this,$childId)>, где C<$this> - текущий ресурс,
|
|
|
337 C<$childId> - идентификатор дочернего ресурса, который нужно вернуть.
|
|
|
338
|
|
|
339 Данная функция должна возвратить либо объект типа ресурс, либо ссылку на хеш с
|
|
|
340 параметрами для создания оного при помощи метода
|
|
|
341 C<CreateChildResource($params,$childId)>.
|
|
|
342
|
|
374
|
343 =head2 C<[virtual]Fetch($childId)>
|
|
|
344
|
|
|
345 Метод для получения дочернего ресурса.
|
|
|
346
|
|
|
347 Возвращает параметры для создания дочернего ресурса, либо уже созданный ресурс.
|
|
|
348 Создание дочернего ресурса происходит при помощи метода C<CreateChildResource()>
|
|
|
349 который добавляет недостающие параметры к возвращенным в данным методом и
|
|
|
350 создает новый ресурс
|
|
|
351
|
|
375
|
352 =head2 C<CreateChildResource($params,$id)>
|
|
|
353
|
|
|
354 Создает новый дочерний ресурс с указанным идентификатором и параметрами.
|
|
|
355 Автоматически заполняет параметры
|
|
|
356
|
|
|
357 =over
|
|
|
358
|
|
|
359 =item * C<parent>
|
|
|
360
|
|
|
361 =item * C<id>
|
|
|
362
|
|
|
363 =item * C<request>
|
|
|
364
|
|
|
365 =back
|
|
|
366
|
|
|
367 Тип создаваемого ресурса C<IMPL::Web::Application::Resource>, либо указывается
|
|
|
368 в параметре C<class>.
|
|
|
369
|
|
|
370 =head2 C<[virtual]HttpGet()>
|
|
|
371
|
|
|
372 Реализует C<HTTP> метод C<GET>. По-умолчанию возвращает модель.
|
|
|
373
|
|
|
374 Данный метод нужен для того, чтобы ресурс по-умолчанию поддерживал метод C<GET>,
|
|
|
375 что является самым частым случаем, если нужно изменить данное поведение, нужно:
|
|
|
376
|
|
|
377 =over
|
|
|
378
|
|
|
379 =item * Передать в параметр конструктора C<get> значение undef
|
|
|
380
|
|
|
381 =item * Переопределить метод C<HttpGet>
|
|
|
382
|
|
|
383 =item * При проверке прав доступа выдать исключение
|
|
|
384
|
|
|
385 =back
|
|
374
|
386
|
|
373
|
387 =cut
|
|
|
388
|
