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
|
package Cache::Memcached::Fast::Safe;
use strict;
use warnings;
use Cache::Memcached::Fast 0.19;
use Digest::SHA qw/sha1_hex/;
use parent qw/Cache::Memcached::Fast/;
use POSIX::AtFork;
use Scalar::Util qw/weaken/;
our $VERSION = '0.06';
our $SANITIZE_METHOD = \&_sanitize_method;
{
use bytes;
my %escapes = map { chr($_) => sprintf('%%%02X', $_) } (0x00..0x20, 0x7f..0xff);
sub _sanitize_method {
my $key = shift;
$key =~ s/([\x00-\x20\x7f-\xff])/$escapes{$1}/ge;
if ( length $key > 200 ) {
$key = sha1_hex($key);
}
$key;
}
}
sub new {
my $class = shift;
my %args = ref $_[0] ? %{$_[0]} : @_;
my $mem = $class->SUPER::new(\%args);
# fork safe
weaken(my $mem_weaken = $mem);
POSIX::AtFork->add_to_child(sub {
eval { $mem_weaken->disconnect_all };
});
$mem;
}
for my $method ( qw/set cas add replace append prepend incr decr delete touch/ ) {
no strict 'refs';
my $super = 'SUPER::'.$method;
*{$method} = sub {
my $self = shift;
my $key = shift;
$self->$super($SANITIZE_METHOD->($key), @_);
};
}
for my $method (qw/set_multi cas_multi add_multi replace_multi append_multi prepend_multi incr_multi decr_multi delete_multi touch_multi/ ) {
no strict 'refs';
my $super = 'SUPER::'.$method;
*{$method} = sub {
my $self = shift;
my @request = @_;
my @request_keys;
my %sanitized_keys;
my @sanitized_request;
for my $keyval (@request) {
my $key;
my $sanitized_key;
my $sanitized_keyval;
if ( ref $keyval ) {
my @keyval = @$keyval;
$key = shift @keyval;
$sanitized_key = $SANITIZE_METHOD->($key);
$sanitized_keyval = [$sanitized_key, @keyval];
}
else {
$key = $keyval;
$sanitized_key = $SANITIZE_METHOD->($key);
$sanitized_keyval = $sanitized_key
}
$sanitized_keys{$sanitized_key} = $key;
push @request_keys, $key;
push @sanitized_request, $sanitized_keyval;
}
my $sanitized_result = $self->$super(@sanitized_request);
my %result;
for my $key ( keys %$sanitized_result ) {
$result{$sanitized_keys{$key}} = $sanitized_result->{$key};
}
if ( wantarray ) {
my @result;
for my $key ( @request_keys ) {
push @result, $result{$key};
}
return @result;
}
\%result;
}
}
*remove = \&delete;
for my $method (qw/get gets/) {
no strict 'refs';
my $super = 'SUPER::'.$method;
*{$method} = sub {
my $self = shift;
my $key = shift;
$self->$super($SANITIZE_METHOD->($key));
};
}
for my $method (qw/get_multi gets_multi/) {
no strict 'refs';
my $super = 'SUPER::'.$method;
*{$method} = sub {
my $self = shift;
my @request;
my %sanitized_keys;
for my $key (@_) {
my $sanitized_key = $SANITIZE_METHOD->($key);
$sanitized_keys{$sanitized_key} = $key;
push @request, $sanitized_key;
}
return {} if ! @request;
my $sanitized_result = $self->$super(@request);
my %result;
for my $key ( keys %$sanitized_result ) {
$result{$sanitized_keys{$key}} = $sanitized_result->{$key};
}
\%result;
}
}
sub get_or_set {
my($self, $key, $sub, $expire) = @_;
if (my $value = $self->get($key)) {
return $value;
}
my ($value, $ret_expire) = $sub->();
$self->set($key, $value, $expire || $ret_expire);
$value;
}
1;
__END__
=head1 NAME
Cache::Memcached::Fast::Safe - Cache::Memcached::Fast with sanitizing keys and fork-safe
=head1 SYNOPSIS
use Cache::Memcached::Fast::Safe;
my $memd = Cache::Memcached::Fast::Safe->new({
servers => [..]
});
#This module supports all method that Cache::Memcached::Fast has.
=head1 DESCRIPTION
Cache::Memcached::Fast::Safe is subclass of L<Cache::Memcached::Fast>.
Cache::Memcached::Fast::Safe sanitizes all requested keys for against
memcached injection problem. and call disconnect_all automatically after fork
for fork-safe.
=head1 ADDITIONAL METHOD
=over 4
=item get_or_set($key:Str, $callback:CodeRef [,$expires:Num])
Get a cache value for $key if it's already cached. If can not retrieve cache values, execute $callback and cache with $expires seconds.
$memcached->get_or_set('key:941',sub {
DB->retrieve(941)
},10);
callback can also return expires sec.
$memcached->get_or_set('key:941',sub {
my $val = DB->retrieve(941);
return ($val, 10)
});
=back
=head1 CUSTOMIZE Sanitizer
This module allow to change sanitizing behavior through $Cache::Memcached::Fast::Safe::SANITIZE_METHOD.
Default sanitizer is
use bytes;
my %escapes = map { chr($_) => sprintf('%%%02X', $_) } (0x00..0x20, 0x7f..0xff);
local $Cache::Memcached::Fast::Safe::SANITIZE_METHOD = sub {
my $key = shift;
$key =~ s/([\x00-\x20\x7f-\xff])/$escapes{$1}/ge;
if ( length $key > 200 ) {
$key = sha1_hex($key);
}
$key;
};
=head1 AUTHOR
Masahiro Nagano E<lt>kazeburo {at} gmail.comE<gt>
=head1 SEE ALSO
L<Cache::Memcached::Fast>, L<http://gihyo.jp/dev/feature/01/memcached_advanced/0002> (Japanese)
=head1 LICENSE
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|