lib/CWMP/Request.pm

package CWMP::Request;

use warnings;
use strict;

use XML::Rules;
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

our $state;     # FIXME check this!

our $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' );
                        $state->{_trigger} = 'ParameterValue';
                },

];

=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!

                        $state->{ParameterInfo}->{$name} = $writable;

                        #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';
                };

=head1 METHODS

=head2 parse

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

=cut

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,
);

sub parse {
        my $self = shift;

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

        $state = {};

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