/[Redis.pre-github]/lib/Redis.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /lib/Redis.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 32 by dpavlin, Sun Mar 22 17:06:34 2009 UTC revision 65 by dpavlin, Wed Mar 17 16:24:28 2010 UTC
# Line 4  use warnings; Line 4  use warnings;
4  use strict;  use strict;
5    
6  use IO::Socket::INET;  use IO::Socket::INET;
7  use Data::Dump qw/dump/;  use Data::Dumper;
8  use Carp qw/confess/;  use Carp qw/confess/;
9    
10  =head1 NAME  =head1 NAME
11    
12  Redis - The great new Redis!  Redis - perl binding for Redis database
13    
14  =cut  =cut
15    
16  our $VERSION = '0.01';  our $VERSION = '0.0801';
17    
18    
19  =head1 SYNOPSIS  =head1 DESCRIPTION
20    
21  Pure perl bindings for L<http://code.google.com/p/redis/>  Pure perl bindings for L<http://code.google.com/p/redis/>
22    
23      use Redis;  This version support git version 0.08 or later of Redis available at
   
     my $r = Redis->new();  
   
24    
25    L<git://github.com/antirez/redis>
26    
27    This documentation
28    lists commands which are exercised in test suite, but
29    additinal commands will work correctly since protocol
30    specifies enough information to support almost all commands
31    with same peace of code with a little help of C<AUTOLOAD>.
32    
33  =head1 FUNCTIONS  =head1 FUNCTIONS
34    
35  =head2 new  =head2 new
36    
37  =cut    my $r = Redis->new; # $ENV{REDIS_SERVER} or 127.0.0.1:6379
38    
39  our $sock;    my $r = Redis->new( server => '192.168.0.1:6379', debug = 0 );
40  my $server = '127.0.0.1:6379';  
41    =cut
42    
43  sub new {  sub new {
44          my $class = shift;          my $class = shift;
45          my $self = {};          my $self = {@_};
46          bless($self, $class);          $self->{debug} ||= $ENV{REDIS_DEBUG};
47    
48          warn "# opening socket to $server";          $self->{sock} = IO::Socket::INET->new(
49                    PeerAddr => $self->{server} || $ENV{REDIS_SERVER} || '127.0.0.1:6379',
         $sock ||= IO::Socket::INET->new(  
                 PeerAddr => $server,  
50                  Proto => 'tcp',                  Proto => 'tcp',
51          ) || die $!;          ) || die $!;
52    
53            bless($self, $class);
54          $self;          $self;
55  }  }
56    
57  sub _sock_result {  my $bulk_command = {
58          my $result = <$sock>;          set => 1,       setnx => 1,
59          warn "# result: ",dump( $result );          rpush => 1,     lpush => 1,
60          $result =~ s{\r\n$}{} || warn "can't find cr/lf";          lset => 1,      lrem => 1,
61          return $result;          sadd => 1,      srem => 1,
62            sismember => 1,
63            echo => 1,
64            getset => 1,
65            smove => 1,
66            zadd => 1,
67            zrem => 1,
68            zscore => 1,
69            zincrby => 1,
70            append => 1,
71    };
72    
73    # we don't want DESTROY to fallback into AUTOLOAD
74    sub DESTROY {}
75    
76    our $AUTOLOAD;
77    sub AUTOLOAD {
78            my $self = shift;
79    
80            my $sock = $self->{sock} || die "no server connected";
81    
82            my $command = $AUTOLOAD;
83            $command =~ s/.*://;
84    
85            warn "## $command ",Dumper(@_) if $self->{debug};
86    
87            my $send;
88    
89            if ( defined $bulk_command->{$command} ) {
90                    my $value = pop;
91                    $value = '' if ! defined $value;
92                    $send
93                            = uc($command)
94                            . ' '
95                            . join(' ', @_)
96                            . ' '
97                            . length( $value )
98                            . "\r\n$value\r\n"
99                            ;
100            } else {
101                    $send
102                            = uc($command)
103                            . ' '
104                            . join(' ', @_)
105                            . "\r\n"
106                            ;
107            }
108    
109            warn ">> $send" if $self->{debug};
110            print $sock $send;
111    
112            if ( $command eq 'quit' ) {
113                    close( $sock ) || die "can't close socket: $!";
114                    return 1;
115            }
116    
117            my $result = <$sock> || die "can't read socket: $!";
118            warn "<< $result" if $self->{debug};
119            my $type = substr($result,0,1);
120            $result = substr($result,1,-2);
121    
122            if ( $command eq 'info' ) {
123                    my $hash;
124                    foreach my $l ( split(/\r\n/, $self->__read_bulk($result) ) ) {
125                            my ($n,$v) = split(/:/, $l, 2);
126                            $hash->{$n} = $v;
127                    }
128                    return $hash;
129            } elsif ( $command eq 'keys' ) {
130                    my $keys = $self->__read_bulk($result);
131                    return split(/\s/, $keys) if $keys;
132                    return;
133            }
134    
135            if ( $type eq '-' ) {
136                    confess "[$command] $result";
137            } elsif ( $type eq '+' ) {
138                    return $result;
139            } elsif ( $type eq '$' ) {
140                    return $self->__read_bulk($result);
141            } elsif ( $type eq '*' ) {
142                    return $self->__read_multi_bulk($result);
143            } elsif ( $type eq ':' ) {
144                    return $result; # FIXME check if int?
145            } else {
146                    confess "unknown type: $type", $self->__read_line();
147            }
148  }  }
149    
150  sub _sock_read_bulk {  sub __read_bulk {
151          my $len = <$sock>;          my ($self,$len) = @_;
152          warn "## bulk len: ",dump($len);          return undef if $len < 0;
153          return undef if $len eq "nil\r\n";  
154          my $v;          my $v;
155          if ( $len > 0 ) {          if ( $len > 0 ) {
156                  read($sock, $v, $len) || die $!;                  read($self->{sock}, $v, $len) || die $!;
157                  warn "## bulk v: ",dump($v);                  warn "<< ",Dumper($v),$/ if $self->{debug};
158          }          }
159          my $crlf;          my $crlf;
160          read($sock, $crlf, 2); # skip cr/lf          read($self->{sock}, $crlf, 2); # skip cr/lf
161          return $v;          return $v;
162  }  }
163    
164  sub _sock_result_bulk {  sub __read_multi_bulk {
165          my $self = shift;          my ($self,$size) = @_;
166          warn "## _sock_result_bulk ",dump( @_ );          return undef if $size < 0;
167          print $sock join(' ',@_) . "\r\n";          my $sock = $self->{sock};
         _sock_read_bulk();  
 }  
   
 sub __sock_ok {  
         my $ok = <$sock>;  
         return undef if $ok eq "nil\r\n";  
         confess dump($ok) unless $ok eq "+OK\r\n";  
 }  
168    
169  sub _sock_send {          $size--;
         my $self = shift;  
         warn "## _sock_send ",dump( @_ );  
         print $sock join(' ',@_) . "\r\n";  
         _sock_result();  
 }  
170    
171  sub _sock_send_ok {          my @list = ( 0 .. $size );
172          my $self = shift;          foreach ( 0 .. $size ) {
173          warn "## _sock_send_ok ",dump( @_ );                  $list[ $_ ] = $self->__read_bulk( substr(<$sock>,1,-2) );
174          print $sock join(' ',@_) . "\r\n";          }
         __sock_ok();  
 }  
175    
176  sub __sock_send_bulk_raw {          warn "## list = ", Dumper( @list ) if $self->{debug};
177          my $self = shift;          return @list;
         warn "## _sock_send_bulk ",dump( @_ );  
         my $value = pop;  
         $value = '' unless defined $value; # FIXME errr? nil?  
         print $sock join(' ',@_) . ' ' . length($value) . "\r\n$value\r\n"  
178  }  }
179    
180  sub _sock_send_bulk {  1;
         __sock_send_bulk_raw( @_ );  
         __sock_ok();  
 }  
