forked from PerlDancer/Dancer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Dancer.pm
1794 lines (1268 loc) · 47.2 KB
/
Dancer.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Dancer;
use strict;
use warnings;
use Carp;
use Cwd 'realpath';
our $VERSION = '1.3079_04';
our $AUTHORITY = 'SUKRIA';
use Dancer::App;
use Dancer::Config;
use Dancer::Cookies;
use Dancer::FileUtils;
use Dancer::GetOpt;
use Dancer::Error;
use Dancer::Hook;
use Dancer::Logger;
use Dancer::Renderer;
use Dancer::Route;
use Dancer::Serializer::JSON;
use Dancer::Serializer::YAML;
use Dancer::Serializer::XML;
use Dancer::Serializer::Dumper;
use Dancer::Session;
use Dancer::SharedData;
use Dancer::Handler;
use Dancer::MIME;
use File::Spec;
use base 'Exporter';
our @EXPORT = qw(
after
any
before
before_template
cookie
cookies
config
content_type
dance
debug
del
dirname
error
engine
false
forward
from_dumper
from_json
from_yaml
from_xml
get
halt
header
headers
hook
layout
load
load_app
logger
mime
options
param
params
pass
path
post
prefix
push_header
put
redirect
render_with_layout
request
send_file
send_error
set
setting
set_cookie
session
splat
status
start
template
to_dumper
to_json
to_yaml
to_xml
true
upload
captures
uri_for
var
vars
warning
);
# Dancer's syntax
sub after { Dancer::Hook->new('after', @_) }
sub any { Dancer::App->current->registry->any_add(@_) }
sub before { Dancer::Hook->new('before', @_) }
sub before_template { Dancer::Hook->new('before_template', @_) }
sub captures { Dancer::SharedData->request->params->{captures} }
sub cookie { Dancer::Cookies->cookie( @_ ) }
sub cookies { Dancer::Cookies->cookies }
sub config { Dancer::Config::settings() }
sub content_type { Dancer::SharedData->response->content_type(@_) }
sub dance { goto &start }
sub debug { goto &Dancer::Logger::debug }
sub del { Dancer::App->current->registry->universal_add('delete', @_) }
sub dirname { Dancer::FileUtils::dirname(@_) }
sub engine { Dancer::Engine->engine(@_) }
sub error { goto &Dancer::Logger::error }
sub false { 0 }
sub forward { Dancer::SharedData->response->forward(@_) }
sub from_dumper { Dancer::Serializer::Dumper::from_dumper(@_) }
sub from_json { Dancer::Serializer::JSON::from_json(@_) }
sub from_xml { Dancer::Serializer::XML::from_xml(@_) }
sub from_yaml { Dancer::Serializer::YAML::from_yaml(@_) }
sub get { map { my $r = $_; Dancer::App->current->registry->universal_add($r, @_) } qw(head get) }
sub halt { Dancer::SharedData->response->halt(@_) }
sub header { goto &headers }
sub push_header { Dancer::SharedData->response->push_header(@_); }
sub headers { Dancer::SharedData->response->headers(@_); }
sub hook { Dancer::Hook->new(@_) }
sub layout {
Dancer::Deprecation->deprecated(reason => "use 'set layout => \"value\"'",
version => '1.3050',
fatal => 1);
}
sub load { require $_ for @_ }
sub load_app { goto &_load_app } # goto doesn't add a call frame. So caller() will work as expected
sub logger {
Dancer::Deprecation->deprecated(reason => "use 'set logger => \"value\"'",
fatal => 1,version=>'1.3050');
}
sub mime { Dancer::MIME->instance() }
sub options { Dancer::App->current->registry->universal_add('options', @_) }
sub params { Dancer::SharedData->request->params(@_) }
sub param { params->{$_[0]} }
sub pass { Dancer::SharedData->response->pass(1) }
sub path { Dancer::FileUtils::path(@_) }
sub post { Dancer::App->current->registry->universal_add('post', @_) }
sub prefix { Dancer::App->current->set_prefix(@_) }
sub put { Dancer::App->current->registry->universal_add('put', @_) }
sub redirect { goto &_redirect }
sub render_with_layout { Dancer::Template::Abstract->_render_with_layout(@_) }
sub request { Dancer::SharedData->request }
sub send_error { Dancer::Error->new(message => $_[0], code => $_[1] || 500)->render() }
sub send_file { goto &_send_file }
sub set { goto &setting }
sub set_cookie { Dancer::Cookies->set_cookie(@_) }
sub setting { Dancer::App->applications ? Dancer::App->current->setting(@_) : Dancer::Config::setting(@_) }
sub session { goto &_session }
sub splat { @{ Dancer::SharedData->request->params->{splat} || [] } }
sub start { goto &_start }
sub status { Dancer::SharedData->response->status(@_) }
sub template { Dancer::Template::Abstract->template(@_) }
sub to_dumper { Dancer::Serializer::Dumper::to_dumper(@_) }
sub to_json { Dancer::Serializer::JSON::to_json(@_) }
sub to_xml { Dancer::Serializer::XML::to_xml(@_) }
sub to_yaml { Dancer::Serializer::YAML::to_yaml(@_) }
sub true { 1 }
sub upload { Dancer::SharedData->request->upload(@_) }
sub uri_for { Dancer::SharedData->request->uri_for(@_) }
sub var { Dancer::SharedData->var(@_) }
sub vars { Dancer::SharedData->vars }
sub warning { goto &Dancer::Logger::warning }
# When importing the package, strict and warnings pragma are loaded,
# and the appdir detection is performed.
sub import {
my ($class, @args) = @_;
my ($package, $script) = caller;
strict->import;
utf8->import;
my @final_args;
my $syntax_only = 0;
my $as_script = 0;
foreach (@args) {
if ( $_ eq ':moose' ) {
push @final_args, '!before', '!after';
}
elsif ( $_ eq ':tests' ) {
push @final_args, '!pass';
}
elsif ( $_ eq ':syntax' ) {
$syntax_only = 1;
}
elsif ($_ eq ':script') {
$as_script = 1;
} else {
push @final_args, $_;
}
}
$class->export_to_level(1, $class, @final_args);
# if :syntax option exists, don't change settings
return if $syntax_only;
$as_script = 1 if $ENV{PLACK_ENV};
Dancer::GetOpt->process_args() if !$as_script;
_init_script_dir($script);
Dancer::Config->load;
}
# private code
# FIXME handle previous usage of load_app with multiple app names
sub _load_app {
my ($app_name, %options) = @_;
my $script = (caller)[1];
Dancer::Logger::core("loading application $app_name");
# set the application
my $app = Dancer::App->set_running_app($app_name);
# Application options
$app->set_app_prefix($options{prefix}) if $options{prefix};
$app->settings($options{settings}) if $options{settings};
# load the application
_init_script_dir($script);
my ($res, $error) = Dancer::ModuleLoader->load($app_name);
$res or croak "unable to load application $app_name : $error";
# restore the main application
Dancer::App->set_running_app('main');
}
sub _init_script_dir {
my ($script) = @_;
my ($script_vol, $script_dirs, $script_name) =
File::Spec->splitpath(File::Spec->rel2abs($script));
# normalize
if ( -d ( my $fulldir = File::Spec->catdir( $script_dirs, $script_name ) ) ) {
$script_dirs = $fulldir;
$script_name = '';
}
my @script_dirs = File::Spec->splitdir($script_dirs);
my $script_path;
if ($script_vol) {
$script_path = Dancer::path($script_vol, $script_dirs);
} else {
$script_path = Dancer::path($script_dirs);
}
my $LAYOUT_PRE_DANCER_1_2 = 1;
# in bin/ or public/ or t/ we need to go one level upper to find the appdir
$LAYOUT_PRE_DANCER_1_2 = 0
if ($script_dirs[$#script_dirs - 1] eq 'bin')
or ($script_dirs[$#script_dirs - 1] eq 'public')
or ($script_dirs[$#script_dirs - 1] eq 't');
my $appdir = $ENV{DANCER_APPDIR} || (
$LAYOUT_PRE_DANCER_1_2
? $script_path
: File::Spec->rel2abs(Dancer::path($script_path, '..'))
);
Dancer::setting(appdir => $appdir);
# once the dancer_appdir have been defined, we export to env
$ENV{DANCER_APPDIR} = $appdir;
Dancer::Logger::core("initializing appdir to: `$appdir'");
Dancer::setting(confdir => $ENV{DANCER_CONFDIR}
|| $appdir);
Dancer::setting(public => $ENV{DANCER_PUBLIC}
|| Dancer::FileUtils::path($appdir, 'public'));
Dancer::setting(views => $ENV{DANCER_VIEWS}
|| Dancer::FileUtils::path($appdir, 'views'));
my ($res, $error) = Dancer::ModuleLoader->use_lib(Dancer::FileUtils::path($appdir, 'lib'));
$res or croak "unable to set libdir : $error";
}
# Scheme grammar as defined in RFC 2396
# scheme = alpha *( alpha | digit | "+" | "-" | "." )
my $scheme_re = qr{ [a-z][a-z0-9\+\-\.]* }ix;
sub _redirect {
my ($destination, $status) = @_;
# RFC 2616 requires an absolute URI with a scheme,
# turn the URI into that if it needs it
if ($destination !~ m{^ $scheme_re : }x) {
my $request = Dancer::SharedData->request;
$destination = $request->uri_for($destination, {}, 1);
}
my $response = Dancer::SharedData->response;
$response->status($status || 302);
$response->headers('Location' => $destination);
}
sub _session {
engine 'session'
or croak "Must specify session engine in settings prior to using 'session' keyword";
@_ == 0 ? Dancer::Session->get
: @_ == 1 ? Dancer::Session->read(@_)
: Dancer::Session->write(@_);
}
sub _send_file {
my ($path, %options) = @_;
my $env = Dancer::SharedData->request->env;
my $request = Dancer::Request->new_for_request('GET' => $path);
Dancer::SharedData->request($request);
# if you asked for streaming but it's not supported in PSGI
if ( $options{'streaming'} && ! $env->{'psgi.streaming'} ) {
# TODO: throw a fit (AKA "exception") or a Dancer::Error (or croak)?
croak 'Sorry, streaming is not supported on this server.';
}
if (exists($options{content_type})) {
$request->content_type($options{content_type});
}
my $resp;
if (ref($path) eq "SCALAR") {
# send_data
$resp = Dancer::SharedData->response() || Dancer::Response->new();
$resp->header('Content-Type' => exists($options{content_type}) ?
$options{content_type} : Dancer::MIME->default());
$resp->content($$path);
} else {
# real send_file
if ($options{system_path} && -f $path) {
$resp = Dancer::Renderer->get_file_response_for_path($path);
} else {
$resp = Dancer::Renderer->get_file_response();
}
}
if (exists($options{filename})) {
$resp->push_header('Content-Disposition' =>
"attachment; filename=\"$options{filename}\""
);
}
if ( $options{'streaming'} ) {
# handle streaming
$resp->streamed( sub {
my ( $status, $headers ) = @_;
my %callbacks = defined $options{'callbacks'} ?
%{ $options{'callbacks'} } :
{};
return sub {
my $respond = shift;
exists $callbacks{'override'}
and return $callbacks{'override'}->( $respond, $resp );
# get respond callback and set headers, get writer in return
my $writer = $respond->( [
$status,
$headers,
] );
# get content from original response
my $content = $resp->content;
exists $callbacks{'around'}
and return $callbacks{'around'}->( $writer, $content );
if ( ref $content ) {
my $bytes = $options{'bytes'} || '43008'; # 42K (dams)
my $buf;
while ( ( my $read = sysread $content, $buf, $bytes ) != 0 ) {
if ( exists $callbacks{'around_content'} ) {
$callbacks{'around_content'}->( $writer, $buf );
} else {
$writer->write($buf);
}
}
} else {
$writer->write($content);
}
};
} );
}
return $resp if $resp;
Dancer::Error->new(
code => 404,
message => "No such file: `$path'"
)->render();
}
# Start/Run the application with the chosen apphandler
sub _start {
my ($class, $request) = @_;
Dancer::Config->load;
# Backward compatibility for app.psgi that has sub { Dancer->dance($req) }
if ($request) {
return Dancer::Handler->handle_request($request);
}
my $handler = Dancer::Handler->get_handler;
Dancer::Logger::core("loading handler '".ref($handler)."'");
return $handler->dance;
}
1;
__END__
=pod
=head1 NAME
Dancer - lightweight yet powerful web application framework
=head1 SYNOPSIS
#!/usr/bin/perl
use Dancer;
get '/hello/:name' => sub {
return "Why, hello there " . param('name');
};
dance;
The above is a basic but functional web app created with Dancer. If you want
to see more examples and get up and running quickly, check out the
L<Dancer::Introduction> and the L<Dancer::Cookbook>. For examples on
deploying your Dancer applications, see L<Dancer::Deployment>.
=head1 DESCRIPTION
Dancer is a web application framework designed to be as effortless as possible
for the developer, taking care of the boring bits as easily as possible, yet
staying out of your way and letting you get on with writing your code.
Dancer aims to provide the simplest way for writing web applications, and
offers the flexibility to scale between a very simple lightweight web service
consisting of a few lines of code in a single file, all the way up to a more
complex fully-fledged web application with session support, templates for views
and layouts, etc.
If you don't want to write CGI scripts by hand, and find Catalyst too big or
cumbersome for your project, Dancer is what you need.
Dancer has few pre-requisites, so your Dancer webapps will be easy to deploy.
Dancer apps can be used with a an embedded web server (great for easy testing),
and can run under PSGI/Plack for easy deployment in a variety of webserver
environments.
=head1 MORE DOCUMENTATION
This documentation describes all the exported symbols of Dancer. If you want
a quick start guide to discover the framework, you should look at
L<Dancer::Introduction>, or L<Dancer::Tutorial> to learn by example.
If you want to have specific examples of code for real-life problems, see the
L<Dancer::Cookbook>.
If you want to see configuration examples of different deployment solutions
involving Dancer and Plack, see L<Dancer::Deployment>.
You can find out more about the many useful plugins available for Dancer in
L<Dancer::Plugins>.
=head1 EXPORTS
By default, C<use Dancer> exports all the functions below plus sets up
your app. You can control the exporting through the normal
L<Exporter> mechanism. For example:
# Just export the route controllers
use Dancer qw(before after get post);
# Export everything but pass to avoid clashing with Test::More
use Test::More;
use Dancer qw(!pass);
There are also some special tags to control exports and behaviour.
=head2 :moose
This will export everything except functions which clash with
Moose. Currently these are C<after> and C<before>.
=head2 :syntax
This tells Dancer to just export symbols and not set up your app.
This is most useful for writing Dancer code outside of your main route
handler.
=head2 :tests
This will export everything except functions which clash with
commonly used testing modules. Currently these are C<pass>.
It can be combined with other export pragmas. For example, while testing...
use Test::More;
use Dancer qw(:syntax :tests);
# Test::Most also exports "set" and "any"
use Test::Most;
use Dancer qw(:syntax :tests !set !any);
# Alternatively, if you want to use Dancer's set and any...
use Test::Most qw(!set !any);
use Dancer qw(:syntax :tests);
=head2 :script
This will export all the keywords, and will also load the configuration.
This is useful when you want to use your Dancer application from a script.
use MyApp;
use Dancer ':script';
MyApp::schema('DBSchema')->deploy();
By default, the L<warnings> pragma will also be exported, meaning your
app/script will be running under C<use warnings>. If you do not want this, set
the L<import_warnings|Dancer::Config/import_warnings> setting to a false value.
=head1 FUNCTIONS
=head2 after
Add a hook at the B<after> position:
after sub {
my $response = shift;
# do something with request
};
The anonymous function which is given to C<after> will be executed after
having executed a route.
You can define multiple after filters, using the C<after> helper as
many times as you wish; each filter will be executed, in the order you added
them.
=head2 any
Defines a route for multiple HTTP methods at once:
any ['get', 'post'] => '/myaction' => sub {
# code
};
Or even, a route handler that would match any HTTP methods:
any '/myaction' => sub {
# code
};
=head2 before
Defines a before filter:
before sub {
# do something with request, vars or params
};
The anonymous function given to C<before> will be executed before executing a
route handler to handle the request.
If the function modifies the request's C<path_info> or C<method>, a new
search for a matching route is performed and the filter is re-executed.
Considering that this can lead to an infinite loop, this mechanism
is stopped after 10 times with an exception.
The before filter can set a response with a redirection code (either
301 or 302): in this case the matched route (if any) will be ignored and the
redirection will be performed immediately.
You can define multiple before filters, using the C<before> helper as
many times as you wish; each filter will be executed in the order you added
them.
=head2 before_template
Defines a before_template filter:
before_template sub {
my $tokens = shift;
# do something with request, vars or params
# for example, adding a token to the template
$tokens->{token_name} = "some value";
};
The anonymous function which is given to C<before_template> will be executed
before sending data and tokens to the template. Receives a HashRef of the
tokens that will be inserted into the template.
This filter works as the C<before> and C<after> filter.
Now the preferred way for this is to use C<hook>s (namely, the
C<before_template> one). Check C<hook> documentation below.
=head2 cookies
Accesses cookies values, it returns a HashRef of L<Dancer::Cookie> objects:
get '/some_action' => sub {
my $cookie = cookies->{name};
return $cookie->value;
};
In the case you have stored something else than a Scalar in your cookie:
get '/some_action' => sub {
my $cookie = cookies->{oauth};
my %values = $cookie->value;
return ($values{token}, $values{token_secret});
};
=head2 cookie
Accesses a cookie value (or sets it). Note that this method will
eventually be preferred over C<set_cookie>.
cookie lang => "fr-FR"; # set a cookie and return its value
cookie lang => "fr-FR", expires => "2 hours"; # extra cookie info
cookie "lang" # return a cookie value
If your cookie value is a key/value URI string, like
token=ABC&user=foo
C<cookie> will only return the first part (C<token=ABC>) if called in scalar context.
Use list context to fetch them all:
my @values = cookie "name";
=head2 config
Accesses the configuration of the application:
get '/appname' => sub {
return "This is " . config->{appname};
};
=head2 content_type
Sets the B<content-type> rendered, for the current route handler:
get '/cat/:txtfile' => sub {
content_type 'text/plain';
# here we can dump the contents of param('txtfile')
};
You can use abbreviations for content types. For instance:
get '/svg/:id' => sub {
content_type 'svg';
# here we can dump the image with id param('id')
};
Note that if you want to change the default content-type for every route, you
have to change the C<content_type> setting instead.
=head2 dance
Alias for the C<start> keyword.
=head2 debug
Logs a message of debug level:
debug "This is a debug message";
See L<Dancer::Logger> for details on how to configure where log messages go.
=head2 dirname
Returns the dirname of the path given:
my $dir = dirname($some_path);
=head2 engine
Given a namespace, returns the current engine object
my $template_engine = engine 'template';
my $html = $template_engine->apply_renderer(...);
$template_engine->apply_layout($html);
=head2 error
Logs a message of error level:
error "This is an error message";
See L<Dancer::Logger> for details on how to configure where log messages go.
=head2 false
Constant that returns a false value (0).
=head2 forward
Runs an internal redirect of the current request to another request. This helps
you avoid having to redirect the user using HTTP and set another request to your
application.
It effectively lets you chain routes together in a clean manner.
get qr{ /demo/articles/(.+) }x => sub {
my ($article_id) = splat;
# you'll have to implement this next sub yourself :)
change_the_main_database_to_demo();
forward '/articles/$article_id';
};
In the above example, the users that reach I</demo/articles/30> will actually
reach I</articles/30> but we've changed the database to demo before.
This is pretty cool because it lets us retain our paths and offer a demo
database by merely going to I</demo/...>.
You'll notice that in the example we didn't indicate whether it was B<GET> or
B<POST>. That is because C<forward> chains the same type of route the user
reached. If it was a B<GET>, it will remain a B<GET>.
Broader functionality might be added in the future.
It is important to note that issuing a forward by itself does not exit and
forward immediately, forwarding is deferred until after the current route
or filter has been processed. To exit and forward immediately, use the return
function, e.g.
get '/some/path => sub {
if ($condition) {
return forward '/articles/$article_id';
}
more_stuff();
};
You probably always want to use C<return> with forward.
Note that forward doesn't parse GET arguments. So, you can't use
something like:
return forward '/home?authorized=1';
But C<forward> supports an optional HashRef with parameters to be added
to the actual parameters:
return forward '/home', { authorized => 1 };
Finally, you can add some more options to the forward method, in a
third argument, also as a HashRef. That option is currently
only used to change the method of your request. Use with caution.
return forward '/home', { auth => 1 }, { method => 'POST' };
=head2 from_dumper ($structure)
Deserializes a Data::Dumper structure.
=head2 from_json ($structure, %options)
Deserializes a JSON structure. Can receive optional arguments. Those arguments
are valid L<JSON> arguments to change the behaviour of the default
C<JSON::from_json> function.
=head2 from_yaml ($structure)
Deserializes a YAML structure.
=head2 from_xml ($structure, %options)
Deserializes a XML structure. Can receive optional arguments. These arguments
are valid L<XML::Simple> arguments to change the behaviour of the default
C<XML::Simple::XMLin> function.
=head2 get
Defines a route for HTTP B<GET> requests to the given path:
get '/' => sub {
return "Hello world";
}
Note that a route to match B<HEAD> requests is automatically created as well.
=head2 halt
Sets a response object with the content given.
When used as a return value from a filter, this breaks the execution flow and
renders the response immediately:
before sub {
if ($some_condition) {
return halt("Unauthorized");
}
};
get '/' => sub {
"hello there";
};
=head2 headers
Adds custom headers to responses:
get '/send/headers', sub {
headers 'X-Foo' => 'bar', X-Bar => 'foo';
}
=head2 header
adds a custom header to response:
get '/send/header', sub {
header 'x-my-header' => 'shazam!';
}
Note that it will overwrite the old value of the header, if any. To avoid that,
see L</push_header>.
=head2 push_header
Do the same as C<header>, but allow for multiple headers with the same name.
get '/send/header', sub {
push_header 'x-my-header' => '1';
push_header 'x-my-header' => '2';
will result in two headers "x-my-header" in the response
}
=head2 hook
Adds a hook at some position. For example :
hook before_serializer => sub {
my $response = shift;
$response->content->{generated_at} = localtime();
};
There can be multiple hooks assigned to a given position, and each will be
executed in order.
(For details on how to register new hooks from within plugins, see
L<Dancer::Hook>.)
Supported B<before> hooks (in order of execution):
=over
=item before_deserializer
This hook receives no arguments.
hook before_deserializer => sub {
...
};
=item before_file_render
This hook receives as argument the path of the file to render.
hook before_file_render => sub {
my $path = shift;
...
};
=item before_error_init
This hook receives as argument a L<Dancer::Error> object.
hook before_error_init => sub {
my $error = shift;
...
};
=item before_error_render
This hook receives as argument a L<Dancer::Error> object.
hook before_error_render => sub {
my $error = shift;
};
=item before
This is an alias to C<before>.
This hook receives no arguments.
before sub {
...
};
is equivalent to
hook before => sub {
...
};
=item before_template_render
This is an alias to 'before_template'.
This hook receives as argument a HashRef, containing the tokens that
will be passed to the template. You can use it to add more tokens, or
delete some specific token.
hook before_template_render => sub {
my $tokens = shift;
delete $tokens->{user};
$tokens->{time} = localtime;
};
is equivalent to
hook before_template => sub {
my $tokens = shift;
delete $tokens->{user};
$tokens->{time} = localtime;
};
=item before_layout_render
This hook receives two arguments. The first one is a HashRef containing the
tokens. The second is a ScalarRef representing the content of the template.
hook before_layout_render => sub {
my ($tokens, $html_ref) = @_;
...
};
=item before_serializer
This hook receives as argument a L<Dancer::Response> object.
hook before_serializer => sub {
my $response = shift;
$response->content->{start_time} = time();
};
=back
Supported B<after> hooks (in order of execution):
=over
=item after_deserializer
This hook receives no arguments.
hook after_deserializer => sub {
...
};
=item after_file_render
This hook receives as argument a L<Dancer::Response> object.
hook after_file_render => sub {
my $response = shift;
};
=item after_template_render
This hook receives as argument a ScalarRef representing the content generated
by the template.
hook after_template_render => sub {
my $html_ref = shift;
};