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
store

sock
state
queue
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 => 'state.db',
        queue => [
                'GetRPCMethods',
                [ 'GetParameterValyes', 'InternetGatewayDevice.DeviceInfo.SerialNumber', 0 ],
        ],
        debug => 1,
  });

=cut

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

        confess "need sock" unless $self->sock;

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

        warn "created ", __PACKAGE__, "(", dump( @_ ), ") for ", $self->sock->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 );

        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->debug > 2 ) {
                write_file( $file, $r->as_string );
                warn "### request dumped to file: $file\n";
        }

        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->debug > 2 ) {
                        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";

                $self->state( $state );
                $self->store->update_state( ID => $state->{ID}, $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: AcmeCWMP/42',
                'SOAPServer: AcmeCWMP/42'
        )."\r\n");

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

        if ( my $dispatch = $state->{_dispatch} ) {
                $xml = $self->dispatch( $dispatch );
        } elsif ( $dispatch = shift @{ $self->queue } ) {
                $xml = $self->dispatch( $dispatch );
        } elsif ( $size == 0 ) {
                warn ">>> no more queued commands, closing connection\n";
                return 0;
        } else {
                warn ">>> empty response\n";
                $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\n";

        warn "### request over\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 = @_;

        if ( ref($dispatch) eq 'ARRAY' ) {
                my @a = @$dispatch;
                $dispatch = shift @a;
                push @args, @a;
        }

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

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