181    
182  sub _sock_send_bulk_number {  __END__
         __sock_send_bulk_raw( @_ );  
         my $v = _sock_result();  
         confess $v unless $v =~ m{^\-?\d+$};  
         return $v;  
 }  
183    
184  =head1 Connection Handling  =head1 Connection Handling
185    
# Line 125  sub _sock_send_bulk_number { Line 187  sub _sock_send_bulk_number {
187    
188    $r->quit;    $r->quit;
189    
 =cut  
   
 sub quit {  
         my $self = shift;  
   
         close( $sock ) || warn $!;  
 }  
   
190  =head2 ping  =head2 ping
191    
192    $r->ping || die "no server?";    $r->ping || die "no server?";
193    
 =cut  
   
 sub ping {  
         print $sock "PING\r\n";  
         my $pong = <$sock>;  
         die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n";  
 }  
   
194  =head1 Commands operating on string values  =head1 Commands operating on string values
195    
196  =head2 set  =head2 set
197    
198    $r->set( foo => 'bar', $new );    $r->set( foo => 'bar' );
   
 =cut  
199    
200  sub set {    $r->setnx( foo => 42 );
         my ( $self, $key, $value, $new ) = @_;  
         $self->_sock_send_bulk( "SET" . ( $new ? 'NX' : '' ), $key, $value );  
 }  
201    
202  =head2 get  =head2 get
203    
204    my $value = $r->get( 'foo' );    my $value = $r->get( 'foo' );
205    
206  =cut  =head2 mget
207    
208  sub get {    my @values = $r->mget( 'foo', 'bar', 'baz' );
         my $self = shift;  
         $self->_sock_result_bulk('GET', @_);  
 }  
