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/confess cluck croak/;
use File::Slurp;

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

=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 || confess "can't get_request";

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