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 |
|
|
use CWMP::Response; |
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 |
111 |
if ( $self->debug > 2 ) { |
111 |
dpavlin |
127 |
my $file = sprintf("dump/%04d-%s.request", $dump_nr++, $sock->peerhost); |
112 |
dpavlin |
111 |
write_file( $file, $r->as_string ); |
113 |
dpavlin |
169 |
warn "### request dumped to file: $file\n"; |
114 |
dpavlin |
111 |
} |
115 |
|
|
|
116 |
dpavlin |
36 |
my $state; |
117 |
|
|
|
118 |
dpavlin |
49 |
if ( $size > 0 ) { |
119 |
dpavlin |
30 |
|
120 |
dpavlin |
169 |
die "no SOAPAction header in ",dump($xml) unless defined ( $r->header('SOAPAction') ); |
121 |
dpavlin |
34 |
|
122 |
dpavlin |
169 |
warn "## request payload: ",length($xml)," bytes\n$xml\n" if $self->debug; |
123 |
dpavlin |
49 |
|
124 |
dpavlin |
169 |
$state = CWMP::Request->parse( $xml ); |
125 |
|
|
|
126 |
dpavlin |
119 |
warn "## acquired state = ", dump( $state ), "\n"; |
127 |
dpavlin |
49 |
|
128 |
dpavlin |
119 |
$self->state( $state ); |
129 |
|
|
$self->store->update_state( ID => $state->{ID}, $state ); |
130 |
dpavlin |
49 |
|
131 |
dpavlin |
119 |
} else { |
132 |
dpavlin |
49 |
|
133 |
dpavlin |
150 |
warn "## empty request, using last request state\n"; |
134 |
dpavlin |
49 |
|
135 |
|
|
$state = $self->state; |
136 |
dpavlin |
119 |
delete( $state->{_dispatch} ); |
137 |
dpavlin |
150 |
#warn "last request state = ", dump( $state ), "\n" if $self->debug > 1; |
138 |
dpavlin |
34 |
} |
139 |
|
|
|
140 |
|
|
|
141 |
dpavlin |
44 |
$sock->send(join("\r\n", |
142 |
|
|
'HTTP/1.1 200 OK', |
143 |
|
|
'Content-Type: text/xml; charset="utf-8"', |
144 |
|
|
'Server: AcmeCWMP/42', |
145 |
dpavlin |
49 |
'SOAPServer: AcmeCWMP/42' |
146 |
dpavlin |
54 |
)."\r\n"); |
147 |
dpavlin |
30 |
|
148 |
dpavlin |
43 |
$sock->send( "Set-Cookie: ID=" . $state->{ID} . "; path=/\r\n" ) if ( $state->{ID} ); |
149 |
dpavlin |
40 |
|
150 |
dpavlin |
170 |
$xml = ''; |
151 |
dpavlin |
40 |
|
152 |
dpavlin |
36 |
if ( my $dispatch = $state->{_dispatch} ) { |
153 |
dpavlin |
50 |
$xml = $self->dispatch( $dispatch ); |
154 |
|
|
} elsif ( $dispatch = shift @{ $self->queue } ) { |
155 |
|
|
$xml = $self->dispatch( $dispatch ); |
156 |
|
|
} elsif ( $size == 0 ) { |
157 |
dpavlin |
150 |
warn ">>> no more queued commands, closing connection\n"; |
158 |
dpavlin |
50 |
return 0; |
159 |
dpavlin |
36 |
} else { |
160 |
|
|
warn ">>> empty response\n"; |
161 |
dpavlin |
50 |
$state->{NoMoreRequests} = 1; |
162 |
|
|
$xml = $self->dispatch( 'xml', sub {} ); |
163 |
dpavlin |
36 |
} |
164 |
dpavlin |
40 |
|
165 |
dpavlin |
43 |
$sock->send( "Content-Length: " . length( $xml ) . "\r\n\r\n" ); |
166 |
dpavlin |
44 |
$sock->send( $xml ) or die "can't send response"; |
167 |
dpavlin |
40 |
|
168 |
dpavlin |
72 |
warn ">>>> " . $sock->peerhost . " [" . localtime() . "] sent ", length( $xml )," bytes\n"; |
169 |
|
|
|
170 |
dpavlin |
70 |
warn "### request over\n" if $self->debug; |
171 |
dpavlin |
40 |
|
172 |
dpavlin |
72 |
return 1; # next request |
173 |
dpavlin |
30 |
}; |
174 |
|
|
|
175 |
dpavlin |
50 |
=head2 dispatch |
176 |
|
|
|
177 |
|
|
$xml = $self->dispatch('Inform', $response_arguments ); |
178 |
|
|
|
179 |
dpavlin |
117 |
If debugging level of 3 or more, it will create dumps of responses named C<< dump/nr.response >> |
180 |
|
|
|
181 |
dpavlin |
50 |
=cut |
182 |
|
|
|
183 |
|
|
sub dispatch { |
184 |
|
|
my $self = shift; |
185 |
|
|
|
186 |
|
|
my $dispatch = shift || die "no dispatch?"; |
187 |
dpavlin |
169 |
my @args = @_; |
188 |
dpavlin |
50 |
|
189 |
dpavlin |
169 |
if ( ref($dispatch) eq 'ARRAY' ) { |
190 |
|
|
my @a = @$dispatch; |
191 |
|
|
$dispatch = shift @a; |
192 |
|
|
push @args, @a; |
193 |
|
|
} |
194 |
|
|
|
195 |
dpavlin |
50 |
my $response = CWMP::Response->new({ debug => $self->debug }); |
196 |
|
|
|
197 |
|
|
if ( $response->can( $dispatch ) ) { |
198 |
|
|
warn ">>> dispatching to $dispatch\n"; |
199 |
dpavlin |
169 |
my $xml = $response->$dispatch( $self->state, @args ); |
200 |
dpavlin |
53 |
warn "## response payload: ",length($xml)," bytes\n$xml\n" if $self->debug; |
201 |
dpavlin |
117 |
if ( $self->debug > 2 ) { |
202 |
dpavlin |
127 |
my $file = sprintf("dump/%04d-%s.response", $dump_nr++, $self->sock->peerhost); |
203 |
dpavlin |
117 |
write_file( $file, $xml ); |
204 |
|
|
warn "### response dump: $file\n"; |
205 |
|
|
} |
206 |
dpavlin |
50 |
return $xml; |
207 |
|
|
} else { |
208 |
|
|
confess "can't dispatch to $dispatch"; |
209 |
|
|
} |
210 |
|
|
}; |
211 |
|
|
|
212 |
dpavlin |
40 |
|
213 |
dpavlin |
48 |
=head2 error |
214 |
|
|
|
215 |
|
|
return $self->error( 501, 'System error' ); |
216 |
|
|
|
217 |
|
|
=cut |
218 |
|
|
|
219 |
dpavlin |
44 |
sub error { |
220 |
dpavlin |
40 |
my ($self, $number, $msg) = @_; |
221 |
dpavlin |
44 |
$msg ||= 'ERROR'; |
222 |
|
|
$self->sock->send( "HTTP/1.1 $number $msg\r\n" ); |
223 |
dpavlin |
40 |
warn "Error - $number - $msg\n"; |
224 |
dpavlin |
48 |
return 0; # close connection |
225 |
dpavlin |
40 |
} |
226 |
|
|
|
227 |
dpavlin |
30 |
1; |