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 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_nr = 0;

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 ) {
                carp "can't get_request";
                return 0;
        }

        my $xml = $r->content;

        my $size = length( $xml );

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

        $dump_nr++;
        my $file = sprintf("dump/%04d-%s.request", $dump_nr, $sock->peerhost);

        if ( $self->create_dump ) {
                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->{_dispatch} ) && $self->create_dump ) {
                        my $type = sprintf("dump/%04d-%s-%s", $dump_nr, $sock->peerhost, $state->{_dispatch});
                        symlink $file, $type || warn "can't symlink $file -> $type: $!";
                }

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

                if ( ! defined( $state->{DeviceID} ) ) {
                        warn "## state with DeviceID, using old one...\n";
                        $state->{DeviceID} = $self->state->{DeviceID};
                }

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