lib/CWMP/Request.pm

package CWMP::Request;

use warnings;
use strict;

use XML::Rules;
use CWMP::Tree;
use Data::Dump qw/dump/;
use Carp qw/confess cluck/;
use Class::Trigger;

=head1 NAME

CWMP::Request - parse SOAP request metods

=head1 CPE metods

All methods described below call triggers with same name

=cut

my $tree = CWMP::Tree->new({ debug => 0 });

our $state;     # FIXME check this!

my $rules =  [
                #_default => 'content trim',
                x_default => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        warn dump( $tag_name, $tag_hash, $context );
                },
                'ID' => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        $state->{ID} = $tag_hash->{_content};
                },

                'DeviceId' => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        foreach my $name ( keys %$tag_hash ) {
                                next if $name eq '_content';
                                my $key = $name;
                                $key =~ s/^\w+://;      # stip namespace
                                $state->{DeviceID}->{ $key } = _tag( $tag_hash, $name, '_content' );
                        }
                },
                'EventStruct' => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        push @{ $state->{EventStruct} }, $tag_hash->{EventCode}->{_content};
                },
                qr/(MaxEnvelopes|CurrentTime|RetryCount)/ => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        $state->{$tag_name} = $tag_hash->{_content};
                },
                'ParameterValueStruct' => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        # Name/Value tags must be case insnesitive
                        my $value = (grep( /value/i, keys %$tag_hash ))[0];
                        $state->{Parameter}->{ _tag($tag_hash, 'Name', '_content') } = _tag($tag_hash, 'Value', '_content' );
                },

];

=head2 Inform

Generate InformResponse to CPE

=cut

push @$rules,
        'Inform' => sub {
                $state->{_dispatch} = 'InformResponse';         # what reponse to call
                $state->{_trigger} = 'Inform';
        };

=head2 GetRPCMethodsResponse

=cut

push @$rules,
                qr/^(?:^\w+:)*string$/ => 'content array',
                'MethodList' => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        $state->{MethodList} = _tag( $tag_hash, 'string' );
                        $state->{_trigger} = 'GetRPCMethodsResponse';
                };

=head2 GetParameterNamesResponse

=cut

push @$rules,
                'ParameterInfoStruct' => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        my $name = _tag($tag_hash, 'Name', '_content');
                        my $writable = _tag($tag_hash, 'Writable', '_content' );

                        confess "need state" unless ( $state ); # don't remove!

                        # XXX dragons ahead: convert name to tree rewriting it into perl
                        my $s = '$state->{ParameterInfo}->' . $tree->name2perl( $name ) . "->{writable} = $writable;";
                        eval "$s";
                        confess "can't eval $s : $@" if ($@);

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

                        $state->{_trigger} = 'GetParameterNamesResponse';
                };
        
=head2 Fault

=cut

push @$rules,
                'Fault' => sub {
                        my ($tag_name, $tag_hash, $context, $parent_data) = @_;
                        $state->{Fault} = {
                                FaultCode => _tag( $tag_hash, 'FaultCode', '_content' ),
                                FaultString => _tag( $tag_hash, 'FaultString', '_content' ),
                        };
                        warn "FAULT: ", $state->{Fault}->{FaultCode}, " ", $state->{Fault}->{FaultString}, "\n";
                        $state->{_trigger} = 'Fault';
                };

my $parser = XML::Rules->new(
#       start_rules => [
#               '^division_name,fax' => 'skip',
#       ],
        namespaces => {
                'http://schemas.xmlsoap.org/soap/envelope/' => 'soapenv',
                'http://schemas.xmlsoap.org/soap/encoding/' => 'soap',
                'http://www.w3.org/2001/XMLSchema' => 'xsd',
                'http://www.w3.org/2001/XMLSchema-instance' => 'xsi',
                'urn:dslforum-org:cwmp-1-0' => '',
        },
        rules => $rules,
);

=head1 METHODS

=head2 parse

  my $state = CWMP::Request->parse( "<soap>request</soap>" );

=cut

sub parse {
        my $self = shift;

        my $xml = shift || confess "no xml?";

        $state = {};
        $parser->parsestring( $xml );
        if ( my $trigger = $state->{_trigger} ) {
                __PACKAGE__->call_trigger( $trigger, $state );
        }
        # XXX don't propagate _trigger (useful?)
        delete( $state->{_trigger} );
        return $state;
}

=head2 _tag

