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' );
                        $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!

=for obsolete

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

=cut

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

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} ) {
                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	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	dpavlin	203	$state->{_trigger} = 'ParameterValue';
60	dpavlin	31	},
61	dpavlin	186
62	dpavlin	187	];
63
64			=head2 Inform
65
66			Generate InformResponse to CPE
67
68			=cut
69
70			push @$rules,
71			'Inform' => sub {
72			$state->{_dispatch} = 'InformResponse'; # what reponse to call
73	dpavlin	200	$state->{_trigger} = 'Inform';
74	dpavlin	187	};
75
76	dpavlin	186	=head2 GetRPCMethodsResponse
77
78			=cut
79	dpavlin	187
80			push @$rules,
81	dpavlin	31	qr/^(?:^\w+:)*string$/ => 'content array',
82	dpavlin	65	'MethodList' => sub {
83	dpavlin	31	my ($tag_name, $tag_hash, $context, $parent_data) = @_;
84			$state->{MethodList} = _tag( $tag_hash, 'string' );
85	dpavlin	200	$state->{_trigger} = 'GetRPCMethodsResponse';
86	dpavlin	187	};
87	dpavlin	186
88			=head2 GetParameterNamesResponse
89
90			=cut
91
92	dpavlin	187	push @$rules,
93	dpavlin	65	'ParameterInfoStruct' => sub {
94			my ($tag_name, $tag_hash, $context, $parent_data) = @_;
95	dpavlin	90	my $name = _tag($tag_hash, 'Name', '_content');
96			my $writable = _tag($tag_hash, 'Writable', '_content' );
97
98			confess "need state" unless ( $state ); # don't remove!
99
100	dpavlin	214	=for obsolete
101
102	dpavlin	90	# XXX dragons ahead: convert name to tree rewriting it into perl
103	dpavlin	103	my $s = '$state->{ParameterInfo}->' . $tree->name2perl( $name ) . "->{writable} = $writable;";
104	dpavlin	90	eval "$s";
105			confess "can't eval $s : $@" if ($@);
106
107	dpavlin	214	=cut
108
109			$state->{ParameterInfo}->{$name} = $writable;
110
111	dpavlin	92	#warn "## state = dump( $state ), "\n";
112	dpavlin	200
113			$state->{_trigger} = 'GetParameterNamesResponse';
114	dpavlin	187	};
115	dpavlin	186
116			=head2 Fault
117
118			=cut
119
120	dpavlin	187	push @$rules,
121	dpavlin	65	'Fault' => sub {
122	dpavlin	50	my ($tag_name, $tag_hash, $context, $parent_data) = @_;
123			$state->{Fault} = {
124			FaultCode => _tag( $tag_hash, 'FaultCode', '_content' ),
125			FaultString => _tag( $tag_hash, 'FaultString', '_content' ),
126			};
127			warn "FAULT: ", $state->{Fault}->{FaultCode}, " ", $state->{Fault}->{FaultString}, "\n";
128	dpavlin	200	$state->{_trigger} = 'Fault';
129	dpavlin	187	};
130
131			my $parser = XML::Rules->new(
132			# start_rules => [
133			# '^division_name,fax' => 'skip',
134			# ],
135			namespaces => {
136			'http://schemas.xmlsoap.org/soap/envelope/' => 'soapenv',
137			'http://schemas.xmlsoap.org/soap/encoding/' => 'soap',
138			'http://www.w3.org/2001/XMLSchema' => 'xsd',
139			'http://www.w3.org/2001/XMLSchema-instance' => 'xsi',
140			'urn:dslforum-org:cwmp-1-0' => '',
141			},
142			rules => $rules,
143	dpavlin	31	);
144
145	dpavlin	187	=head1 METHODS
146
147			=head2 parse
148
149			my $state = CWMP::Request->parse( "<soap>request</soap>" );
150
151			=cut
152
153			sub parse {
154			my $self = shift;
155
156			my $xml = shift \|\| confess "no xml?";
157
158			$state = {};
159			$parser->parsestring( $xml );
160	dpavlin	200	if ( my $trigger = $state->{_trigger} ) {
161	dpavlin	203	warn "### call_trigger( $trigger )\n";
162			$self->call_trigger( $trigger, $state );
163	dpavlin	200	}
164			# XXX don't propagate _trigger (useful?)
165			delete( $state->{_trigger} );
166	dpavlin	187	return $state;
167			}
168
169			=head2 _tag
170
171			Get value of tag. Tag name is case insensitive (don't ask why),
172			we ignore namespaces and can take optional C<sub_key>
173			(usually C<_content>).
174
175			_tag( $tag_hash, $name, $sub_key )
176
177			=cut
178
179			sub _tag {
180			my ( $tag_hash, $name, $sub_key ) = @_;
181			confess "need hash as first argument" unless ( ref $tag_hash eq 'HASH' );
182			$name = (grep { m/^(?:\w+:)*$name$/i } keys %$tag_hash )[0];
183			# $name =~ s/^\w+://;
184			if ( defined $tag_hash->{$name} ) {
185			if ( ! defined $sub_key ) {
186			return $tag_hash->{$name};
187			} elsif ( defined $tag_hash->{$name}->{$sub_key} ) {
188			return $tag_hash->{$name}->{$sub_key};
189			} else {
190			return if ( $name =~ m/^value$/i );
191			warn "can't find '$name/$sub_key' in ", dump( $tag_hash );
192			return;
193			}
194			} else {
195			warn "can't find '$name' in ", dump( $tag_hash );
196			return;
197			}
198			}
199
200	dpavlin	32	1;