209    
210  =head2 incr  =head2 incr
211    
212    $r->incr('counter');    $r->incr('counter');
   $r->incr('tripplets', 3);  
   
 =cut  
213    
214              $r->incrby('tripplets', 3);
   
 sub incr {  
         my $self = shift;  
         $self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ );  
 }  
215    
216  =head2 decr  =head2 decr
217    
218    $r->decr('counter');    $r->decr('counter');
   $r->decr('tripplets', 3);  
219    
220  =cut    $r->decrby('tripplets', 3);
   
 sub decr {  
         my $self = shift;  
         $self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ );  
 }  
221    
222  =head2 exists  =head2 exists
223    
224    $r->exists( 'key' ) && print "got key!";    $r->exists( 'key' ) && print "got key!";
225    
 =cut  
   
 sub exists {  
         my ( $self, $key ) = @_;  
         $self->_sock_send( 'EXISTS', $key );  
 }  
   
226  =head2 del  =head2 del
227    
228    $r->del( 'key' ) || warn "key doesn't exist";    $r->del( 'key' ) || warn "key doesn't exist";
229    
 =cut  
   
 sub del {  
         my ( $self, $key ) = @_;  
         $self->_sock_send( 'DEL', $key );  
 }  
   
230  =head2 type  =head2 type
231    
232    $r->type( 'key' ); # = string    $r->type( 'key' ); # = string
233    
 =cut  
   
 sub type {  
         my ( $self, $key ) = @_;  
         $self->_sock_send( 'TYPE', $key );  
 }  
   
234  =head1 Commands operating on the key space  =head1 Commands operating on the key space
235    
236  =head2 keys  =head2 keys
237    
238    my @keys = $r->keys( '*glob_pattern*' );    my @keys = $r->keys( '*glob_pattern*' );
239    
 =cut  
   
 sub keys {  
         my ( $self, $glob ) = @_;  
         return split(/\s/, $self->_sock_result_bulk( 'KEYS', $glob ));  
 }  
   
240  =head2 randomkey  =head2 randomkey
241    
242    my $key = $r->randomkey;    my $key = $r->randomkey;
243    
 =cut  
   
 sub randomkey {  
         my ( $self ) = @_;  
         $self->_sock_send( 'RANDOMKEY' );  
 }  
   
244  =head2 rename  =head2 rename
245    
246    my $ok = $r->rename( 'old-key', 'new-key', $new );    my $ok = $r->rename( 'old-key', 'new-key', $new );
247    
 =cut  
   
 sub rename {  
         my ( $self, $old, $new, $nx ) = @_;  
         $self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new );  
 }  
   
248  =head2 dbsize  =head2 dbsize
249    
250    my $nr_keys = $r->dbsize;    my $nr_keys = $r->dbsize;
251    
 =cut  
   
 sub dbsize {  
         my ( $self ) = @_;  
         $self->_sock_send('DBSIZE');  
 }  
   
252  =head1 Commands operating on lists  =head1 Commands operating on lists
253    
254    See also L<Redis::List> for tie interface.
255    
256  =head2 rpush  =head2 rpush
257    
258    $r->rpush( $key, $value );    $r->rpush( $key, $value );
259    
 =cut  
   
 sub rpush {  
         my ( $self, $key, $value ) = @_;  
         $self->_sock_send_bulk('RPUSH', $key, $value);  
 }  
   
260  =head2 lpush  =head2 lpush
261    
262    $r->lpush( $key, $value );    $r->lpush( $key, $value );
263    
 =cut  
   
 sub lpush {  
         my ( $self, $key, $value ) = @_;  
         $self->_sock_send_bulk('LPUSH', $key, $value);  
 }  
   
264  =head2 llen  =head2 llen
265    
266    $r->llen( $key );    $r->llen( $key );
267    
 =cut  
   
 sub llen {  
         my ( $self, $key ) = @_;  
         $self->_sock_send( 'LLEN', $key );  
 }  
   
268  =head2 lrange  =head2 lrange
269    
270    my @list = $r->lrange( $key, $start, $end );    my @list = $r->lrange( $key, $start, $end );
271    
272  =cut  =head2 ltrim
273    
274  sub lrange {    my $ok = $r->ltrim( $key, $start, $end );
         my ( $self, $key, $start, $end ) = @_;  
         my $size = $self->_sock_send('LRANGE', $key, $start, $end);  
275    
276          confess $size unless $size > 0;  =head2 lindex
         $size--;  
277    
278          my @list = ( 0 .. $size );    $r->lindex( $key, $index );
         foreach ( 0 .. $size ) {  
                 $list[ $_ ] = _sock_read_bulk();  
         }  
279    
280          warn "## lrange $key $start $end = [$size] ", dump( @list );  =head2 lset
         return @list;  
 }  
