lib/CWMP/Session.pm

# Dobrica Pavlinusic, <dpavlin@rot13.org> 06/18/07 10:19:50 CEST
package CWMP::Session;

use strict;
use warnings;

use base qw/Class::Accessor/;
__PACKAGE__->mk_accessors( qw/
debug
create_dump
session

sock
state
store
/ );

use HTTP::Daemon;
use Data::Dump qw/dump/;
use Carp qw/carp confess cluck croak/;
use File::Slurp;
use File::Path qw/mkpath/;

use CWMP::Request;
use CWMP::Methods;
use CWMP::Store;

#use Devel::LeakTrace::Fast;

=head1 NAME

CWMP::Session - implement logic of CWMP protocol

=head1 METHODS

=head2 new

  my $server = CWMP::Session->new({
        sock => $io_socket_object,
        store => { ... },
        debug => 1,
        create_dump => 1,
  });

=cut

sub new {
        my $class = shift;
        my $self = $class->SUPER::new( @_ );

        confess "need sock" unless $self->sock;
        confess "need store" unless $self->store;
        my $peerhost = $self->sock->peerhost || confess "can't get sock->peerhost";

        $self->debug( 0 ) unless $self->debug;

        warn "created ", __PACKAGE__, "(", dump( @_ ), ") for $peerhost\n" if $self->debug;

        my $store_obj = CWMP::Store->new({
                debug => $self->debug,
                %{ $self->store },
        });

        croak "can't open ", dump( $self->store ), ": $!" unless $store_obj;

        # FIXME looks ugly. Should we have separate accessor for this?
        $self->store( $store_obj );

        $self->create_dump( 1 ) if $self->debug > 2;

        return $self;
}

=head2 process_request

One request from client/response from server cycle. Call multiple times to
facilitate brain-dead concept of adding state to stateless protocol like
HTTP.

If used with debugging level of 3 or more, it will also create dumps of
requests named C<< dump/nr.request >> where C<nr> is number from 0 to total number
of requests in single session.

=cut

my $dump_by_ip;

