/usr/share/perl5/Dancer/Route/Cache.pm is in libdancer-perl 1.3202+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | package Dancer::Route::Cache;
our $AUTHORITY = 'cpan:SUKRIA';
#ABSTRACT: route caching mechanism for L<Dancer>
$Dancer::Route::Cache::VERSION = '1.3202';
use strict;
use warnings;
use Carp;
use base 'Dancer::Object';
use Dancer::Config 'setting';
use Dancer::Error;
use Dancer::Exception qw(:all);
Dancer::Route::Cache->attributes('size_limit', 'path_limit');
# static
# singleton for the current cache object
my $_cache;
sub get {$_cache}
sub reset {
$_cache = Dancer::Route::Cache->new();
$_cache->{size_limit} = setting('route_cache_size_limit')
if defined setting('route_cache_size_limit');
$_cache->{path_limit} = setting('route_cache_path_limit')
if defined setting('route_cache_path_limit');
}
# instance
sub init {
my ($self, %args) = @_;
$self->build_size_limit($args{'size_limit'} || '10M');
$self->build_path_limit($args{'path_limit'} || 600);
}
sub build_path_limit {
my ($self, $limit) = @_;
if ($limit) {
$self->{'path_limit'} = $limit;
}
return $self->{'path_limit'};
}
sub build_size_limit {
my ($self, $limit) = @_;
if ($limit) {
$self->{'size_limit'} = $self->parse_size($limit);
}
return $self->{'size_limit'};
}
sub parse_size {
my ($self, $size) = @_;
if ($size =~ /^(\d+)(K|M|G)?$/i) {
my $base = $1;
if (my $ext = $2) {
$ext eq 'K' and return $base * 1024**1;
$ext eq 'M' and return $base * 1024**2;
$ext eq 'G' and return $base * 1024**3;
}
return $base;
}
}
sub route_from_path {
my ($self, $method, $path, $app_name) = @_;
$method && $path
or raise core_route => "Missing method or path";
$app_name = 'main' unless defined $app_name;
return $self->{'cache'}{$app_name}{$method}{$path} || undef;
}
sub store_path {
my ($self, $method, $path, $route, $app_name) = @_;
$method && $path && $route
or raise core_route => "Missing method, path or route";
$app_name = 'main' unless defined $app_name;
$self->{'cache'}{$app_name}{$method}{$path} = $route;
push @{$self->{'cache_array'}}, [$method, $path, $app_name];
if (my $limit = $self->size_limit) {
while ($self->route_cache_size() > $limit) {
my ($method, $path, $app_name) = @{shift @{$self->{'cache_array'}}};
delete $self->{'cache'}{$app_name}{$method}{$path};
}
}
if (my $limit = $self->path_limit) {
while ($self->route_cache_paths() > $limit) {
my ($method, $path, $app_name) = @{shift @{$self->{'cache_array'}}};
delete $self->{'cache'}{$app_name}{$method}{$path};
}
}
}
sub route_cache_size {
my $self = shift;
my %cache = %{$self->{'cache'}};
my $size = 0;
use bytes;
foreach my $app_name (keys %cache) {
$size += length $app_name;
foreach my $method (keys %{$cache{$app_name}}) {
$size += length $method;
foreach my $path (keys %{$cache{$app_name}{$method}}) {
$size += length $path;
$size += length $cache{$app_name}{$method}{$path};
}
}
}
no bytes;
return $size;
}
sub route_cache_paths {
my $self = shift;
my %cache = $self->{'cache'} ? %{$self->{'cache'}} : ();
return scalar map { keys %{$_} } map { values %{$cache{$_}} } keys %cache;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer::Route::Cache - route caching mechanism for L<Dancer>
=head1 VERSION
version 1.3202
=head1 SYNOPSIS
my $cache = Dancer::Route::Cache->new(
path_limit => 300, # optional, defaults to 600 (routes to cache)
size_limit => 5M, # optional, defaults to 10M (10MB)
);
# storing a path
# /new/item/ is the path, $route is a compiled route
$cache->store_path( 'get', '/new/item/', $route );
my $cached_route = $cache->route_from_path('/new/item/');
=head1 DESCRIPTION
When L<Dancer> first starts, it has to compile a regexp list of all the routes.
Then, on each request it goes over the compiled routes list and tries to compare
the requested path to a route.
A major drawback is that L<Dancer> has to go over the matching on every request,
which (especially on CGI-based applications) can be very time consuming.
The caching mechanism allows one to cache some requests to specific routes (but
B<NOT> specific results) and run those routes on a specific path. This allows us
to speed up L<Dancer> quite a lot.
=head1 METHODS/SUBROUTINES
=head2 new(@args)
Creates a new route cache object.
my $cache = Dancer::Route::Cache->new(
path_limit => 100, # only 100 paths will be cached
size_limit => '30M', # max size for cache is 30MB
);
Please check the C<ATTRIBUTES> section below to learn about the arguments for
C<new()>.
=head2 route_from_path($path)
Fetches the route from the path in the cache.
=head2 store_path( $method, $path => $route )
Stores the route in the cache according to the path and $method.
For developers: the reason we're using an object for this and not directly using
the registry hash is because we need to enforce the limits.
=head2 parse_size($size)
Parses the size wanted to bytes. It can handle Kilobytes, Megabytes or
Gigabytes.
B<NOTICE:> handles bytes, not bits!
my $bytes = $cache->parse_size('30M');
# doesn't need an existing object
$bytes = Dancer::Route::Cache->parse_size('300G'); # works this way too
=head2 route_cache_size
Returns a rough calculation the size of the cache. This is used to enforce the
size limit.
=head2 route_cache_paths
Returns all the paths in the cache. This is used to enforce the path limit.
Please be careful if you use L<Plack::Builder/mount> and some applications -
routes are linked with applications and same path may be in some applications
but with different handlers!
=head1 ATTRIBUTES
=head2 size_limit($limit)
Allows one to set a size limit of the cache.
Returns the limit (post-set).
$cache->size_limit('10K'); # sets limit
my $limit = $cache->size_limit; # gets limit
=head2 path_limit($limit)
A path limit. That is, the amount of paths that whose routes will be cached.
Returns the limit (post-set).
$cache->path_limit('100'); # sets limit
my $limit = $cache->path_limit; # gets limit
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|