lib/CWMP/Server.pm

# Dobrica Pavlinusic, <dpavlin@rot13.org> 06/18/07 10:19:50 CEST
package CWMP::Server;

use strict;
use warnings;

use base qw/Class::Accessor/;
__PACKAGE__->mk_accessors( qw/
debug
port
sock
state
queue
/ );

use IO::Socket::INET;
use Data::Dump qw/dump/;
use CWMP::Request;
use CWMP::Response;
use Carp qw/confess cluck/;

=head1 NAME

CWMP::Server - implement logic of CWMP protocol

=head1 METHODS

=head2 new

  my $server = CWMP::Server->new({ port => 3333 });

=head2 run

  $server->run();

=cut

sub run {
        my $self = shift;

        my $listen = IO::Socket::INET->new(
                Listen    => 5,
#               LocalAddr => 'localhost',
                LocalPort => $self->port,
                Proto     => 'tcp',
                Blocking  => 1,
                ReuseAddr => 1,
        );

        warn "ACS waiting for request on port ", $self->port,
                $self->queue ? " queue ( " . join(",",@{$self->queue}) . " )" : "",
                "\n";

        warn "## debug level: ", $self->debug, "\n" if $self->debug;

        while ( my $sock = $listen->accept ) {
                $sock->autoflush(1);

                warn "connection from ", $sock->peerhost, "\n" if $self->debug;

                $self->sock( $sock );   # FIXME this will not work for multiple clients
                while ( $self->process_request ) {
                        warn "...another one bites the dust...\n";
                }

                warn "...returning to accepting new connections\n";
        }
}

=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 'IO::Socket::INET' );

        if ( ! $sock->connected ) {
                warn "SOCKET NOT CONNECTED\n";
                return 0;
        }

        $sock->autoflush( 1 );
        $sock->blocking( 1 );

        ### read the first line of response
        my $line = $sock->getline;
        return $self->error(400, "No Data") unless ( defined $line );

        $line =~ s/[\r\n]+$//;
        if ($line !~ /^ (\w+) \ + (\S+) \ + (HTTP\/1.\d) $ /x) {
                warn "ERROR: $line\n";
                return $self->error(400, "Bad request");
        }
        my ($method, $req, $protocol) = ($1, $2, $3);
        warn "<<<< ", $sock->peerhost, " - - [" . localtime() . "] \"$method $req $protocol\"\n";

        ### read in other headers
        $self->read_headers || return $self->error(400, "Strange headers");

        ### do we support the type
#       if ($method !~ /GET|POST|HEAD/) {
        if ($method !~ /POST/) {
                return $self->error(400, "Unsupported Method");
        }

    my $chunk;
        my $transfer_encoding = $self->header('Transfer-Encoding');

        if ( $transfer_encoding && $transfer_encoding =~ qr/^chunked/i ) {

                my $len = 0;

                do {

                        warn "get chunk len\n" if $self->debug > 1;
                        
                        my $hex;
                        do {
                                $hex = $sock->getline;
                                $hex =~ s/[\n\r]+$//;
                        } until ( $hex ne '' );

                        die "chunk size not valid hex: $hex" unless ( $hex =~ m/^[0-9a-f]+$/i);
                        $len = hex( $hex );

                        warn "getting chunk of $len bytes\n" if $self->debug > 1;

                        $sock->read( my $buff, $len );
                        $chunk .= $buff;

                        warn "--- $len bytes: --=>||$buff||<=--\n" if $self->debug > 1;

                } while ( $len > 0 );
                my $sep = $sock->getline;
                die "expected separator, not ", dump( $sep ) if ( $sep !~ m/^[\n\r]+$/ );

        } else {
                die "right now, we support only Transfer-Encoding: chunked";
        }

        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 ( $self->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 );

                } 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 read_headers

parse headers from request

=cut

sub read_headers {
  my $self = shift;

  $self->{headers} = {};

  while (defined($_ = $self->sock->getline)) {
    s/[\r\n]+$//;
    last unless length $_;
        warn "-- $_\n" if $self->debug;
    return 0 if ! /^ ([\w\-]+) :[\ \t]* (.*) $/x;
    $self->{headers}->{$1} = $2;
  }

  return 1;
}

=head2 header

Getter for specific header

  $self->header('Cookies');

=cut

