annotate Lib/IMPL/Web/Application.pm @ 78:a5cb84374d40

TT::Control in work
author wizard
date Fri, 02 Apr 2010 20:19:17 +0400
parents 2f31ecabe9ea
children 964587c5183c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
1 package IMPL::Web::Application;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
2 use strict;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
3 use warnings;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
4
60
b0c068da93ac Lazy activation for the configuration objects (final concept)
wizard
parents: 59
diff changeset
5 use base qw(IMPL::Config IMPL::Object::Singleton);
58
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
6
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
7 require IMPL::Web::Application::Action;
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
8 require IMPL::Web::Application::Response;
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
9
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
10 use IMPL::Class::Property;
57
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
11 use CGI;
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
12
60
b0c068da93ac Lazy activation for the configuration objects (final concept)
wizard
parents: 59
diff changeset
13 __PACKAGE__->PassThroughArgs;
b0c068da93ac Lazy activation for the configuration objects (final concept)
wizard
parents: 59
diff changeset
14
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
15 BEGIN {
52
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
16 public property handlerError => prop_all;
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
17 public property actionFactory => prop_all;
59
0f3e369553bd Rewritten property implementation (probably become slower but more flexible)
wizard
parents: 58
diff changeset
18 public property handlersQuery => prop_all | prop_list;
65
2840c4c85db8 Application configuration improvements
wizard
parents: 63
diff changeset
19 public property responseCharset => prop_all;
73
wizard
parents: 67
diff changeset
20 public property security => prop_all;
63
76b878ad6596 Added serialization support for the IMPL::Object::List
wizard
parents: 62
diff changeset
21 public property options => prop_all;
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
22 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
23
62
c64bd1bf727d Web application
wizard
parents: 60
diff changeset
24 sub CTOR {
c64bd1bf727d Web application
wizard
parents: 60
diff changeset
25 my ($this) = @_;
c64bd1bf727d Web application
wizard
parents: 60
diff changeset
26
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
27 $this->actionFactory('IMPL::Web::Application::Action') unless $this->actionFactory;
65
2840c4c85db8 Application configuration improvements
wizard
parents: 63
diff changeset
28 $this->responseCharset('utf-8') unless $this->responseCharset;
62
c64bd1bf727d Web application
wizard
parents: 60
diff changeset
29 }
c64bd1bf727d Web application
wizard
parents: 60
diff changeset
30
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
31 sub Run {
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
32 my ($this) = @_;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
33
58
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
34 while (my $query = $this->FetchRequest()) {
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
35
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
36 my $action = $this->actionFactory->new(
62
c64bd1bf727d Web application
wizard
parents: 60
diff changeset
37 query => $query,
58
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
38 application => $this,
65
2840c4c85db8 Application configuration improvements
wizard
parents: 63
diff changeset
39 );
2840c4c85db8 Application configuration improvements
wizard
parents: 63
diff changeset
40
2840c4c85db8 Application configuration improvements
wizard
parents: 63
diff changeset
41 $action->response->charset($this->responseCharset);
58
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
42
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
43 $action->ChainHandler($_) foreach $this->handlersQuery;
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
44
a35b60b16a99 Configuration, late activation
wizard
parents: 57
diff changeset
45 $action->Invoke();
63
76b878ad6596 Added serialization support for the IMPL::Object::List
wizard
parents: 62
diff changeset
46
76b878ad6596 Added serialization support for the IMPL::Object::List
wizard
parents: 62
diff changeset
47 $action->response->Complete;
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
48 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
49 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
50
57
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
51 {
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
52 my $hasFetched = 0;
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
53
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
54 sub FetchRequest {
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
55 return undef if $hasFetched;
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
56 $hasFetched = 1;
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
57 return CGI->new();
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
58 }
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
59 }
bf59ee1cd506 Web application main class functionality
wizard
parents: 52
diff changeset
60
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
61 1;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
62
52
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
63 __END__
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
64
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
65 =pod
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
66
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
67 =head1 SYNOPSIS
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
68
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
69 =begin code
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
70
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
71 require MyApp;
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
72
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
73 my $instance = spawn MyApp('app.config');
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
74
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
75 $instance->Run();
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
76
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
77 =end code
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
78
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
79 =head1 DESCRIPTION
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
80
73
wizard
parents: 67
diff changeset
81 C< use base qw( IMPL::Config IMPL::Object::Singleton )>
wizard
parents: 67
diff changeset
82
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
83 Зкземпляр приложения содержит в себе глобальные настройки, реализует контроллер запросов,
52
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
84 в качестве источника запросов используется CGI или иной совместимый модуль.
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
85
52
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
86 Процесс обработки запроса состоит из следующих частей
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
87
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
88 =over
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
89
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
90 =item 1
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
91
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
92 Получение cgi запроса
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
93
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
94 =item 2
52
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
95
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
96 Создание объекта C<IMPL::Web::Application::Action>
52
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
97
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
98 =item 3
52
15d720913562 security in work
wizard@linux-odin.local
parents: 49
diff changeset
99
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
100 Формирование цепочки вызовов при помощи C<< IMPL::Web::Application::Action->ChainHandler >>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
101
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
102 =item 4
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
103
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
104 Выполнение запроса C<< IMPL::Web::Application::Action->Invoke >>
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
105
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 47
diff changeset
106 =cut
67
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
107
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
108 Также приложение поддерживает отложенное создание объектов, которые по первому обращению
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
109 к свойствам. Это реализовано в базовом классе C< IMPL::Configuration >. Для настройки
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
110 активаторов можно использовать свойство C<options>, в которое должен быть помещен хеш
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
111 со ссылками на активаторы, см. пример ниже C<CONFIGURATION>.
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
112
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
113 =head2 CONFIGURATION
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
114
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
115 Ниже приведен пример конфигурации приложения
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
116
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
117 =begin code xml
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
118
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
119 <?xml version="1.0" encoding="UTF-8"?>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
120 <Application id='app' type="Test::Web::Application::Instance">
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
121
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
122 <!-- Begin custom properties -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
123 <name>Sample application</name>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
124 <dataSource type='IMPL::Config::Activator' id='ds'>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
125 <factory>IMPL::Object</factory>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
126 <parameters type='HASH'>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
127 <db>data</db>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
128 <user>nobody</user>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
129 </parameters>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
130 </dataSource>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
131 <securityMod type='IMPL::Config::Activator'>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
132 <factory>IMPL::Object</factory>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
133 <parameters type='HASH'>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
134 <ds refid='ds'/>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
135 </parameters>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
136 </securityMod>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
137 <!-- End custom properties -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
138
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
139 <!-- direct access to the activators -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
140 <options type="HASH">
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
141 <dataSource refid='ds'/>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
142 </options>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
143
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
144 <!-- Set default output encoding, can be changed due query handling -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
145 <responseCharset>utf-8</responseCharset>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
146
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
147 <!-- Actions creation configuration -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
148 <actionFactory type="IMPL::Object::Factory">
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
149
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
150 <!-- Construct actions -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
151 <factory>IMPL::Web::Application::Action</factory>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
152 <parameters type='HASH'>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
153
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
154 <!-- with special responseFactory -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
155 <responseFactory type='IMPL::Object::Factory'>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
156
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
157 <!-- Where resopnses have a special streamOut -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
158 <factory>IMPL::Web::Application::Response</factory>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
159 <parameters type='HASH'>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
160
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
161 <!-- in memory dummy output instead of STDOUT -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
162 <streamOut>memory</streamOut>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
163
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
164 </parameters>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
165 </responseFactory>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
166 </parameters>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
167 </actionFactory>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
168
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
169 <!-- Query processing chain -->
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
170 <handlersQuery type="IMPL::Object::List">
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
171 <item type="IMPL::Web::QueryHandler::PageFormat">
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
172 <templatesCharset>cp1251</templatesCharset>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
173 </item>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
174 </handlersQuery>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
175 </Application>
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
176
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
177 =end code xml
9f5795a10939 Documentation, minor fixes
wizard
parents: 65
diff changeset
178
73
wizard
parents: 67
diff changeset
179 =head1 MEMBERS
wizard
parents: 67
diff changeset
180
wizard
parents: 67
diff changeset
181 =over
wizard
parents: 67
diff changeset
182
wizard
parents: 67
diff changeset
183 =item C<[get,set] handlerError>
wizard
parents: 67
diff changeset
184
wizard
parents: 67
diff changeset
185 Обработчик который будет вызван в случае возникновения необработанной ошибки
wizard
parents: 67
diff changeset
186 в процессе работы приложения. После чего приложение корректно завершается.
wizard
parents: 67
diff changeset
187
wizard
parents: 67
diff changeset
188 =item C<[get,set] actionFactory>
wizard
parents: 67
diff changeset
189
wizard
parents: 67
diff changeset
190 Фабрика объектов, которая используется приложением, для создания объектов
wizard
parents: 67
diff changeset
191 типа C<IMPL::Web::Application::Action> при обработки C<CGI> запросов.
wizard
parents: 67
diff changeset
192
wizard
parents: 67
diff changeset
193 =begin code
wizard
parents: 67
diff changeset
194
wizard
parents: 67
diff changeset
195 my $action = $this->actionFactory->new(
wizard
parents: 67
diff changeset
196 query => $query,
wizard
parents: 67
diff changeset
197 application => $this,
wizard
parents: 67
diff changeset
198 );
wizard
parents: 67
diff changeset
199
wizard
parents: 67
diff changeset
200 =end code
wizard
parents: 67
diff changeset
201
wizard
parents: 67
diff changeset
202 =item C< [get,set,list] handlersQuery >
wizard
parents: 67
diff changeset
203
wizard
parents: 67
diff changeset
204 Список обработчиков запросов, которые будут переданы созданному объекту-действию.
wizard
parents: 67
diff changeset
205
wizard
parents: 67
diff changeset
206 =item C< [get,set] responseCharset>
wizard
parents: 67
diff changeset
207
wizard
parents: 67
diff changeset
208 Кодировка ответа клиенту.
wizard
parents: 67
diff changeset
209
wizard
parents: 67
diff changeset
210 =item C< [get,set] security >
wizard
parents: 67
diff changeset
211
wizard
parents: 67
diff changeset
212 Объект C<IMPL::Web::Security>, для работы с инфраструктурой безопасности.
wizard
parents: 67
diff changeset
213
wizard
parents: 67
diff changeset
214 =item C< [get,set] options >
wizard
parents: 67
diff changeset
215
wizard
parents: 67
diff changeset
216 Обычно ссылка на хеш с настраиваемыми объектами, используется для возможности
wizard
parents: 67
diff changeset
217 програмной настройки активаторов, т.к. напрямую через свойства приложения получить
wizard
parents: 67
diff changeset
218 к ним доступ не получится.
wizard
parents: 67
diff changeset
219
wizard
parents: 67
diff changeset
220 =back
wizard
parents: 67
diff changeset
221
wizard
parents: 67
diff changeset
222 =cut