Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
374 lines (272 sloc) 9.69 KB
package Dancer::Config;
use strict;
use warnings;
use base 'Exporter';
use vars '@EXPORT_OK';
use Dancer::Template;
use Dancer::ModuleLoader;
use Dancer::FileUtils 'path';
use Carp 'confess';
@EXPORT_OK = qw(setting mime_types);
# mergeable settings
my %MERGEABLE = map { ($_ => 1) } qw( plugins handlers );
# singleton for storing settings
my $SETTINGS = {
# user defined mime types
mime_types => {},
sub settings {$SETTINGS}
my $setters = {
logger => sub {
my ($setting, $value) = @_;
Dancer::Logger->init($value, settings());
session => sub {
my ($setting, $value) = @_;
Dancer::Session->init($value, settings());
template => sub {
my ($setting, $value) = @_;
Dancer::Template->init($value, settings());
route_cache => sub {
my ($setting, $value) = @_;
require Dancer::Route::Cache;
serializer => sub {
my ($setting, $value) = @_;
require Dancer::Serializer;
import_warnings => sub {
my ($setting, $value) = @_;
$^W = $value ? 1 : 0;
auto_page => sub {
my ($setting, $auto_page) = @_;
if ($auto_page) {
require Dancer::App;
'get', '/:page',
sub {
my $params = Dancer::SharedData->request->params;
traces => sub {
my ($setting, $traces) = @_;
$Carp::Verbose = $traces ? 1 : 0;
my $normalizers = {
charset => sub {
my ($setting, $charset) = @_;
$charset = 'UTF-8' if $charset =~ /utf8/i;
return $charset;
sub normalize_setting {
my ($class, $setting, $value) = @_;
$value = $normalizers->{$setting}->($setting, $value)
if exists $normalizers->{$setting};
return $value;
# public accessor for get/set
sub setting {
my ($setting, $value) = @_;
if (@_ == 2) {
$value = _set_setting($setting, $value);
_trigger_hooks($setting, $value);
return $value;
else {
return _get_setting($setting);
sub _trigger_hooks {
my ($setting, $value) = @_;
$setters->{$setting}->(@_) if defined $setters->{$setting};
sub _set_setting {
my ($setting, $value) = @_;
return unless @_ == 2;
# normalize the value if needed
$value = Dancer::Config->normalize_setting($setting, $value);
$SETTINGS->{$setting} = $value;
return $value;
sub _get_setting {
my $setting = shift;
return $SETTINGS->{$setting};
sub mime_types {
my ($ext, $content_type) = @_;
$SETTINGS->{mime_types} ||= {};
return $SETTINGS->{mime_types} if @_ == 0;
return (@_ == 2)
? $SETTINGS->{mime_types}{$ext} = $content_type
: $SETTINGS->{mime_types}{$ext};
sub conffile { path(setting('confdir') || setting('appdir'), 'config.yml') }
sub environment_file {
my $env = setting('environment');
return path(setting('appdir'), 'environments', "$env.yml");
sub init_confdir {
return setting('confdir') if setting('confdir');
setting confdir => $ENV{DANCER_CONFDIR} || setting('appdir');
sub load {
# look for the conffile
return 1 unless -f conffile;
# load YAML
confess "Configuration file found but YAML is not installed"
unless Dancer::ModuleLoader->load('YAML');
my $env = environment_file;
load_settings_from_yaml($env) if -f $env;
foreach my $key (grep { $setters->{$_} } keys %$SETTINGS) {
$setters->{$key}->($key, $SETTINGS->{$key});
return 1;
sub load_settings_from_yaml {
my ($file) = @_;
my $config;
eval { $config = YAML::LoadFile($file) };
if ( my $err = $@ || (!$config)) {
confess "Unable to parse the configuration file: $file: $@";
for my $key (keys %{$config}) {
if ($MERGEABLE{$key}) {
my $setting = setting($key);
$setting->{$_} = $config->{$key}{$_}
for keys %{$config->{$key}};
else {
setting($key, $config->{$key});
return scalar(keys %$config);
sub load_default_settings {
$SETTINGS->{server} ||= $ENV{DANCER_SERVER} || '';
$SETTINGS->{port} ||= $ENV{DANCER_PORT} || '3000';
$SETTINGS->{content_type} ||= $ENV{DANCER_CONTENT_TYPE} || 'text/html';
$SETTINGS->{charset} ||= $ENV{DANCER_CHARSET} || '';
$SETTINGS->{access_log} ||= $ENV{DANCER_ACCESS_LOG} || 1;
$SETTINGS->{daemon} ||= $ENV{DANCER_DAEMON} || 0;
$SETTINGS->{apphandler} ||= $ENV{DANCER_APPHANDLER} || 'Standalone';
$SETTINGS->{warnings} ||= $ENV{DANCER_WARNINGS} || 0;
$SETTINGS->{auto_reload} ||= $ENV{DANCER_AUTO_RELOAD} || 0;
$SETTINGS->{traces} ||= $ENV{DANCER_TRACES} || 0;
|| 'development';
setting $_ => {} for keys %MERGEABLE;
setting template => 'simple';
setting import_warnings => 1;
=head1 NAME
Dancer::Config - setting registry for Dancer
Setting registry for Dancer
You can change a setting with the keyword B<set>, like the following:
use Dancer;
# changing default settings
set port => 8080;
set content_type => 'text/plain';
set access_log => 0;
A better way of defining settings exists: using YAML file. For this to be
possible, you have to install the L<YAML> module. If a file named B<config.yml>
exists in the application directory, it will be loaded, as a setting group.
The same is done for the environment file located in the B<environments>
=head2 server (string)
The IP address that the Dancer app should bind to. Default is, i.e.
bind to all available interfaces.
=head2 port (int)
The port Dancer will listen to.
Default value is 3000. This setting can be changed on the command-line with the
B<--port> switch.
=head2 daemon (boolean)
If set to true, runs the standalone webserver in the background.
This setting can be changed on the command-line with the B<--daemon> flag.
=head2 content_type (string)
The default content type of outgoing content.
Default value is 'text/html'.
=head2 charset (string)
The default charset of outgoing content. Unicode bodies in HTTP
responses of C<text/*> types will be encoded to this charset. Also,
C<charset=> item will be added to Content-Type response header.
Default value is empty which means don't do anything. HTTP responses
without charset will be interpreted as ISO-8859-1 by most clients.
You can cancel any charset processing by specifying your own charset
in Content-Type header or by ensuring that response body leaves your
handler without Unicode flag set (by encoding it into some 8bit
charset, for example).
Also, since automatically serialized JSON responses have
C<application/json> Content-Type, you should always encode them by
=head2 public (string)
This is the path of the public directory, where static files are stored. Any
existing file in that directory will be served as a static file, before
mathcing any route.
By default, it points to APPDIR/public where APPDIR is the directory that
contains your Dancer script.
=head2 layout (string)
name of the layout to use when rendering view. Dancer will look for
a matching template in the directory $appdir/views/layout.
=head2 warnings (boolean)
If set to true, tells Dancer to consider all warnings as blocking errors.
=head2 traces (boolean)
If set to true, Dancer will display full stack traces when a warning or a die
occurs. (Internally sets Carp::Verbose). Default to false.
=head2 log (enum)
Tells which log messages should be actullay logged. Possible values are
B<debug>, B<warning> or B<error>.
=over 4
=item B<debug> : all messages are logged
=item B<warning> : only warning and error messages are logged
=item B<error> : only error messages are logged
=head2 show_errors (boolean)
If set to true, Dancer will render a detailed debug screen whenever an error is
catched. If set to false, Dancer will render the default error page, using
$public/$error_code.html if it exists.
=head2 auto_reload (boolean)
Requires L<Module::Refresh> and L<Clone>.
If set to true, Dancer will reload the route handlers whenever the file where
they are defined is changed. This is very useful in development environment but
B<should not be enabled in production>. Enabling this flag in production yields
a major negative effect on performance because of L<Module::Refresh>.
When this flag is set, you don't have to restart your webserver whenever you
make a change in a route handler.
Note that L<Module::Refresh> only operates on files in C<%INC>, so if the script
your Dancer app is started from changes, even with auto_reload enabled, you will
still not see the changes reflected until you start your app.
=head2 session (enum)
This setting lets you enable a session engine for your web application. Be
default, sessions are disabled in Dancer, you must choose a session engine to
use them.
See L<Dancer::Session> for supported engines and their respective configuration.
=head1 AUTHOR
This module has been written by Alexis Sukrieh <> and others,
see the AUTHORS file that comes with this distribution for details.
=head1 LICENSE
This module is free software and is released under the same terms as Perl
=head1 SEE ALSO
Jump to Line
Something went wrong with that request. Please try again.