sub header {
        my $self = shift;
        my $header = shift || die "no header?";
        if ( defined( $self->{headers}->{$header} )) {
                return $self->{headers}->{$header};
        } else {
                return;
        }
}

=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	# Dobrica Pavlinusic, <dpavlin@rot13.org> 06/18/07 10:19:50 CEST
2	package CWMP::Server;
3
4	use strict;
5	use warnings;
6
7	use base qw/Class::Accessor/;
8	__PACKAGE__->mk_accessors( qw/
9	debug
10	port
11	sock
12	state
13	queue
14	/ );
15
16	use IO::Socket::INET;
17	use Data::Dump qw/dump/;
18	use CWMP::Request;
19	use CWMP::Response;
20	use Carp qw/confess cluck/;
21
22	=head1 NAME
23
24	CWMP::Server - implement logic of CWMP protocol
25
26	=head1 METHODS
27
28	=head2 new
29
30	my $server = CWMP::Server->new({ port => 3333 });
31
32	=head2 run
33
34	$server->run();
35
36	=cut
37
38	sub run {
39	my $self = shift;
40
41	my $listen = IO::Socket::INET->new(
42	Listen => 5,
43	# LocalAddr => 'localhost',
44	LocalPort => $self->port,
45	Proto => 'tcp',
46	Blocking => 1,
47	ReuseAddr => 1,
48	);
49
50	warn "ACS waiting for request on port ", $self->port,
51	$self->queue ? " queue ( " . join(",",@{$self->queue}) . " )" : "",
52	"\n";
53
54	warn "## debug level: ", $self->debug, "\n" if $self->debug;
55
56	while ( my $sock = $listen->accept ) {
57	$sock->autoflush(1);
58
59	warn "connection from ", $sock->peerhost, "\n" if $self->debug;
60
61	$self->sock( $sock ); # FIXME this will not work for multiple clients
62	while ( $self->process_request ) {
63	warn "...another one bites the dust...\n";
64	}
65
66	warn "...returning to accepting new connections\n";
67	}
68	}
69
70	=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	=cut
77
78	sub process_request {
79	my $self = shift;
80
81	my $sock = $self->sock \|\| die "no sock?";
82
83	die "not IO::Socket::INET but ", ref( $sock ) unless ( ref($sock) eq 'IO::Socket::INET' );
84
85	if ( ! $sock->connected ) {
86	warn "SOCKET NOT CONNECTED\n";
87	return 0;
88	}
89
90	$sock->autoflush( 1 );
91	$sock->blocking( 1 );
92
93	### read the first line of response
94	my $line = $sock->getline;
95	return $self->error(400, "No Data") unless ( defined $line );
96
97	$line =~ s/[\r\n]+$//;
98	if ($line !~ /^ (\w+) \ + (\S+) \ + (HTTP\/1.\d) $ /x) {
99	warn "ERROR: $line\n";
100	return $self->error(400, "Bad request");
101	}
102	my ($method, $req, $protocol) = ($1, $2, $3);
103	warn "<<<< ", $sock->peerhost, " - - [" . localtime() . "] \"$method $req $protocol\"\n";
104
105	### read in other headers
106	$self->read_headers \|\| return $self->error(400, "Strange headers");
107
108	### do we support the type
109	# if ($method !~ /GET\|POST\|HEAD/) {
110	if ($method !~ /POST/) {
111	return $self->error(400, "Unsupported Method");
112	}
113
114	my $chunk;
115	my $transfer_encoding = $self->header('Transfer-Encoding');
116
117	if ( $transfer_encoding && $transfer_encoding =~ qr/^chunked/i ) {
118
119	my $len = 0;
120
121	do {
122
123	warn "get chunk len\n" if $self->debug > 1;
124
125	my $hex;
126	do {
127	$hex = $sock->getline;
128	$hex =~ s/[\n\r]+$//;
129	} until ( $hex ne '' );
130
131	die "chunk size not valid hex: $hex" unless ( $hex =~ m/^[0-9a-f]+$/i);
132	$len = hex( $hex );
133
134	warn "getting chunk of $len bytes\n" if $self->debug > 1;
135
136	$sock->read( my $buff, $len );
137	$chunk .= $buff;
138
139	warn "--- $len bytes: --=>\|\|$buff\|\|<=--\n" if $self->debug > 1;
140
141	} while ( $len > 0 );
142	my $sep = $sock->getline;
143	die "expected separator, not ", dump( $sep ) if ( $sep !~ m/^[\n\r]+$/ );
144
145	} else {
146	die "right now, we support only Transfer-Encoding: chunked";
147	}
148
149	my $size = length( $chunk );
150
151	warn "<<<< " . $sock->peerhost . " [" . localtime() . "] request $size bytes\n";
152
153	my $state;
154
155	if ( $size > 0 ) {
156
157	die "no SOAPAction header in ",dump($chunk) unless defined ( $self->header('SOAPAction') );
158
159
160	if ( $chunk ) {
161	warn "## request chunk: ",length($chunk)," bytes\n$chunk\n" if $self->debug;
162
163	$state = CWMP::Request->parse( $chunk );
164
165	warn "## acquired state = ", dump( $state ), "\n";
166
167	$self->state( $state );
168
169	} else {
170	warn "## empty request\n";
171	}
172
173	} else {
174	$state = $self->state;
175	warn "last request state = ", dump( $state ), "\n" if $self->debug > 1;
176	}
177
178
179	$sock->send(join("\r\n",
180	'HTTP/1.1 200 OK',
181	'Content-Type: text/xml; charset="utf-8"',
182	'Server: AcmeCWMP/42',
183	'SOAPServer: AcmeCWMP/42'
184	)."\r\n");
185
186	$sock->send( "Set-Cookie: ID=" . $state->{ID} . "; path=/\r\n" ) if ( $state->{ID} );
187
188	my $xml = '';
189
190	if ( my $dispatch = $state->{_dispatch} ) {
191	$xml = $self->dispatch( $dispatch );
192	} elsif ( $dispatch = shift @{ $self->queue } ) {
193	$xml = $self->dispatch( $dispatch );
194	} elsif ( $size == 0 ) {
195	warn ">>> closing connection\n";
196	return 0;
197	} else {
198	warn ">>> empty response\n";
199	$state->{NoMoreRequests} = 1;
200	$xml = $self->dispatch( 'xml', sub {} );
201	}
202
203	$sock->send( "Content-Length: " . length( $xml ) . "\r\n\r\n" );
204	$sock->send( $xml ) or die "can't send response";
205
206	warn ">>>> " . $sock->peerhost . " [" . localtime() . "] sent ", length( $xml )," bytes\n";
207
208	warn "### request over\n" if $self->debug;
209
210	return 1; # next request
211	};
212
213	=head2 dispatch
214
215	$xml = $self->dispatch('Inform', $response_arguments );
216
217	=cut
218
219	sub dispatch {
220	my $self = shift;
221
222	my $dispatch = shift \|\| die "no dispatch?";
223
224	my $response = CWMP::Response->new({ debug => $self->debug });
225
226	if ( $response->can( $dispatch ) ) {
227	warn ">>> dispatching to $dispatch\n";
228	my $xml = $response->$dispatch( $self->state, @_ );
229	warn "## response payload: ",length($xml)," bytes\n$xml\n" if $self->debug;
230	return $xml;
231	} else {
232	confess "can't dispatch to $dispatch";
233	}
234	};
235
236	=head2 read_headers
237
238	parse headers from request
239
240	=cut
241
242	sub read_headers {
243	my $self = shift;
244
245	$self->{headers} = {};
246
247	while (defined($_ = $self->sock->getline)) {
248	s/[\r\n]+$//;
249	last unless length $_;
250	warn "-- $_\n" if $self->debug;
251	return 0 if ! /^ ([\w\-]+) :[\ \t]* (.*) $/x;
252	$self->{headers}->{$1} = $2;
253	}
254
255	return 1;
256	}
257
258	=head2 header
259
260	Getter for specific header
261
262	$self->header('Cookies');
263
264	=cut
265
266	sub header {
267	my $self = shift;
268	my $header = shift \|\| die "no header?";
269	if ( defined( $self->{headers}->{$header} )) {
270	return $self->{headers}->{$header};
271	} else {
272	return;
273	}
274	}
275
276	=head2 error
277
278	return $self->error( 501, 'System error' );
279
280	=cut
281
282	sub error {
283	my ($self, $number, $msg) = @_;
284	$msg \|\|= 'ERROR';
285	$self->sock->send( "HTTP/1.1 $number $msg\r\n" );
286	warn "Error - $number - $msg\n";
287	return 0; # close connection
288	}
289
290	1;