Get value of tag. Tag name is case insensitive (don't ask why),
we ignore namespaces and can take optional C<sub_key>
(usually C<_content>).

  _tag( $tag_hash, $name, $sub_key )

=cut

sub _tag {
        my ( $tag_hash, $name, $sub_key ) = @_;
        confess "need hash as first argument" unless ( ref $tag_hash eq 'HASH' );
        $name = (grep { m/^(?:\w+:)*$name$/i } keys %$tag_hash )[0];
#       $name =~ s/^\w+://;
        if ( defined $tag_hash->{$name} ) {
                if ( ! defined $sub_key ) {
                        return $tag_hash->{$name};
                } elsif ( defined $tag_hash->{$name}->{$sub_key} ) {
                        return $tag_hash->{$name}->{$sub_key};
                } else {
                        return if ( $name =~ m/^value$/i );
                        warn "can't find '$name/$sub_key' in ", dump( $tag_hash );
                        return;
                }
        } else {
                warn "can't find '$name' in ", dump( $tag_hash );
                return;
        }
}

1;
1	dpavlin	31	package CWMP::Request;
2
3			use warnings;
4			use strict;
5
6			use XML::Rules;
7	dpavlin	103	use CWMP::Tree;
8	dpavlin	31	use Data::Dump qw/dump/;
9			use Carp qw/confess cluck/;
10	dpavlin	200	use Class::Trigger;
11	dpavlin	31
12			=head1 NAME
13
14	dpavlin	186	CWMP::Request - parse SOAP request metods
15	dpavlin	31
16	dpavlin	187	=head1 CPE metods
17	dpavlin	31
18	dpavlin	200	All methods described below call triggers with same name
19
20	dpavlin	31	=cut
21
22	dpavlin	187	my $tree = CWMP::Tree->new({ debug => 0 });
23	dpavlin	31
24	dpavlin	90	our $state; # FIXME check this!
25	dpavlin	31
26	dpavlin	187	my $rules = [
27	dpavlin	31	#_default => 'content trim',
28			x_default => sub {
29			my ($tag_name, $tag_hash, $context, $parent_data) = @_;
30			warn dump( $tag_name, $tag_hash, $context );
31			},
32			'ID' => sub {
33			my ($tag_name, $tag_hash, $context, $parent_data) = @_;
34			$state->{ID} = $tag_hash->{_content};
35			},
36	dpavlin	186
37	dpavlin	65	'DeviceId' => sub {
38	dpavlin	31	my ($tag_name, $tag_hash, $context, $parent_data) = @_;
39			foreach my $name ( keys %$tag_hash ) {
40			next if $name eq '_content';
41			my $key = $name;
42			$key =~ s/^\w+://; # stip namespace
43			$state->{DeviceID}->{ $key } = _tag( $tag_hash, $name, '_content' );
44			}
45			},
46	dpavlin	65	'EventStruct' => sub {
47	dpavlin	31	my ($tag_name, $tag_hash, $context, $parent_data) = @_;
48			push @{ $state->{EventStruct} }, $tag_hash->{EventCode}->{_content};
49			},
50			qr/(MaxEnvelopes\|CurrentTime\|RetryCount)/ => sub {
51			my ($tag_name, $tag_hash, $context, $parent_data) = @_;
52			$state->{$tag_name} = $tag_hash->{_content};
53			},
54	dpavlin	65	'ParameterValueStruct' => sub {
55	dpavlin	31	my ($tag_name, $tag_hash, $context, $parent_data) = @_;
56			# Name/Value tags must be case insnesitive
57			my $value = (grep( /value/i, keys %$tag_hash ))[0];
58			$state->{Parameter}->{ _tag($tag_hash, 'Name', '_content') } = _tag($tag_hash, 'Value', '_content' );
59			},
60	dpavlin	186
61	dpavlin	187	];
62
63			=head2 Inform
64
65			Generate InformResponse to CPE
66
67			=cut
68
69			push @$rules,
70			'Inform' => sub {
71			$state->{_dispatch} = 'InformResponse'; # what reponse to call
72	dpavlin	200	$state->{_trigger} = 'Inform';
73	dpavlin	187	};
74
75	dpavlin	186	=head2 GetRPCMethodsResponse
76
77			=cut
78	dpavlin	187
79			push @$rules,
80	dpavlin	31	qr/^(?:^\w+:)*string$/ => 'content array',
81	dpavlin	65	'MethodList' => sub {
82	dpavlin	31	my ($tag_name, $tag_hash, $context, $parent_data) = @_;
83			$state->{MethodList} = _tag( $tag_hash, 'string' );
84	dpavlin	200	$state->{_trigger} = 'GetRPCMethodsResponse';
85	dpavlin	187	};
86	dpavlin	186
87			=head2 GetParameterNamesResponse
88
89			=cut
90
91	dpavlin	187	push @$rules,
92	dpavlin	65	'ParameterInfoStruct' => sub {
93			my ($tag_name, $tag_hash, $context, $parent_data) = @_;
94	dpavlin	90	my $name = _tag($tag_hash, 'Name', '_content');
95			my $writable = _tag($tag_hash, 'Writable', '_content' );
96
97			confess "need state" unless ( $state ); # don't remove!
98
99			# XXX dragons ahead: convert name to tree rewriting it into perl
100	dpavlin	103	my $s = '$state->{ParameterInfo}->' . $tree->name2perl( $name ) . "->{writable} = $writable;";
101	dpavlin	90	eval "$s";
102			confess "can't eval $s : $@" if ($@);
103
104	dpavlin	92	#warn "## state = dump( $state ), "\n";
105	dpavlin	200
106			$state->{_trigger} = 'GetParameterNamesResponse';
107	dpavlin	187	};
108	dpavlin	186
109			=head2 Fault
110
111			=cut
112
113	dpavlin	187	push @$rules,
114	dpavlin	65	'Fault' => sub {
115	dpavlin	50	my ($tag_name, $tag_hash, $context, $parent_data) = @_;
116			$state->{Fault} = {
117			FaultCode => _tag( $tag_hash, 'FaultCode', '_content' ),
118			FaultString => _tag( $tag_hash, 'FaultString', '_content' ),
119			};
120			warn "FAULT: ", $state->{Fault}->{FaultCode}, " ", $state->{Fault}->{FaultString}, "\n";
121	dpavlin	200	$state->{_trigger} = 'Fault';
122	dpavlin	187	};
123
124			my $parser = XML::Rules->new(
125			# start_rules => [
126			# '^division_name,fax' => 'skip',
127			# ],
128			namespaces => {
129			'http://schemas.xmlsoap.org/soap/envelope/' => 'soapenv',
130			'http://schemas.xmlsoap.org/soap/encoding/' => 'soap',
131			'http://www.w3.org/2001/XMLSchema' => 'xsd',
132			'http://www.w3.org/2001/XMLSchema-instance' => 'xsi',
133			'urn:dslforum-org:cwmp-1-0' => '',
134			},
135			rules => $rules,
136	dpavlin	31	);
137
138	dpavlin	187	=head1 METHODS
139
140			=head2 parse
141
142			my $state = CWMP::Request->parse( "<soap>request</soap>" );
143
144			=cut
145
146			sub parse {
147			my $self = shift;
148
149			my $xml = shift \|\| confess "no xml?";
150
151			$state = {};
152			$parser->parsestring( $xml );
153	dpavlin	200	if ( my $trigger = $state->{_trigger} ) {
154			__PACKAGE__->call_trigger( $trigger, $state );
155			}
156			# XXX don't propagate _trigger (useful?)
157			delete( $state->{_trigger} );
158	dpavlin	187	return $state;
159			}
160
161			=head2 _tag
162
163			Get value of tag. Tag name is case insensitive (don't ask why),
164			we ignore namespaces and can take optional C<sub_key>
165			(usually C<_content>).
166
167			_tag( $tag_hash, $name, $sub_key )
168
169			=cut
170
171			sub _tag {
172			my ( $tag_hash, $name, $sub_key ) = @_;
173			confess "need hash as first argument" unless ( ref $tag_hash eq 'HASH' );
174			$name = (grep { m/^(?:\w+:)*$name$/i } keys %$tag_hash )[0];
175			# $name =~ s/^\w+://;
176			if ( defined $tag_hash->{$name} ) {
177			if ( ! defined $sub_key ) {
178			return $tag_hash->{$name};
179			} elsif ( defined $tag_hash->{$name}->{$sub_key} ) {
180			return $tag_hash->{$name}->{$sub_key};
181			} else {
182			return if ( $name =~ m/^value$/i );
183			warn "can't find '$name/$sub_key' in ", dump( $tag_hash );
184			return;
185			}
186			} else {
187			warn "can't find '$name' in ", dump( $tag_hash );
188			return;
189			}
190			}
191
192	dpavlin	32	1;