sub process_request {
        my $self = shift;

        my $sock = $self->sock || die "no sock?";

#       die "not IO::Socket::INET but ", ref( $sock ) unless ( ref($sock) eq 'Net::Server::Proto::TCP' );

        if ( ! $sock->connected ) {
                warn "SOCKET NOT CONNECTED\n";
                return 0;
        }

        bless $sock, 'HTTP::Daemon::ClientConn';

        # why do I have to do this?
        # solution from http://use.perl.org/~Matts/journal/12896
        ${*$sock}{'httpd_daemon'} = HTTP::Daemon->new;

        my $r = $sock->get_request;
        
        if ( ! $r ) {
                warn "WARNING: can't get_request\n";
                return 0;
        }

        my $ip = $sock->peerhost || confess "can't get peerhost from sock: $!";

        my $xml = $r->content;

        my $size = length( $xml );

        warn "<<<< $ip [" . localtime() . "] ", $r->method, " ", $r->uri, " $size bytes\n";

        my $dump_nr = $dump_by_ip->{$ip}++;
        my $file = sprintf("./dump/%s/%04d.request", $ip, $dump_nr);

        if ( $self->create_dump ) {
                mkpath "dump/$ip" unless -e "dump/$ip";
                write_file( $file, $r->as_string );
                warn "### request dumped to file: $file\n" if $self->debug;
        }

        my $state;

        if ( $size > 0 ) {

                die "no SOAPAction header in ",dump($xml) unless defined ( $r->header('SOAPAction') );

                warn "## request payload: ",length($xml)," bytes\n$xml\n" if $self->debug;

                $state = CWMP::Request->parse( $xml );

                if ( defined( $state->{_trigger} ) && $self->create_dump ) {
                        my $type = sprintf("dump/%s/%04d-%s", $ip, $dump_nr, $state->{_trigger});
                        $file =~ s!^.*?([^/]+)$!$1!;    #!vim
                        symlink $file, $type || warn "can't symlink $file -> $type: $!";
                }

                warn "## acquired state = ", dump( $state ), "\n" if $self->debug;

                if ( ! defined( $state->{DeviceID} ) ) {
                        if ( $self->state ) {
                                warn "## state without DeviceID, using old one...\n";
                                $state->{DeviceID} = $self->state->{DeviceID};
                        } else {
                                warn "WARNING: state without DeviceID, and I don't have old one!\n";
                                warn "## state = ",dump( $state );
                        }
                }

                $self->state( $state );
                $self->store->update_state( $state );

        } else {

                warn "## empty request, using last request state\n";

                $state = $self->state;
                delete( $state->{_dispatch} );
                #warn "last request state = ", dump( $state ), "\n" if $self->debug > 1;
        }

        $sock->send(join("\r\n",
                'HTTP/1.1 200 OK',
                'Content-Type: text/xml; charset="utf-8"',
                'Server: PerlCWMP/42',
                'SOAPServer: PerlCWMP/42'
        )."\r\n");

        $sock->send( "Set-Cookie: ID=" . $state->{ID} . "; path=/\r\n" ) if ( $state->{ID} );

        my $uid = $self->store->state_to_uid( $state );

        my $to_uid = join(" ", grep { defined($_) } "to $uid",
                        # board
                        $state->{Parameter}->{'InternetGatewayDevice.DeviceInfo.HardwareVersion'},
                        # version
                        $state->{Parameter}->{'InternetGatewayDevice.DeviceInfo.SoftwareVersion'},
                        # summary
#                       $state->{Parameter}->{'InternetGatewayDevice.DeviceSummary'},
        ) . "\n";

        my $queue = CWMP::Queue->new({
                id => $uid,
                debug => $self->debug,
        });
        my $job;
        $xml = '';

        if ( my $dispatch = $state->{_dispatch} ) {
                $xml = $self->dispatch( $dispatch );
        } elsif ( $job = $queue->dequeue ) {
                $xml = $self->dispatch( $job->dispatch );
        } elsif ( $size == 0 ) {
                warn ">>> over, closing connection $to_uid";
                $sock->close;
                return;
        } else {
                warn ">>> empty response $to_uid";
                $state->{NoMoreRequests} = 1;
                $xml = $self->dispatch( 'xml', sub {} );
        }

        $sock->send( "Content-Length: " . length( $xml ) . "\r\n\r\n" );
        $sock->send( $xml ) or die "can't send response";

        warn ">>>> " . $ip . " [" . localtime() . "] sent ", length( $xml )," bytes $to_uid";

        $job->finish if $job;
        warn "### request over for $uid\n" if $self->debug;

        return 1;       # next request
};

=head2 dispatch

  $xml = $self->dispatch('Inform', $response_arguments );

If debugging level of 3 or more, it will create dumps of responses named C<< dump/nr.response >>

=cut

sub dispatch {
        my $self = shift;

        my $dispatch = shift || die "no dispatch?";
        my $args = shift;

        my $response = CWMP::Methods->new({ debug => $self->debug });

        if ( $response->can( $dispatch ) ) {
                warn ">>> dispatching to $dispatch with args ",dump( $args ),"\n";
                my $xml = $response->$dispatch( $self->state, $args );
                warn "## response payload: ",length($xml)," bytes\n$xml\n" if $self->debug;
                if ( $self->create_dump ) {
                        my $ip = $self->sock->peerhost || confess "can't get sock->peerhost: $!";
                        my $dump_nr = $dump_by_ip->{$ip}++;
                        my $file = sprintf("dump/%s/%04d.response", $ip, $dump_nr );
                        write_file( $file, $xml );
                        warn "### response dump: $file\n" if $self->debug;
                }
                return $xml;
        } else {
                confess "can't dispatch to $dispatch";
        }
};


=head2 error

  return $self->error( 501, 'System error' );

=cut

sub error {
  my ($self, $number, $msg) = @_;
  $msg ||= 'ERROR';
  $self->sock->send( "HTTP/1.1 $number $msg\r\n" );
  warn "Error - $number - $msg\n";
  return 0;     # close connection
}

