X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;ds=sidebyside;f=lib%2FRedis.pm;h=ca065b99fc6708cedaba8695a0ee99095e87a8c7;hb=529539c1e3bc1aa0a19bb9bde72a2352be7f76ff;hp=65137520661e3d1d60ab110ab03bd9f70f3b2fec;hpb=d614f74a89501c756b5e6a240995c0aa0295573b;p=perl-Redis.git
diff --git a/lib/Redis.pm b/lib/Redis.pm
index 6513752..ca065b9 100644
--- a/lib/Redis.pm
+++ b/lib/Redis.pm
@@ -4,8 +4,9 @@ use warnings;
use strict;
use IO::Socket::INET;
-use Data::Dump qw/dump/;
+use Data::Dumper;
use Carp qw/confess/;
+use Encode;
=head1 NAME
@@ -13,289 +14,255 @@ Redis - perl binding for Redis database
=cut
-our $VERSION = '0.01';
+our $VERSION = '1.2001';
-=head1 SYNOPSIS
+=head1 DESCRIPTION
Pure perl bindings for L
-This version support git version of Redis available at
-L
+This version supports protocol 1.2 or later of Redis available at
- use Redis;
+L
- my $r = Redis->new();
+This documentation
+lists commands which are exercised in test suite, but
+additinal commands will work correctly since protocol
+specifies enough information to support almost all commands
+with same peace of code with a little help of C.
=head1 FUNCTIONS
=head2 new
-=cut
+ my $r = Redis->new; # $ENV{REDIS_SERVER} or 127.0.0.1:6379
-our $debug = $ENV{REDIS} || 0;
+ my $r = Redis->new( server => '192.168.0.1:6379', debug = 0 );
-our $sock;
-my $server = '127.0.0.1:6379';
+=cut
sub new {
my $class = shift;
- my $self = {};
- bless($self, $class);
+ my $self = {@_};
- warn "# opening socket to $server";
+ $self->{debug} ||= $ENV{REDIS_DEBUG};
+ $self->{encoding} ||= 'utf8'; ## default to lax utf8
- $sock ||= IO::Socket::INET->new(
- PeerAddr => $server,
+ $self->{server} ||= $ENV{REDIS_SERVER} || '127.0.0.1:6379';
+ $self->{sock} = IO::Socket::INET->new(
+ PeerAddr => $self->{server},
Proto => 'tcp',
- ) || die $!;
+ ) || confess("Could not connect to Redis server at $self->{server}: $!");
- $self;
+ return bless($self, $class);
}
-sub __sock_result {
- my $result = <$sock>;
- warn "## result: ",dump( $result ) if $debug;
- $result =~ s{\r\n$}{} || warn "can't find cr/lf";
- return $result;
-}
+# we don't want DESTROY to fallback into AUTOLOAD
+sub DESTROY {}
-sub __sock_read_bulk {
- my $len = <$sock>;
- warn "## bulk len: ",dump($len) if $debug;
- return undef if $len eq "nil\r\n";
- my $v;
- if ( $len > 0 ) {
- read($sock, $v, $len) || die $!;
- warn "## bulk v: ",dump($v) if $debug;
- }
- my $crlf;
- read($sock, $crlf, 2); # skip cr/lf
- return $v;
-}
-sub _sock_result_bulk {
+### Deal with common, general case, Redis commands
+our $AUTOLOAD;
+sub AUTOLOAD {
my $self = shift;
- warn "## _sock_result_bulk ",dump( @_ ) if $debug;
- print $sock join(' ',@_) . "\r\n";
- __sock_read_bulk();
+ my $sock = $self->{sock} || confess("Not connected to any server");
+ my $enc = $self->{encoding};
+ my $deb = $self->{debug};
+
+ my $command = $AUTOLOAD;
+ $command =~ s/.*://;
+
+ $self->__send_command($command, @_);
+
+ my $result = <$sock> || confess("Can't read socket: $!");
+ my $type = substr($result,0,1);
+ $result = substr($result,1,-2);
+
+ $result = decode($enc, $result) if $enc;
+ warn "[RECV] '$type$result'" if $deb;
+
+ if ( $command eq 'info' ) {
+ my $hash;
+ foreach my $l ( split(/\r\n/, $self->__read_bulk($result) ) ) {
+ my ($n,$v) = split(/:/, $l, 2);
+ $hash->{$n} = $v;
+ }
+ return $hash;
+ } elsif ( $command eq 'keys' ) {
+ return $self->__read_multi_bulk($result)
+ if $type eq '*';
+ my $keys = $self->__read_bulk($result);
+ return split(/\s/, $keys) if $keys;
+ return;
+ }
+
+ if ( $type eq '-' ) {
+ confess "[$command] $result";
+ } elsif ( $type eq '+' ) {
+ return $result;
+ } elsif ( $type eq '$' ) {
+ return $self->__read_bulk($result);
+ } elsif ( $type eq '*' ) {
+ return $self->__read_multi_bulk($result);
+ } elsif ( $type eq ':' ) {
+ return $result; # FIXME check if int?
+ } else {
+ confess "unknown type: $type", $self->__read_line();
+ }
}
-sub _sock_result_bulk_list {
- my $self = shift;
- warn "## _sock_result_bulk_list ",dump( @_ ) if $debug;
- my $size = $self->_sock_send( @_ );
- confess $size unless $size > 0;
- $size--;
+### Commands with extra logic
- my @list = ( 0 .. $size );
- foreach ( 0 .. $size ) {
- $list[ $_ ] = __sock_read_bulk();
- }
+sub quit {
+ my ($self) = @_;
- warn "## list = ", dump( @list ) if $debug;
- return @list;
-}
+ $self->__send_command('QUIT');
-sub __sock_ok {
- my $ok = <$sock>;
- return undef if $ok eq "nil\r\n";
- confess dump($ok) unless $ok eq "+OK\r\n";
+ close(delete $self->{sock}) || confess("Can't close socket: $!");
+ return 1;
}
-sub _sock_send {
- my $self = shift;
- warn "## _sock_send ",dump( @_ ) if $debug;
- print $sock join(' ',@_) . "\r\n";
- __sock_result();
-}
-sub _sock_send_ok {
- my $self = shift;
- warn "## _sock_send_ok ",dump( @_ ) if $debug;
- print $sock join(' ',@_) . "\r\n";
- __sock_ok();
-}
+### Socket operations
-sub __sock_send_bulk_raw {
- warn "## _sock_send_bulk ",dump( @_ ) if $debug;
- my $value = pop;
- $value = '' unless defined $value; # FIXME errr? nil?
- print $sock join(' ',@_) . ' ' . length($value) . "\r\n$value\r\n"
-}
+sub __send_command {
+ my $self = shift;
+ my $cmd = uc(shift);
+ my $enc = $self->{encoding};
+ my $deb = $self->{debug};
-sub _sock_send_bulk {
- my $self = shift;
- __sock_send_bulk_raw( @_ );
- __sock_ok();
+ warn "[SEND] $cmd ", Dumper([@_]) if $deb;
+
+ ## Encode command using multi-bulk format
+ my $n_elems = scalar(@_) + 1;
+ my $buf = "\*$n_elems\r\n";
+ for my $elem ($cmd, @_) {
+ my $bin = $enc ? encode($enc, $elem) : $elem;
+ $buf .= defined($bin) ? '$' . length($bin) . "\r\n$bin\r\n" : "\$-1\r\n";
+ }
+
+ ## Send command, take care for partial writes
+ warn "[SEND RAW] $buf" if $deb;
+ my $sock = $self->{sock} || confess("Not connected to any server");
+ while ($buf) {
+ my $len = syswrite $sock, $buf, length $buf;
+ confess("Could not write to Redis server: $!")
+ unless $len;
+ substr $buf, 0, $len, "";
+ }
+
+ return;
}
-sub _sock_send_bulk_number {
- my $self = shift;
- __sock_send_bulk_raw( @_ );
- my $v = __sock_result();
- confess $v unless $v =~ m{^\-?\d+$};
+sub __read_bulk {
+ my ($self,$len) = @_;
+ return if $len < 0;
+
+ my $enc = $self->{encoding};
+ my $v = '';
+ if ( $len > 0 ) {
+ read($self->{sock}, $v, $len) || confess("Could not read from sock: $!");
+ $v = decode($enc, $v) if $enc;
+ }
+ my $crlf;
+ read($self->{sock}, $crlf, 2); # skip cr/lf
+
+ warn "[PARSE] read_bulk ".Dumper($v) if $self->{debug};
return $v;
}
-=head1 Connection Handling
+sub __read_multi_bulk {
+ my ($self,$size) = @_;
+ return if $size <= 0;
-=head2 quit
+ my $sock = $self->{sock};
+ my $deb = $self->{debug};
+ my $enc = $self->{encoding};
+ my @list;
+ while ($size--) {
+ my $v = $self->__read_bulk( substr(<$sock>,1,-2) );
+ $v = decode($enc, $v) if $enc;
+ warn " [PARSE] read_multi_bulk ($size) ".Dumper($v) if $deb;
+ push @list, $v;
+ }
- $r->quit;
+ warn "[PARSE] multi_bulk ".Dumper( \@list ) if $deb;
+ return @list;
+}
-=cut
+1;
-sub quit {
- my $self = shift;
+__END__
- close( $sock ) || warn $!;
-}
+=head1 Connection Handling
-=head2 ping
+=head2 quit
- $r->ping || die "no server?";
+ $r->quit;
-=cut
+=head2 ping
-sub ping {
- print $sock "PING\r\n";
- my $pong = <$sock>;
- die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n";
-}
+ $r->ping || die "no server?";
=head1 Commands operating on string values
=head2 set
- $r->set( foo => 'bar', $new );
+ $r->set( foo => 'bar' );
-=cut
-
-sub set {
- my ( $self, $key, $value, $new ) = @_;
- $self->_sock_send_bulk( "SET" . ( $new ? 'NX' : '' ), $key, $value );
-}
+ $r->setnx( foo => 42 );
=head2 get
my $value = $r->get( 'foo' );
-=cut
+=head2 mget
-sub get {
- my $self = shift;
- $self->_sock_result_bulk('GET', @_);
-}
+ my @values = $r->mget( 'foo', 'bar', 'baz' );
=head2 incr
$r->incr('counter');
- $r->incr('tripplets', 3);
-
-=cut
-
-
-sub incr {
- my $self = shift;
- $self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ );
-}
+ $r->incrby('tripplets', 3);
=head2 decr
$r->decr('counter');
- $r->decr('tripplets', 3);
-
-=cut
-sub decr {
- my $self = shift;
- $self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ );
-}
+ $r->decrby('tripplets', 3);
=head2 exists
$r->exists( 'key' ) && print "got key!";
-=cut
-
-sub exists {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'EXISTS', $key );
-}
-
=head2 del
$r->del( 'key' ) || warn "key doesn't exist";
-=cut
-
-sub del {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'DEL', $key );
-}
-
=head2 type
$r->type( 'key' ); # = string
-=cut
-
-sub type {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'TYPE', $key );
-}
-
=head1 Commands operating on the key space
=head2 keys
my @keys = $r->keys( '*glob_pattern*' );
-=cut
-
-sub keys {
- my ( $self, $glob ) = @_;
- my $keys = $self->_sock_result_bulk( 'KEYS', $glob );
- return split(/\s/, $keys) if $keys;
- return () if wantarray;
-}
-
=head2 randomkey
my $key = $r->randomkey;
-=cut
-
-sub randomkey {
- my ( $self ) = @_;
- $self->_sock_send( 'RANDOMKEY' );
-}
-
=head2 rename
my $ok = $r->rename( 'old-key', 'new-key', $new );
-=cut
-
-sub rename {
- my ( $self, $old, $new, $nx ) = @_;
- $self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new );
-}
-
=head2 dbsize
my $nr_keys = $r->dbsize;
-=cut
-
-sub dbsize {
- my ( $self ) = @_;
- $self->_sock_send('DBSIZE');
-}
-
=head1 Commands operating on lists
See also L for tie interface.
@@ -304,226 +271,123 @@ See also L for tie interface.
$r->rpush( $key, $value );
-=cut
-
-sub rpush {
- my ( $self, $key, $value ) = @_;
- $self->_sock_send_bulk('RPUSH', $key, $value);
-}
-
=head2 lpush
$r->lpush( $key, $value );
-=cut
-
-sub lpush {
- my ( $self, $key, $value ) = @_;
- $self->_sock_send_bulk('LPUSH', $key, $value);
-}
-
=head2 llen
$r->llen( $key );
-=cut
-
-sub llen {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'LLEN', $key );
-}
-
=head2 lrange
my @list = $r->lrange( $key, $start, $end );
-=cut
-
-sub lrange {
- my ( $self, $key, $start, $end ) = @_;
- $self->_sock_result_bulk_list('LRANGE', $key, $start, $end);
-}
-
=head2 ltrim
my $ok = $r->ltrim( $key, $start, $end );
-=cut
-
-sub ltrim {
- my ( $self, $key, $start, $end ) = @_;
- $self->_sock_send_ok( 'LTRIM', $key, $start, $end );
-}
-
=head2 lindex
$r->lindex( $key, $index );
-=cut
-
-sub lindex {
- my ( $self, $key, $index ) = @_;
- $self->_sock_result_bulk( 'LINDEX', $key, $index );
-}
-
=head2 lset
$r->lset( $key, $index, $value );
-=cut
-
-sub lset {
- my ( $self, $key, $index, $value ) = @_;
- $self->_sock_send_bulk( 'LSET', $key, $index, $value );
-}
-
=head2 lrem
my $modified_count = $r->lrem( $key, $count, $value );
-=cut
-
-sub lrem {
- my ( $self, $key, $count, $value ) = @_;
- $self->_sock_send_bulk_number( 'LREM', $key, $count, $value );
-}
-
=head2 lpop
my $value = $r->lpop( $key );
-=cut
-
-sub lpop {
- my ( $self, $key ) = @_;
- $self->_sock_result_bulk( 'LPOP', $key );
-}
-
=head2 rpop
my $value = $r->rpop( $key );
-=cut
-
-sub rpop {
- my ( $self, $key ) = @_;
- $self->_sock_result_bulk( 'RPOP', $key );
-}
-
=head1 Commands operating on sets
=head2 sadd
$r->sadd( $key, $member );
-=cut
-
-sub sadd {
- my ( $self, $key, $member ) = @_;
- $self->_sock_send_bulk_number( 'SADD', $key, $member );
-}
-
=head2 srem
$r->srem( $key, $member );
-=cut
-
-sub srem {
- my ( $self, $key, $member ) = @_;
- $self->_sock_send_bulk_number( 'SREM', $key, $member );
-}
-
=head2 scard
my $elements = $r->scard( $key );
-=cut
-
-sub scard {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'SCARD', $key );
-}
-
=head2 sismember
$r->sismember( $key, $member );
-=cut
-
-sub sismember {
- my ( $self, $key, $member ) = @_;
- $self->_sock_send_bulk_number( 'SISMEMBER', $key, $member );
-}
-
=head2 sinter
$r->sinter( $key1, $key2, ... );
-=cut
-
-sub sinter {
- my $self = shift;
- $self->_sock_result_bulk_list( 'SINTER', @_ );
-}
-
=head2 sinterstore
my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... );
-=cut
-
-sub sinterstore {
- my $self = shift;
- $self->_sock_send_ok( 'SINTERSTORE', @_ );
-}
-
=head1 Multiple databases handling commands
=head2 select
$r->select( $dbindex ); # 0 for new clients
-=cut
-
-sub select {
- my ($self,$dbindex) = @_;
- confess dump($dbindex) . 'not number' unless $dbindex =~ m{^\d+$};
- $self->_sock_send_ok( 'SELECT', $dbindex );
-}
-
=head2 move
$r->move( $key, $dbindex );
-=cut
-
-sub move {
- my ( $self, $key, $dbindex ) = @_;
- $self->_sock_send( 'MOVE', $key, $dbindex );
-}
-
=head2 flushdb
$r->flushdb;
-=cut
-
-sub flushdb {
- my $self = shift;
- $self->_sock_send_ok('FLUSHDB');
-}
-
=head2 flushall
$r->flushall;
-=cut
+=head1 Sorting
-sub flushall {
- my $self = shift;
- $self->_sock_send_ok('flushall');
-}
+=head2 sort
+
+ $r->sort("key BY pattern LIMIT start end GET pattern ASC|DESC ALPHA');
+
+=head1 Persistence control commands
+
+=head2 save
+
+ $r->save;
+
+=head2 bgsave
+
+ $r->bgsave;
+
+=head2 lastsave
+
+ $r->lastsave;
+
+=head2 shutdown
+
+ $r->shutdown;
+
+=head1 Remote server control commands
+
+=head2 info
+
+ my $info_hash = $r->info;
+
+=head1 ENCODING
+
+Since Redis knows nothing about encoding, we are forcing utf-8 flag on all data received from Redis.
+This change is introduced in 1.2001 version.
+
+This allows us to round-trip utf-8 encoded characters correctly, but might be problem if you push
+binary junk into Redis and expect to get it back without utf-8 flag turned on.
=head1 AUTHOR
@@ -543,6 +407,8 @@ automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc Redis
+ perldoc Redis::List
+ perldoc Redis::Hash
You can also look for information at:
@@ -573,7 +439,7 @@ L
=head1 COPYRIGHT & LICENSE
-Copyright 2009 Dobrica Pavlinusic, all rights reserved.
+Copyright 2009-2010 Dobrica Pavlinusic, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.