-
Notifications
You must be signed in to change notification settings - Fork 210
/
Plugin.pm
177 lines (124 loc) · 4.22 KB
/
Plugin.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
package Dancer::Plugin;
use strict;
use warnings;
use Carp;
use base 'Exporter';
use Dancer::Config 'setting';
use base 'Exporter';
use vars qw(@EXPORT);
@EXPORT = qw(
add_hook
register
register_plugin
plugin_setting
);
sub register($&);
my $_keywords = {};
sub add_hook { Dancer::Route::Registry->hook(@_) }
sub plugin_setting {
my $plugin_orig_name = caller();
(my $plugin_name = $plugin_orig_name) =~ s/Dancer::Plugin:://;
return setting('plugins')->{$plugin_name} ||= {};
}
sub register($&) {
my ($keyword, $code) = @_;
my $plugin_name = caller();
$keyword =~ /^[a-zA-Z_]+[a-zA-Z0-9_]*$/
or croak "You can't use '$keyword', it is an invalid name (it should match ^[a-zA-Z_]+[a-zA-Z0-9_]*$ )";
if (grep { $_ eq $keyword } map { s/^(?:\$|%|&|@|\*)//; $_ } (@Dancer::EXPORT, @Dancer::EXPORT_OK)) {
croak "You can't use '$keyword', this is a reserved keyword";
}
while (my ($plugin, $keywords) = each %$_keywords) {
if (grep { $_->[0] eq $keyword } @$keywords) {
croak "You can't use $keyword, this is a keyword reserved by $plugin";
}
}
$_keywords->{$plugin_name} ||= [];
push @{$_keywords->{$plugin_name}}, [$keyword => $code];
}
sub register_plugin {
my ($application) = shift || caller(1);
my ($plugin) = caller();
my @symbols = set_plugin_symbols($plugin);
{
no strict 'refs';
# tried to use unshift, but it yields an undef warning on $plugin (perl v5.12.1)
@{"${plugin}::ISA"} = ('Exporter', 'Dancer::Plugin', @{"${plugin}::ISA"});
push @{"${plugin}::EXPORT"}, @symbols;
}
return 1;
}
sub set_plugin_symbols {
my ($plugin) = @_;
for my $keyword (@{$_keywords->{$plugin}}) {
my ($name, $code) = @$keyword;
{
no strict 'refs';
*{"${plugin}::${name}"} = $code;
}
}
return map { $_->[0] } @{$_keywords->{$plugin}};
}
1;
__END__
=pod
=head1 NAME
Dancer::Plugin - helper for writing Dancer plugins
=head1 DESCRIPTION
Create plugins for Dancer
=head1 SYNOPSIS
package Dancer::Plugin::LinkBlocker;
use Dancer ':syntax';
use Dancer::Plugin;
register block_links_from => sub {
my $conf = plugin_setting();
my $re = join ('|', @{$conf->{hosts}});
before sub {
if (request->referer && request->referer =~ /$re/) {
status 403 || $conf->{http_code};
}
};
};
register_plugin;
1;
And in your application:
package My::Webapp;
use Dancer ':syntax';
use Dancer::Plugin::LinkBlocker;
block_links_from; # this is exported by the plugin
=head1 PLUGINS
You can extend Dancer by writing your own Plugin.
A plugin is a module that exports a bunch of symbols to the current namespace
(the caller will see all the symbols defined via C<register>).
Note that you have to C<use> the plugin wherever you want to use its symbols.
For instance, if you have Webapp::App1 and Webapp::App2, both loaded from your
main application, they both need to C<use FooPlugin> if they want to use the
symbols exported by C<FooPlugin>.
=head2 METHODS
=over 4
=item B<register>
Lets you define a keyword that will be exported by the plugin.
register my_symbol_to_export => sub {
# ... some code
};
=item B<register_plugin>
A Dancer plugin must end with this statement. This lets the plugin register all
the symbols define with C<register> as exported symbols (via the L<Exporter>
module).
A Dancer plugin inherits from Dancer::Plugin and Exporter transparently.
=item B<plugin_setting>
Configuration for plugin should be structured like this in the config.yaml of the application:
plugins:
plugin_name:
key: value
If plugin_setting is called inside a plugin, the appropriate configuration will be returned. The plugin_name should be the name of the package, or, if the plugin name is under the B<Dancer::Plugin::> namespace, the remaining part of the plugin name. Enclose the remaining part in quotes if it contains ::, e.g. for B<Dancer::Plugin::Foo::Bar>, use:
plugins:
"Foo::Bar":
key: value
=back
=head1 AUTHORS
This module has been written by Alexis Sukrieh and others.
=head1 LICENSE
This module is free software and is published under the same
terms as Perl itself.
=cut