1;
1	dpavlin	30	# Dobrica Pavlinusic, <dpavlin@rot13.org> 06/18/07 10:19:50 CEST
2	dpavlin	82	package CWMP::Session;
3	dpavlin	30
4			use strict;
5			use warnings;
6
7	dpavlin	40	use base qw/Class::Accessor/;
8	dpavlin	30	__PACKAGE__->mk_accessors( qw/
9			debug
10	dpavlin	202	create_dump
11	dpavlin	205	session
12	dpavlin	77
13	dpavlin	41	sock
14	dpavlin	49	state
15	dpavlin	77	store
16	dpavlin	30	/ );
17
18	dpavlin	110	use HTTP::Daemon;
19	dpavlin	30	use Data::Dump qw/dump/;
20	dpavlin	223	use Carp qw/carp confess cluck croak/;
21	dpavlin	111	use File::Slurp;
22	dpavlin	230	use File::Path qw/mkpath/;
23	dpavlin	77
24	dpavlin	35	use CWMP::Request;
25	dpavlin	173	use CWMP::Methods;
26	dpavlin	77	use CWMP::Store;
27	dpavlin	30
28	dpavlin	223	#use Devel::LeakTrace::Fast;
29
30	dpavlin	34	=head1 NAME
31
32	dpavlin	82	CWMP::Session - implement logic of CWMP protocol
33	dpavlin	34
34			=head1 METHODS
35
36	dpavlin	40	=head2 new
37	dpavlin	34
38	dpavlin	82	my $server = CWMP::Session->new({
39	dpavlin	110	sock => $io_socket_object,
40	dpavlin	205	store => { ... },
41	dpavlin	77	debug => 1,
42	dpavlin	202	create_dump => 1,
43	dpavlin	77	});
44	dpavlin	34
45			=cut
46
47	dpavlin	83	sub new {
48			my $class = shift;
49			my $self = $class->SUPER::new( @_ );
50	dpavlin	30
51	dpavlin	83	confess "need sock" unless $self->sock;
52	dpavlin	205	confess "need store" unless $self->store;
53			my $peerhost = $self->sock->peerhost \|\| confess "can't get sock->peerhost";
54	dpavlin	40
55	dpavlin	84	$self->debug( 0 ) unless $self->debug;
56
57	dpavlin	205	warn "created ", __PACKAGE__, "(", dump( @_ ), ") for $peerhost\n" if $self->debug;
58	dpavlin	40
59	dpavlin	150	my $store_obj = CWMP::Store->new({
60	dpavlin	77	debug => $self->debug,
61	dpavlin	150	%{ $self->store },
62			});
63	dpavlin	83
64	dpavlin	150	croak "can't open ", dump( $self->store ), ": $!" unless $store_obj;
65	dpavlin	77
66	dpavlin	150	# FIXME looks ugly. Should we have separate accessor for this?
67			$self->store( $store_obj );
68
69	dpavlin	202	$self->create_dump( 1 ) if $self->debug > 2;
70
71	dpavlin	83	return $self;
72	dpavlin	40	}
73
74	dpavlin	48	=head2 process_request
75
76			One request from client/response from server cycle. Call multiple times to
77			facilitate brain-dead concept of adding state to stateless protocol like
78			HTTP.
79
80	dpavlin	111	If used with debugging level of 3 or more, it will also create dumps of
81	dpavlin	117	requests named C<< dump/nr.request >> where C<nr> is number from 0 to total number
82	dpavlin	111	of requests in single session.
83
84	dpavlin	48	=cut
85
86	dpavlin	230	my $dump_by_ip;
87	dpavlin	111
88	dpavlin	40	sub process_request {
89			my $self = shift;
90
91	dpavlin	42	my $sock = $self->sock \|\| die "no sock?";
92	dpavlin	40
93	dpavlin	110	# die "not IO::Socket::INET but ", ref( $sock ) unless ( ref($sock) eq 'Net::Server::Proto::TCP' );
94	dpavlin	40
95	dpavlin	42	if ( ! $sock->connected ) {
96	dpavlin	53	warn "SOCKET NOT CONNECTED\n";
97	dpavlin	42	return 0;
98			}
99
100	dpavlin	110	bless $sock, 'HTTP::Daemon::ClientConn';
101	dpavlin	40
102	dpavlin	110	# why do I have to do this?
103			# solution from http://use.perl.org/~Matts/journal/12896
104			${*$sock}{'httpd_daemon'} = HTTP::Daemon->new;
105	dpavlin	40
106	dpavlin	223	my $r = $sock->get_request;
107
108			if ( ! $r ) {
109	dpavlin	234	warn "WARNING: can't get_request\n";
110	dpavlin	223	return 0;
111			}
112	dpavlin	40
113	dpavlin	230	my $ip = $sock->peerhost \|\| confess "can't get peerhost from sock: $!";
114
115	dpavlin	169	my $xml = $r->content;
116	dpavlin	40
117	dpavlin	169	my $size = length( $xml );
118	dpavlin	34
119	dpavlin	230	warn "<<<< $ip [" . localtime() . "] ", $r->method, " ", $r->uri, " $size bytes\n";
120	dpavlin	34
121	dpavlin	230	my $dump_nr = $dump_by_ip->{$ip}++;
122			my $file = sprintf("./dump/%s/%04d.request", $ip, $dump_nr);
123	dpavlin	177
124	dpavlin	202	if ( $self->create_dump ) {
125	dpavlin	230	mkpath "dump/$ip" unless -e "dump/$ip";
126	dpavlin	111	write_file( $file, $r->as_string );
127	dpavlin	209	warn "### request dumped to file: $file\n" if $self->debug;
128	dpavlin	111	}
129
130	dpavlin	36	my $state;
131
132	dpavlin	49	if ( $size > 0 ) {
133	dpavlin	30
134	dpavlin	169	die "no SOAPAction header in ",dump($xml) unless defined ( $r->header('SOAPAction') );
135	dpavlin	34
136	dpavlin	169	warn "## request payload: ",length($xml)," bytes\n$xml\n" if $self->debug;
137	dpavlin	49
138	dpavlin	169	$state = CWMP::Request->parse( $xml );
139
140	dpavlin	230	if ( defined( $state->{_trigger} ) && $self->create_dump ) {
141			my $type = sprintf("dump/%s/%04d-%s", $ip, $dump_nr, $state->{_trigger});
142			$file =~ s!^.*?([^/]+)$!$1!; #!vim
143	dpavlin	177	symlink $file, $type \|\| warn "can't symlink $file -> $type: $!";
144			}
145
146	dpavlin	209	warn "## acquired state = ", dump( $state ), "\n" if $self->debug;
147	dpavlin	49
148	dpavlin	202	if ( ! defined( $state->{DeviceID} ) ) {
149	dpavlin	234	if ( $self->state ) {
150			warn "## state without DeviceID, using old one...\n";
151			$state->{DeviceID} = $self->state->{DeviceID};
152			} else {
153			warn "WARNING: state without DeviceID, and I don't have old one!\n";
154			warn "## state = ",dump( $state );
155			}
156	dpavlin	202	}
157
158	dpavlin	119	$self->state( $state );
159	dpavlin	208	$self->store->update_state( $state );
160	dpavlin	49
161	dpavlin	119	} else {
162	dpavlin	49
163	dpavlin	150	warn "## empty request, using last request state\n";
164	dpavlin	49
165			$state = $self->state;
166	dpavlin	119	delete( $state->{_dispatch} );
167	dpavlin	150	#warn "last request state = ", dump( $state ), "\n" if $self->debug > 1;
168	dpavlin	34	}
169
170	dpavlin	44	$sock->send(join("\r\n",
171			'HTTP/1.1 200 OK',
172			'Content-Type: text/xml; charset="utf-8"',
173	dpavlin	210	'Server: PerlCWMP/42',
174			'SOAPServer: PerlCWMP/42'
175	dpavlin	54	)."\r\n");
176	dpavlin	30
177	dpavlin	43	$sock->send( "Set-Cookie: ID=" . $state->{ID} . "; path=/\r\n" ) if ( $state->{ID} );
178	dpavlin	197
179	dpavlin	208	my $uid = $self->store->state_to_uid( $state );
180	dpavlin	198
181	dpavlin	211	my $to_uid = join(" ", grep { defined($_) } "to $uid",
182	dpavlin	210	# board
183			$state->{Parameter}->{'InternetGatewayDevice.DeviceInfo.HardwareVersion'},
184			# version
185			$state->{Parameter}->{'InternetGatewayDevice.DeviceInfo.SoftwareVersion'},
186			# summary
187			# $state->{Parameter}->{'InternetGatewayDevice.DeviceSummary'},
188			) . "\n";
189
190	dpavlin	197	my $queue = CWMP::Queue->new({
191	dpavlin	198	id => $uid,
192	dpavlin	197	debug => $self->debug,
193			});
194			my $job;
195	dpavlin	170	$xml = '';
196	dpavlin	40
197	dpavlin	36	if ( my $dispatch = $state->{_dispatch} ) {
198	dpavlin	50	$xml = $self->dispatch( $dispatch );
199	dpavlin	197	} elsif ( $job = $queue->dequeue ) {
200			$xml = $self->dispatch( $job->dispatch );
201	dpavlin	50	} elsif ( $size == 0 ) {
202	dpavlin	224	warn ">>> over, closing connection $to_uid";
203	dpavlin	223	$sock->close;
204			return;
205	dpavlin	36	} else {
206	dpavlin	210	warn ">>> empty response $to_uid";
207	dpavlin	50	$state->{NoMoreRequests} = 1;
208			$xml = $self->dispatch( 'xml', sub {} );
209	dpavlin	36	}
210	dpavlin	40
211	dpavlin	43	$sock->send( "Content-Length: " . length( $xml ) . "\r\n\r\n" );
212	dpavlin	44	$sock->send( $xml ) or die "can't send response";
213	dpavlin	40
214	dpavlin	230	warn ">>>> " . $ip . " [" . localtime() . "] sent ", length( $xml )," bytes $to_uid";
215	dpavlin	72
216	dpavlin	197	$job->finish if $job;
217	dpavlin	198	warn "### request over for $uid\n" if $self->debug;
218	dpavlin	40
219	dpavlin	72	return 1; # next request
220	dpavlin	30	};
221
222	dpavlin	50	=head2 dispatch
223
224			$xml = $self->dispatch('Inform', $response_arguments );
225
226	dpavlin	117	If debugging level of 3 or more, it will create dumps of responses named C<< dump/nr.response >>
227
228	dpavlin	50	=cut
229
230			sub dispatch {
231			my $self = shift;
232
233			my $dispatch = shift \|\| die "no dispatch?";
234	dpavlin	199	my $args = shift;
235	dpavlin	50
236	dpavlin	173	my $response = CWMP::Methods->new({ debug => $self->debug });
237	dpavlin	50
238			if ( $response->can( $dispatch ) ) {
239	dpavlin	199	warn ">>> dispatching to $dispatch with args ",dump( $args ),"\n";
240			my $xml = $response->$dispatch( $self->state, $args );
241	dpavlin	53	warn "## response payload: ",length($xml)," bytes\n$xml\n" if $self->debug;
242	dpavlin	202	if ( $self->create_dump ) {
243	dpavlin	230	my $ip = $self->sock->peerhost \|\| confess "can't get sock->peerhost: $!";
244			my $dump_nr = $dump_by_ip->{$ip}++;
245			my $file = sprintf("dump/%s/%04d.response", $ip, $dump_nr );
246	dpavlin	117	write_file( $file, $xml );
247	dpavlin	209	warn "### response dump: $file\n" if $self->debug;
248	dpavlin	117	}
249	dpavlin	50	return $xml;
250			} else {
251			confess "can't dispatch to $dispatch";
252			}
253			};
254
255	dpavlin	40
256	dpavlin	48	=head2 error
257
258			return $self->error( 501, 'System error' );
259
260			=cut
261
262	dpavlin	44	sub error {
263	dpavlin	40	my ($self, $number, $msg) = @_;
264	dpavlin	44	$msg \|\|= 'ERROR';
265			$self->sock->send( "HTTP/1.1 $number $msg\r\n" );
266	dpavlin	40	warn "Error - $number - $msg\n";
267	dpavlin	48	return 0; # close connection
268	dpavlin	40	}
269
270	dpavlin	30	1;