1 |
package CWMP::Methods; |
2 |
|
3 |
use strict; |
4 |
use warnings; |
5 |
|
6 |
|
7 |
use base qw/Class::Accessor/; |
8 |
__PACKAGE__->mk_accessors( qw/debug/ ); |
9 |
|
10 |
use XML::Generator; |
11 |
use Carp qw/confess/; |
12 |
use Data::Dump qw/dump/; |
13 |
|
14 |
=head1 NAME |
15 |
|
16 |
CWMP::Methods - generate SOAP meesages for CPE |
17 |
|
18 |
=head1 METHODS |
19 |
|
20 |
=head2 new |
21 |
|
22 |
my $method = CWMP::Methods->new({ debug => 1 }); |
23 |
|
24 |
=cut |
25 |
|
26 |
sub new { |
27 |
my $class = shift; |
28 |
my $self = $class->SUPER::new( @_ ); |
29 |
|
30 |
warn "created XML::Generator object\n" if $self->debug; |
31 |
|
32 |
return $self; |
33 |
} |
34 |
|
35 |
=head2 xml |
36 |
|
37 |
Used to implement methods which modify just body of soap message. |
38 |
For examples, see source of this module. |
39 |
|
40 |
=cut |
41 |
|
42 |
my $cwmp = [ cwmp => 'urn:dslforum-org:cwmp-1-0' ]; |
43 |
my $soap = [ soap => 'http://schemas.xmlsoap.org/soap/envelope/' ]; |
44 |
my $xsd = [ xsd => 'http://www.w3.org/2001/XMLSchema-instance' ]; |
45 |
|
46 |
sub xml { |
47 |
my $self = shift; |
48 |
|
49 |
my ( $state, $closure ) = @_; |
50 |
|
51 |
confess "no state?" unless ($state); |
52 |
confess "no body closure" unless ( $closure ); |
53 |
|
54 |
confess "no ID in state ", dump( $state ) unless ( $state->{ID} ); |
55 |
|
56 |
#warn "state used to generate xml = ", dump( $state ) if $self->debug; |
57 |
|
58 |
my $X = XML::Generator->new(':pretty'); |
59 |
|
60 |
return $X->Envelope( $soap, { 'soap:encodingStyle' => "http://schemas.xmlsoap.org/soap/encoding/" }, |
61 |
$X->Header( $soap, |
62 |
$X->ID( $cwmp, { mustUnderstand => 1 }, $state->{ID} ), |
63 |
$X->NoMoreRequests( $cwmp, $state->{NoMoreRequests} || 0 ), |
64 |
), |
65 |
$X->Body( $soap, $closure->( $X, $state ) ), |
66 |
); |
67 |
} |
68 |
|
69 |
=head1 CPE methods |
70 |
|
71 |
=head2 GetRPCMethods |
72 |
|
73 |
$method->GetRPCMethods( $state ); |
74 |
|
75 |
=cut |
76 |
|
77 |
sub GetRPCMethods { |
78 |
my ( $self, $state ) = @_; |
79 |
$self->xml( $state, sub { |
80 |
my ( $X, $state ) = @_; |
81 |
$X->GetRPCMethods(); |
82 |
}); |
83 |
}; |
84 |
|
85 |
=head2 SetParameterValues |
86 |
|
87 |
$method->SetParameterValues( $state, |
88 |
param1 => 'value1', |
89 |
param2 => 'value2', |
90 |
... |
91 |
); |
92 |
|
93 |
It doesn't support base64 encoding of values yet. |
94 |
|
95 |
To preserve data, it does support repeatable parametar names. |
96 |
Behaviour on this is not defined in protocol. |
97 |
|
98 |
=cut |
99 |
|
100 |
sub SetParameterValues { |
101 |
my $self = shift; |
102 |
my $state = shift; |
103 |
|
104 |
confess "SetParameterValues needs parameters" unless @_; |
105 |
|
106 |
my @params = @_; |
107 |
|
108 |
my ( @names, @values ); |
109 |
|
110 |
while ( @_ ) { |
111 |
push @names, shift @_; |
112 |
push @values, shift @_; |
113 |
} |
114 |
|
115 |
confess "can't convert params ", dump( @params ), " to name/value pairs" unless $#names == $#values; |
116 |
|
117 |
warn "# SetParameterValues", dump( @params ), "\n" if $self->debug; |
118 |
|
119 |
$self->xml( $state, sub { |
120 |
my ( $X, $state ) = @_; |
121 |
|
122 |
$X->SetParameterValues( $cwmp, |
123 |
$X->ParameterList( $cwmp, |
124 |
$X->ParameterNames( $cwmp, |
125 |
map { |
126 |
$X->ParameterValueStruct( $cwmp, |
127 |
$X->Name( $cwmp, $_ ), |
128 |
$X->Value( $cwmp, shift @values ) |
129 |
) |
130 |
} @names |
131 |
) |
132 |
) |
133 |
); |
134 |
}); |
135 |
} |
136 |
|
137 |
|
138 |
=head2 GetParameterValues |
139 |
|
140 |
$method->GetParameterValues( $state, $ParameterNames ); |
141 |
|
142 |
=cut |
143 |
|
144 |
sub GetParameterValues { |
145 |
my $self = shift; |
146 |
my $state = shift; |
147 |
my @ParameterNames = @_; |
148 |
confess "GetParameterValues need ParameterNames" unless @ParameterNames; |
149 |
warn "# GetParameterValues", dump( @ParameterNames ), "\n" if $self->debug; |
150 |
|
151 |
$self->xml( $state, sub { |
152 |
my ( $X, $state ) = @_; |
153 |
|
154 |
$X->GetParameterValues( $cwmp, |
155 |
$X->ParameterNames( $cwmp, |
156 |
map { |
157 |
$X->string( $xsd, $_ ) |
158 |
} @ParameterNames |
159 |
) |
160 |
); |
161 |
}); |
162 |
} |
163 |
|
164 |
=head2 GetParameterNames |
165 |
|
166 |
$method->GetParameterNames( $state, $ParameterPath, $NextLevel ); |
167 |
|
168 |
=cut |
169 |
|
170 |
sub GetParameterNames { |
171 |
my ( $self, $state, $ParameterPath, $NextLevel ) = @_; |
172 |
$ParameterPath ||= ''; # all |
173 |
$NextLevel ||= 0; # all |
174 |
warn "# GetParameterNames( '$ParameterPath', $NextLevel )\n" if $self->debug; |
175 |
$self->xml( $state, sub { |
176 |
my ( $X, $state ) = @_; |
177 |
|
178 |
$X->GetParameterNames( $cwmp, |
179 |
$X->ParameterPath( $cwmp, $ParameterPath ), |
180 |
$X->NextLevel( $cwmp, $NextLevel ), |
181 |
); |
182 |
}); |
183 |
} |
184 |
|
185 |
=head2 Reboot |
186 |
|
187 |
$method->Reboot( $state ); |
188 |
|
189 |
=cut |
190 |
|
191 |
sub Reboot { |
192 |
my ( $self, $state ) = @_; |
193 |
$self->xml( $state, sub { |
194 |
my ( $X, $state ) = @_; |
195 |
$X->Reboot(); |
196 |
}); |
197 |
} |
198 |
|
199 |
|
200 |
=head1 Server methods |
201 |
|
202 |
|
203 |
=head2 InformResponse |
204 |
|
205 |
$method->InformResponse( $state ); |
206 |
|
207 |
=cut |
208 |
|
209 |
sub InformResponse { |
210 |
my ( $self, $state ) = @_; |
211 |
$self->xml( $state, sub { |
212 |
my ( $X, $state ) = @_; |
213 |
$X->InformResponse( $cwmp, |
214 |
$X->MaxEnvelopes( $cwmp, 1 ) |
215 |
); |
216 |
}); |
217 |
} |
218 |
|
219 |
=head1 BUGS |
220 |
|
221 |
All other methods are unimplemented. |
222 |
|
223 |
=cut |
224 |
|
225 |
1; |