Commit | Line | Data |
0ba6e8aa |
1 | package Catalyst::Script::Server; |
2 | |
53b08cf9 |
3 | BEGIN { |
4 | $ENV{CATALYST_ENGINE} ||= 'HTTP'; |
53b08cf9 |
5 | require Catalyst::Engine::HTTP; |
6 | } |
5b923b0b |
7 | |
a3ca4468 |
8 | use Moose; |
883c37ef |
9 | use MooseX::Types::Common::Numeric qw/PositiveInt/; |
880d1f8b |
10 | use MooseX::Types::Moose qw/ArrayRef Str Bool Int RegexpRef/; |
b89d8b98 |
11 | use Catalyst::Utils; |
59804176 |
12 | use namespace::autoclean; |
a3ca4468 |
13 | |
d3082fac |
14 | with 'Catalyst::ScriptRole'; |
a3ca4468 |
15 | |
f59a9d1b |
16 | has debug => ( |
4387c692 |
17 | traits => [qw(Getopt)], |
18 | cmd_aliases => 'd', |
19 | isa => Bool, |
20 | is => 'ro', |
d3082fac |
21 | documentation => q{Force debug mode}, |
e46bf32c |
22 | ); |
23 | |
57dc50b0 |
24 | has host => ( |
4387c692 |
25 | traits => [qw(Getopt)], |
26 | cmd_aliases => 'h', |
27 | isa => Str, |
28 | is => 'ro', |
b1bfeea6 |
29 | # N.B. undef (the default) means we bind on all interfaces on the host. |
3bd410a9 |
30 | documentation => 'Specify a hostname or IP on this host for the server to bind to', |
41b55019 |
31 | ); |
90b481b1 |
32 | |
57dc50b0 |
33 | has fork => ( |
4387c692 |
34 | traits => [qw(Getopt)], |
35 | cmd_aliases => 'f', |
36 | isa => Bool, |
37 | is => 'ro', |
38 | default => 0, |
53c6ec79 |
39 | documentation => 'Fork the server to be able to serve multiple requests at once', |
90b481b1 |
40 | ); |
41 | |
bc6fa9fc |
42 | has port => ( |
4387c692 |
43 | traits => [qw(Getopt)], |
44 | cmd_aliases => 'p', |
883c37ef |
45 | isa => PositiveInt, |
4387c692 |
46 | is => 'ro', |
b89d8b98 |
47 | default => sub { |
56eb9db4 |
48 | Catalyst::Utils::env_value(shift->application_name, 'port') || 3000 |
b89d8b98 |
49 | }, |
53c6ec79 |
50 | documentation => 'Specify a different listening port (to the default port 3000)', |
204c6935 |
51 | ); |
52 | |
57dc50b0 |
53 | has pidfile => ( |
4387c692 |
54 | traits => [qw(Getopt)], |
55 | cmd_aliases => 'pid', |
56 | isa => Str, |
57 | is => 'ro', |
d3082fac |
58 | documentation => 'Specify a pidfile', |
41b55019 |
59 | ); |
60 | |
57dc50b0 |
61 | has keepalive => ( |
4387c692 |
62 | traits => [qw(Getopt)], |
63 | cmd_aliases => 'k', |
64 | isa => Bool, |
65 | is => 'ro', |
66 | default => 0, |
53c6ec79 |
67 | documentation => 'Support keepalive', |
bd31e11f |
68 | ); |
69 | |
57dc50b0 |
70 | has background => ( |
4387c692 |
71 | traits => [qw(Getopt)], |
72 | cmd_aliases => 'bg', |
73 | isa => Bool, |
74 | is => 'ro', |
75 | default => 0, |
d3082fac |
76 | documentation => 'Run in the background', |
57dc50b0 |
77 | ); |
4b3881d4 |
78 | |
8f01ed5f |
79 | has restart => ( |
4387c692 |
80 | traits => [qw(Getopt)], |
81 | cmd_aliases => 'r', |
82 | isa => Bool, |
83 | is => 'ro', |
56eb9db4 |
84 | default => sub { |
85 | Catalyst::Utils::env_value(shift->application_name, 'reload') || 0; |
86 | }, |
53c6ec79 |
87 | documentation => 'use Catalyst::Restarter to detect code changes and restart the application', |
57dc50b0 |
88 | ); |
a7dea640 |
89 | |
90 | has restart_directory => ( |
4387c692 |
91 | traits => [qw(Getopt)], |
1c517146 |
92 | cmd_aliases => [ 'rdir', 'restartdirectory' ], |
4387c692 |
93 | isa => ArrayRef[Str], |
94 | is => 'ro', |
d3082fac |
95 | documentation => 'Restarter directory to watch', |
4387c692 |
96 | predicate => '_has_restart_directory', |
8f01ed5f |
97 | ); |
98 | |
57dc50b0 |
99 | has restart_delay => ( |
4387c692 |
100 | traits => [qw(Getopt)], |
101 | cmd_aliases => 'rd', |
102 | isa => Int, |
103 | is => 'ro', |
d3082fac |
104 | documentation => 'Set a restart delay', |
4387c692 |
105 | predicate => '_has_restart_delay', |
70871584 |
106 | ); |
107 | |
880d1f8b |
108 | { |
109 | use Moose::Util::TypeConstraints; |
110 | |
111 | my $tc = subtype as RegexpRef; |
112 | coerce $tc, from Str, via { qr/$_/ }; |
113 | |
114 | MooseX::Getopt::OptionTypeMap->add_option_type_to_map($tc => '=s'); |
115 | |
116 | has restart_regex => ( |
4387c692 |
117 | traits => [qw(Getopt)], |
118 | cmd_aliases => 'rr', |
119 | isa => $tc, |
120 | coerce => 1, |
121 | is => 'ro', |
880d1f8b |
122 | documentation => 'Restart regex', |
4387c692 |
123 | predicate => '_has_restart_regex', |
880d1f8b |
124 | ); |
125 | } |
ee7aabd6 |
126 | |
57dc50b0 |
127 | has follow_symlinks => ( |
4387c692 |
128 | traits => [qw(Getopt)], |
129 | cmd_aliases => 'sym', |
130 | isa => Bool, |
131 | is => 'ro', |
132 | default => 0, |
d3082fac |
133 | documentation => 'Follow symbolic links', |
4387c692 |
134 | predicate => '_has_follow_symlinks', |
bbd42ac8 |
135 | ); |
a3ca4468 |
136 | |
3453b929 |
137 | sub _restarter_args { |
138 | my $self = shift; |
34be7d45 |
139 | |
10255473 |
140 | return ( |
34be7d45 |
141 | argv => $self->ARGV, |
142 | start_sub => sub { $self->_run_application }, |
143 | ($self->_has_follow_symlinks ? (follow_symlinks => $self->follow_symlinks) : ()), |
144 | ($self->_has_restart_delay ? (sleep_interval => $self->restart_delay) : ()), |
145 | ($self->_has_restart_directory ? (directories => $self->restart_directory) : ()), |
880d1f8b |
146 | ($self->_has_restart_regex ? (filter => $self->restart_regex) : ()), |
34be7d45 |
147 | ); |
3453b929 |
148 | } |
149 | |
a3ca4468 |
150 | sub run { |
3453b929 |
151 | my $self = shift; |
57dc50b0 |
152 | |
53c6ec79 |
153 | local $ENV{CATALYST_DEBUG} = 1 |
154 | if $self->debug; |
abee32cb |
155 | |
a7dea640 |
156 | if ( $self->restart ) { |
157 | die "Cannot run in the background and also watch for changed files.\n" |
158 | if $self->background; |
159 | |
53c6ec79 |
160 | # If we load this here, then in the case of a restarter, it does not |
161 | # need to be reloaded for each restart. |
162 | require Catalyst; |
163 | |
164 | # If this isn't done, then the Catalyst::Devel tests for the restarter |
165 | # fail. |
166 | $| = 1 if $ENV{HARNESS_ACTIVE}; |
167 | |
a7dea640 |
168 | require Catalyst::Restarter; |
169 | |
170 | my $subclass = Catalyst::Restarter->pick_subclass; |
171 | |
a7dea640 |
172 | my $restarter = $subclass->new( |
3453b929 |
173 | $self->_restarter_args() |
a7dea640 |
174 | ); |
175 | |
176 | $restarter->run_and_watch; |
177 | } |
178 | else { |
d3082fac |
179 | $self->_run_application; |
a7dea640 |
180 | } |
181 | |
182 | |
57dc50b0 |
183 | } |
184 | |
d3082fac |
185 | sub _application_args { |
a7dea640 |
186 | my ($self) = shift; |
d3082fac |
187 | return ( |
bc6fa9fc |
188 | $self->port, |
d3082fac |
189 | $self->host, |
57dc50b0 |
190 | { |
30b70903 |
191 | argv => $self->ARGV, |
d3082fac |
192 | map { $_ => $self->$_ } qw/ |
193 | fork |
194 | keepalive |
195 | background |
196 | pidfile |
197 | keepalive |
198 | follow_symlinks |
199 | /, |
200 | }, |
a3ca4468 |
201 | ); |
a3ca4468 |
202 | } |
5b923b0b |
203 | |
2e81e132 |
204 | __PACKAGE__->meta->make_immutable; |
5b923b0b |
205 | |
0ba6e8aa |
206 | 1; |
e46bf32c |
207 | |
208 | =head1 NAME |
209 | |
cbaaecc0 |
210 | Catalyst::Script::Server - Catalyst test server |
e46bf32c |
211 | |
212 | =head1 SYNOPSIS |
213 | |
cbaaecc0 |
214 | myapp_server.pl [options] |
e46bf32c |
215 | |
216 | Options: |
4b3881d4 |
217 | -d --debug force debug mode |
218 | -f --fork handle each request in a new process |
e46bf32c |
219 | (defaults to false) |
3dcfb4c8 |
220 | --help display this help and exits |
221 | -h --host host (defaults to all) |
4b3881d4 |
222 | -p --port port (defaults to 3000) |
223 | -k --keepalive enable keep-alive connections |
224 | -r --restart restart when files get modified |
225 | (defaults to false) |
87f5a448 |
226 | --rd --restart_delay delay between file checks |
e46bf32c |
227 | (ignored if you have Linux::Inotify2 installed) |
87f5a448 |
228 | --rr --restart_regex regex match files that trigger |
e46bf32c |
229 | a restart when modified |
230 | (defaults to '\.yml$|\.yaml$|\.conf|\.pm$') |
87f5a448 |
231 | --rdir --restart_directory the directory to search for |
6ab9f4af |
232 | modified files, can be set multiple times |
e46bf32c |
233 | (defaults to '[SCRIPT_DIR]/..') |
4b3881d4 |
234 | --sym --follow_symlinks follow symlinks in search directories |
e46bf32c |
235 | (defaults to false. this is a no-op on Win32) |
4b3881d4 |
236 | --bg --background run the process in the background |
237 | --pid --pidfile specify filename for pid file |
e46bf32c |
238 | |
239 | See also: |
240 | perldoc Catalyst::Manual |
241 | perldoc Catalyst::Manual::Intro |
242 | |
243 | =head1 DESCRIPTION |
244 | |
cbaaecc0 |
245 | Run a Catalyst test server for this application. |
e46bf32c |
246 | |
247 | =head1 AUTHORS |
248 | |
249 | Catalyst Contributors, see Catalyst.pm |
250 | |
251 | =head1 COPYRIGHT |
252 | |
253 | This library is free software. You can redistribute it and/or modify |
254 | it under the same terms as Perl itself. |
255 | |
256 | =cut |