pub/Impl: Lib/IMPL/Web/Handler/RestController.pm annotate

annotate Lib/IMPL/Web/Handler/RestController.pm @ 404:9ef75f2029be default

sync

author	cin
date	Fri, 28 Aug 2015 19:54:53 +0300
parents	16ff604298c7
children

rev	line source
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	1 package IMPL::Web::Handler::RestController;
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	2 use strict;
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	3
233 3cebcf6fdb9b refactoring, cleaning code sergey parents: 230 diff changeset	4 use IMPL::Const qw(:prop);
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	5 use IMPL::declare {
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	6 require => {
244 a02b110da931 refactoring sergey parents: 233 diff changeset	7 Locator => 'IMPL::Web::AutoLocator',
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	8 ResourceInterface => 'IMPL::Web::Application::ResourceInterface',
199 e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	9 Exception => 'IMPL::Exception',
e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	10 ArgumentExecption => '-IMPL::InvalidArgumentException',
401 16ff604298c7 minor fixes cin parents: 334 diff changeset	11 NotFoundException => 'IMPL::Web::NotFoundException',
16ff604298c7 minor fixes cin parents: 334 diff changeset	12 Loader => 'IMPL::Code::Loader'
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	13 },
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	14 base => {
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	15 'IMPL::Object' => undef,
198 2ffe6f661605 Implemented IMPL::Web::Handler::RestController cin parents: 197 diff changeset	16 'IMPL::Object::Autofill' => '@_',
2ffe6f661605 Implemented IMPL::Web::Handler::RestController cin parents: 197 diff changeset	17 'IMPL::Object::Serializable' => undef
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	18 },
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	19 props => [
244 a02b110da931 refactoring sergey parents: 233 diff changeset	20 resourceFactory => PROP_RO,
233 3cebcf6fdb9b refactoring, cleaning code sergey parents: 230 diff changeset	21 trailingSlash => PROP_RO
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	22 ]
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	23 };
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	24
199 e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	25 sub CTOR {
e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	26 my ($this) = @_;
e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	27
244 a02b110da931 refactoring sergey parents: 233 diff changeset	28 die ArgumentException->new(resourceFactory => "A web-resource is required")
a02b110da931 refactoring sergey parents: 233 diff changeset	29 unless $this->resourceFactory;
a02b110da931 refactoring sergey parents: 233 diff changeset	30 #unless eval { $this->resourceFacotry->isa(ResourceInterface) };
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	31
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	32 }
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	33
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	34 sub GetResourcePath {
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	35 my ($this,$action) = @_;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	36
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	37 my $pathInfo = $action->pathInfo;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	38 my @segments;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	39
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	40 if (length $pathInfo) {
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	41
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	42 @segments = split(/\//, $pathInfo, $this->trailingSlash ? -1 : 0);
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	43
230 6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	44 # remove first segment if it is empty
6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	45 shift @segments if @segments && length($segments[0]) == 0;
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	46 }
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	47
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	48 return @segments;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	49 }
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	50
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	51
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	52 sub Invoke {
332 04a093f0a5a6 IMPL::Web::Application refactoring: resources are created per client request cin parents: 268 diff changeset	53 my ($this,$request) = @_;
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	54
332 04a093f0a5a6 IMPL::Web::Application refactoring: resources are created per client request cin parents: 268 diff changeset	55 my $method = $request->requestMethod;
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	56
332 04a093f0a5a6 IMPL::Web::Application refactoring: resources are created per client request cin parents: 268 diff changeset	57 my @segments = $this->GetResourcePath($request);
198 2ffe6f661605 Implemented IMPL::Web::Handler::RestController cin parents: 197 diff changeset	58
401 16ff604298c7 minor fixes cin parents: 334 diff changeset	59 my $factory = $this->resourceFactory;
16ff604298c7 minor fixes cin parents: 334 diff changeset	60
16ff604298c7 minor fixes cin parents: 334 diff changeset	61 $factory = Loader->default->Require($factory)
16ff604298c7 minor fixes cin parents: 334 diff changeset	62 unless ref($factory) \|\| eval { $factory->can('new') };
16ff604298c7 minor fixes cin parents: 334 diff changeset	63
16ff604298c7 minor fixes cin parents: 334 diff changeset	64 my $res = $factory->new(
244 a02b110da931 refactoring sergey parents: 233 diff changeset	65 id => 'root',
332 04a093f0a5a6 IMPL::Web::Application refactoring: resources are created per client request cin parents: 268 diff changeset	66 request => $request,
04a093f0a5a6 IMPL::Web::Application refactoring: resources are created per client request cin parents: 268 diff changeset	67 location => Locator->new(base => $request->application->baseUrl),
244 a02b110da931 refactoring sergey parents: 233 diff changeset	68 );
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	69
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	70 while(@segments) {
256 32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	71 my $id = shift @segments;
32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	72 $res = $res->FetchChildResource($id);
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	73 }
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	74
332 04a093f0a5a6 IMPL::Web::Application refactoring: resources are created per client request cin parents: 268 diff changeset	75 $res = $res->InvokeHttpVerb($method);
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	76 }
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	77
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	78 1;
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	79
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	80 __END__
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	81
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	82 =pod
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	83
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	84 =head1 NAME
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	85
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	86 C<IMPL::Web::Handler::RestController> - Обрабатывает C<HTTP> запрос передавая
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	87 его соответствующему ресурсу.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	88
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	89 =head1 SYNOPSIS
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	90
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	91 Используется в конфигурации приложения как элемент цепочки обработчиков.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	92 Как правило располагается на самом верхнем уровне.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	93
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	94 =begin code xml
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	95
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	96 <handlers type="ARRAY">
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	97 <item type="IMPL::Web::Handler::RestController">
334 71221d79e6b4 removing web resources contracts cin parents: 332 diff changeset	98 <resourceFactory>My::App::Web::RootResource</resourceFactory>
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	99 </item>
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	100 <item type="IMPL::Web::Handler::JSONView" />
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	101 <item type="IMPL::Web::Handler::SecureCookie" />
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	102 <item type="IMPL::Web::Handler::ErrorHandler" />
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	103 </handlers>
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	104
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	105 =end code xml
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	106
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	107
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	108 =head1 DESCRIPTION
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	109
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	110 Использует C<PATH_INFO> для определения нужного ресурса, затем предает
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	111 найденному ресурсу управление для обработки запроса.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	112
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	113 Если ресурс не найден, то возникает исключение C<IMPL::Web::NotFoundException>.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	114
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	115 Для определения нужного ресурса контроллер разбивает C<PATH_INFO> на фрагменты
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	116 и использует каждый фрагмент для получения дочернего ресурса начиная с корневого.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	117 Для чего используется метод
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	118 C<< IMPL::Web::Application::ResourceInterface->FetchChildResource($childId) >>.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	119
268 4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	120 Дерево ресурсов сущестувет независимо от обрабатываемого запроса, однако оно
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	121 может полностью или частично загружаться в начале обработки запроса и
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	122 освобождаться по окончании обработки запроса. Поэтому при получении дочерних
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	123 ресурсов не участвует C<HTTP> запрос, он адресуется только последнему ресурсу.
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	124
256 32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	125 =begin text
32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	126
32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	127 /music/audio.mp3 -> ['music','audio.mp3']
32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	128
32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	129 =end text
32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	130
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	131 =head1 MEMEBERS
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	132
256 32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	133 =head2 C<[get]resourceFactory>
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	134
256 32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	135 Фабрика для создания корневого ресурса приложения, полученный ресурс должен
32aceba4ee6d corrected ViewHandlers to handle cookies and headers. sergey parents: 255 diff changeset	136 реализовывать интерфейс C<IMPL::Web::Application::ResourceInterface>.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	137
268 4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	138 Фабрика может сохранять ссылку на корневой ресурс и каждый раз не создавать
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	139 его, а возвращать уже существующий. Это вполне оправдано, если хранение
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	140 дерева ресурсов требует меньше ресурсов, чем его создание и при этом приложение
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	141 остается в памяти между C<HTTP> запросами.
4abda21186cd refactoring IMPL::Web: added 'application' property to resources cin* parents: 256 diff changeset	142
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	143 =head2 C<[get]trailingSlash>
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	144
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	145 Если данная переменная имеет значение C<true>, то слеш в конце пути к ресурсу
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	146 будет интерпретироваться, как дочерний ресурс с пустым идентификатором.
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	147
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	148 =cut

Mercurial > pub > Impl

annotate Lib/IMPL/Web/Handler/RestController.pm @ 404:9ef75f2029be default