281    
282  =head2 ltrim    $r->lset( $key, $index, $value );
283    
284    my $ok = $r->ltrim( $key, $start, $end );  =head2 lrem
285    
286  =cut    my $modified_count = $r->lrem( $key, $count, $value );
287    
288  sub ltrim {  =head2 lpop
         my ( $self, $key, $start, $end ) = @_;  
         $self->_sock_send_ok( 'LTRIM', $key, $start, $end );  
 }  
289    
290  =head2 lindex    my $value = $r->lpop( $key );
291    
292    $r->lindex( $key, $index );  =head2 rpop
293    
294  =cut    my $value = $r->rpop( $key );
295    
296  sub lindex {  =head1 Commands operating on sets
         my ( $self, $key, $index ) = @_;  
         $self->_sock_result_bulk( 'LINDEX', $key, $index );  
 }  
297    
298  =head2 lset  =head2 sadd
299    
300    $r->lset( $key, $index, $value );    $r->sadd( $key, $member );
301    
302  =cut  =head2 srem
303    
304  sub lset {    $r->srem( $key, $member );
         my ( $self, $key, $index, $value ) = @_;  
         $self->_sock_send_bulk( 'LSET', $key, $index, $value );  
 }  
305    
306  =head2 lrem  =head2 scard
307    
308    my $modified_count = $r->lrem( $key, $count, $value );    my $elements = $r->scard( $key );
309    
310  =cut  =head2 sismember
311    
312  sub lrem {    $r->sismember( $key, $member );
         my ( $self, $key, $count, $value ) = @_;  
         $self->_sock_send_bulk_number( 'LREM', $key, $count, $value );  
 }  
313    
314  =head2 lpop  =head2 sinter
315    
316    my $value = $r->lpop( $key );    $r->sinter( $key1, $key2, ... );
317    
318  =cut  =head2 sinterstore
319    
320  sub lpop {    my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... );
         my ( $self, $key ) = @_;  
         $self->_sock_result_bulk( 'LPOP', $key );  
 }  
321    
322  =head2 rpop  =head1 Multiple databases handling commands
323    
324    my $value = $r->rpop( $key );  =head2 select
325    
326  =cut    $r->select( $dbindex ); # 0 for new clients
327    
328  sub rpop {  =head2 move
         my ( $self, $key ) = @_;  
         $self->_sock_result_bulk( 'RPOP', $key );  
 }  
329    
330  =head1 Commands operating on sets    $r->move( $key, $dbindex );
331    
332  =head2 sadd  =head2 flushdb
333    
334    $r->sadd( $key, $member );    $r->flushdb;
335    
336  =cut  =head2 flushall
337    
338  sub sadd {    $r->flushall;
         my ( $self, $key, $member ) = @_;  
         $self->_sock_send_bulk_number( 'SADD', $key, $member );  
 }  
339    
340  =head2 srem  =head1 Sorting
341    
342    $r->srem( $key, $member );  =head2 sort
343    
344  =cut    $r->sort("key BY pattern LIMIT start end GET pattern ASC|DESC ALPHA');
345    
346  sub srem {  =head1 Persistence control commands
         my ( $self, $key, $member ) = @_;  
         $self->_sock_send_bulk_number( 'SREM', $key, $member );  
 }  
347    
348  =head2 scard  =head2 save
349    
350    my $elements = $r->scard( $key );    $r->save;
351    
352  =cut  =head2 bgsave
353    
354  sub scard {    $r->bgsave;
         my ( $self, $key ) = @_;  
         $self->_sock_send( 'SCARD', $key );  
 }  
355    
356  =head2 sismember  =head2 lastsave
357    
358    $r->sismember( $key, $member );    $r->lastsave;
359    
360  =cut  =head2 shutdown
361    
362  sub sismember {    $r->shutdown;
363          my ( $self, $key, $member ) = @_;  
364          $self->_sock_send_bulk_number( 'SISMEMBER', $key, $member );  =head1 Remote server control commands
365  }  
366    =head2 info
367    
368      my $info_hash = $r->info;
369    
370  =head1 AUTHOR  =head1 AUTHOR
371    
# Line 461  automatically be notified of progress on Line 385  automatically be notified of progress on
385  You can find documentation for this module with the perldoc command.  You can find documentation for this module with the perldoc command.
386    
387      perldoc Redis      perldoc Redis
388            perldoc Redis::List
389            perldoc Redis::Hash
390    
391    
392  You can also look for information at:  You can also look for information at:
Legend:
Removed from v.32  
changed lines
  Added in v.65
  ViewVC Help
Powered by ViewVC 1.1.26