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_path

sock
state
queue
store
/ );

use HTTP::Daemon;
use Data::Dump qw/dump/;
use Carp qw/confess cluck croak/;

use CWMP::Request;
use CWMP::Response;
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_path => 'state.db',
        queue => [ qw/GetRPCMethods GetParameterNames/ ],
        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;

        $self->store( CWMP::Store->new({
                debug => $self->debug,
                path => $self->store_path,
        }) );

        croak "can't open ", $self->store_path, ": $!" unless $self->store;

        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.

=cut

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";

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

        my $chunk = $r->content;

        my $size = length( $chunk );

        warn "<<<< " . $sock->peerhost . " [" . localtime() . "] request $size bytes\n";

        my $state;

        if ( $size > 0 ) {

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


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

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

                        warn "## acquired state = ", dump( $state ), "\n";

                        $self->state( $state );
                        $self->store->update_state( ID => $state->{ID}, $state );

                } else {
                        warn "## empty request\n";
                }

        } else {
                $state = $self->state;
                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} );
        
        my $xml = '';

        if ( my $dispatch = $state->{_dispatch} ) {
                $xml = $self->dispatch( $dispatch );
        } elsif ( $dispatch = shift @{ $self->queue } ) {
                $xml = $self->dispatch( $dispatch );
        } elsif ( $size == 0 ) {
                warn ">>> 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 );

=cut

sub dispatch {
        my $self = shift;

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

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

        if ( $response->can( $dispatch ) ) {
                warn ">>> dispatching to $dispatch\n";
                my $xml = $response->$dispatch( $self->state, @_ );
                warn "## response payload: ",length($xml)," bytes\n$xml\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	77	store_path
11
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
22	dpavlin	35	use CWMP::Request;
23			use CWMP::Response;
24	dpavlin	77	use CWMP::Store;
25	dpavlin	30
26	dpavlin	34	=head1 NAME
27
28	dpavlin	82	CWMP::Session - implement logic of CWMP protocol
29	dpavlin	34
30			=head1 METHODS
31
32	dpavlin	40	=head2 new
33	dpavlin	34
34	dpavlin	82	my $server = CWMP::Session->new({
35	dpavlin	110	sock => $io_socket_object,
36	dpavlin	77	store_path => 'state.db',
37	dpavlin	83	queue => [ qw/GetRPCMethods GetParameterNames/ ],
38	dpavlin	77	debug => 1,
39			});
40	dpavlin	34
41			=cut
42
43	dpavlin	83	sub new {
44			my $class = shift;
45			my $self = $class->SUPER::new( @_ );
46	dpavlin	30
47	dpavlin	83	confess "need sock" unless $self->sock;
48	dpavlin	40
49	dpavlin	84	$self->debug( 0 ) unless $self->debug;
50
51	dpavlin	83	warn "created ", __PACKAGE__, "(", dump( @_ ), ") for ", $self->sock->peerhost, "\n" if $self->debug;
52	dpavlin	40
53	dpavlin	77	$self->store( CWMP::Store->new({
54			debug => $self->debug,
55			path => $self->store_path,
56			}) );
57	dpavlin	83
58	dpavlin	77	croak "can't open ", $self->store_path, ": $!" unless $self->store;
59
60	dpavlin	83	return $self;
61	dpavlin	40	}
62
63	dpavlin	48	=head2 process_request
64
65			One request from client/response from server cycle. Call multiple times to
66			facilitate brain-dead concept of adding state to stateless protocol like
67			HTTP.
68
69			=cut
70
71	dpavlin	40	sub process_request {
72			my $self = shift;
73
74	dpavlin	42	my $sock = $self->sock \|\| die "no sock?";
75	dpavlin	40
76	dpavlin	110	# die "not IO::Socket::INET but ", ref( $sock ) unless ( ref($sock) eq 'Net::Server::Proto::TCP' );
77	dpavlin	40
78	dpavlin	42	if ( ! $sock->connected ) {
79	dpavlin	53	warn "SOCKET NOT CONNECTED\n";
80	dpavlin	42	return 0;
81			}
82
83	dpavlin	110	bless $sock, 'HTTP::Daemon::ClientConn';
84	dpavlin	40
85	dpavlin	110	# why do I have to do this?
86			# solution from http://use.perl.org/~Matts/journal/12896
87			${*$sock}{'httpd_daemon'} = HTTP::Daemon->new;
88	dpavlin	40
89	dpavlin	110	my $r = $sock->get_request \|\| confess "can't get_request";
90	dpavlin	40
91	dpavlin	110	warn "<<<< ", $sock->peerhost, " - - [" . localtime() . "] ", $r->method, " ", $r->uri, "\n";
92	dpavlin	40
93	dpavlin	110	my $chunk = $r->content;
94	dpavlin	40
95	dpavlin	49	my $size = length( $chunk );
96	dpavlin	34
97	dpavlin	72	warn "<<<< " . $sock->peerhost . " [" . localtime() . "] request $size bytes\n";
98	dpavlin	34
99	dpavlin	36	my $state;
100
101	dpavlin	49	if ( $size > 0 ) {
102	dpavlin	30
103	dpavlin	110	die "no SOAPAction header in ",dump($chunk) unless defined ( $r->header('SOAPAction') );
104	dpavlin	34
105	dpavlin	49
106			if ( $chunk ) {
107			warn "## request chunk: ",length($chunk)," bytes\n$chunk\n" if $self->debug;
108
109			$state = CWMP::Request->parse( $chunk );
110
111	dpavlin	70	warn "## acquired state = ", dump( $state ), "\n";
112	dpavlin	49
113			$self->state( $state );
114	dpavlin	100	$self->store->update_state( ID => $state->{ID}, $state );
115	dpavlin	49
116			} else {
117	dpavlin	70	warn "## empty request\n";
118	dpavlin	49	}
119
120	dpavlin	36	} else {
121	dpavlin	49	$state = $self->state;
122	dpavlin	67	warn "last request state = ", dump( $state ), "\n" if $self->debug > 1;
123	dpavlin	34	}
124
125
126	dpavlin	44	$sock->send(join("\r\n",
127			'HTTP/1.1 200 OK',
128			'Content-Type: text/xml; charset="utf-8"',
129			'Server: AcmeCWMP/42',
130	dpavlin	49	'SOAPServer: AcmeCWMP/42'
131	dpavlin	54	)."\r\n");
132	dpavlin	30
133	dpavlin	43	$sock->send( "Set-Cookie: ID=" . $state->{ID} . "; path=/\r\n" ) if ( $state->{ID} );
134	dpavlin	40
135			my $xml = '';
136
137	dpavlin	36	if ( my $dispatch = $state->{_dispatch} ) {
138	dpavlin	50	$xml = $self->dispatch( $dispatch );
139			} elsif ( $dispatch = shift @{ $self->queue } ) {
140			$xml = $self->dispatch( $dispatch );
141			} elsif ( $size == 0 ) {
142			warn ">>> closing connection\n";
143			return 0;
144	dpavlin	36	} else {
145			warn ">>> empty response\n";
146	dpavlin	50	$state->{NoMoreRequests} = 1;
147			$xml = $self->dispatch( 'xml', sub {} );
148	dpavlin	36	}
149	dpavlin	40
150	dpavlin	43	$sock->send( "Content-Length: " . length( $xml ) . "\r\n\r\n" );
151	dpavlin	44	$sock->send( $xml ) or die "can't send response";
152	dpavlin	40
153	dpavlin	72	warn ">>>> " . $sock->peerhost . " [" . localtime() . "] sent ", length( $xml )," bytes\n";
154
155	dpavlin	70	warn "### request over\n" if $self->debug;
156	dpavlin	40
157	dpavlin	72	return 1; # next request
158	dpavlin	30	};
159
160	dpavlin	50	=head2 dispatch
161
162			$xml = $self->dispatch('Inform', $response_arguments );
163
164			=cut
165
166			sub dispatch {
167			my $self = shift;
168
169			my $dispatch = shift \|\| die "no dispatch?";
170
171			my $response = CWMP::Response->new({ debug => $self->debug });
172
173			if ( $response->can( $dispatch ) ) {
174			warn ">>> dispatching to $dispatch\n";
175	dpavlin	72	my $xml = $response->$dispatch( $self->state, @_ );
176	dpavlin	53	warn "## response payload: ",length($xml)," bytes\n$xml\n" if $self->debug;
177	dpavlin	50	return $xml;
178			} else {
179			confess "can't dispatch to $dispatch";
180			}
181			};
182
183	dpavlin	40
184	dpavlin	48	=head2 error
185
186			return $self->error( 501, 'System error' );
187
188			=cut
189
190	dpavlin	44	sub error {
191	dpavlin	40	my ($self, $number, $msg) = @_;
192	dpavlin	44	$msg \|\|= 'ERROR';
193			$self->sock->send( "HTTP/1.1 $number $msg\r\n" );
194	dpavlin	40	warn "Error - $number - $msg\n";
195	dpavlin	48	return 0; # close connection
196	dpavlin	40	}
197
198	dpavlin	30	1;