Hexonet/Connector/APIClient.pm untested

filter: Statementstmt 0.0% 0 / 320 Branchbran 0.0% 0 / 70 Conditioncond 0.0% 0 / 14 MC/DCmcdc 0.0% 0 / 9 Subroutinesub 0.0% 0 / 51 Podpod 0.0% 0 / 37 totaltotal 0.0% 0 / 501 CC 36 SCAR 27.2
CC
36
Cov
0%
_autoIDNConvert
56.0
getPOSTData
42.0
request
42.0
CRAP 15.2
1 package WebService::Hexonet::Connector::APIClient;
2  
3 use 5.030;
4 use strict;
5 use warnings;
6 use utf8;
7 use WebService::Hexonet::Connector::Logger;
8 use WebService::Hexonet::Connector::Response;
9 use WebService::Hexonet::Connector::ResponseTemplateManager;
10 use WebService::Hexonet::Connector::SocketConfig;
11 use LWP::UserAgent;
12 use Carp;
13 use Readonly;
14 use Data::Dumper;
15 use Config;
16 use POSIX;
17  
18 Readonly my $SOCKETTIMEOUT => 300; # 300s or 5 min
19 Readonly my $IDX4 => 4; # Index 4 constant
20 Readonly our $ISPAPI_CONNECTION_URL_OTE => 'https://api-ote.ispapi.net/api/call.cgi'; # OTE Connection Setup URL
21 Readonly our $ISPAPI_CONNECTION_URL_LIVE => 'https://api.ispapi.net/api/call.cgi'; # LIVE Connection Setup URL
22 Readonly our $ISPAPI_CONNECTION_URL_PROXY => 'http://127.0.0.1/api/call.cgi'; # High Speed Connection Setup URL
23  
24 our $VERSION = 'v2.10.4';
25  
26 my $rtm = WebService::Hexonet::Connector::ResponseTemplateManager->getInstance();
27  
28  
29 sub new {
30 my $class = shift;
31 my $self = bless {
32 socketURL => $ISPAPI_CONNECTION_URL_LIVE,
33 debugMode => 0,
34 socketConfig => WebService::Hexonet::Connector::SocketConfig->new(),
35 ua => q{},
36 curlopts => {},
37 logger => WebService::Hexonet::Connector::Logger->new()
38 }, $class;
39 $self->setURL($ISPAPI_CONNECTION_URL_LIVE);
40 $self->useLIVESystem();
41 $self->setDefaultLogger();
42 return $self;
43 }
44  
45  
46 sub setDefaultLogger {
47 my $self = shift;
48 $self->{logger} = WebService::Hexonet::Connector::Logger->new();
49 return $self;
50 }
51  
52  
53 sub setCustomLogger {
54 my ( $self, $logger ) = shift;
55 if ( defined($logger) && $logger->can('log') ) {
56 $self->{logger} = $logger;
57 }
58 return $self;
59 }
60  
61  
62 sub enableDebugMode {
63 my $self = shift;
64 $self->{debugMode} = 1;
65 return $self;
66 }
67  
68  
69 sub disableDebugMode {
70 my $self = shift;
71 $self->{debugMode} = 0;
72 return $self;
73 }
74  
75  
76 sub getPOSTData {
77 my ( $self, $cmd, $secured ) = @_;
78 my $post = $self->{socketConfig}->getPOSTData();
79 if ( defined($secured) && $secured == 1 ) {
80 $post->{s_pw} = '***';
81 }
82 my $tmp = q{};
83 if ( ( ref $cmd ) eq 'HASH' ) {
84 foreach my $key ( sort keys %{$cmd} ) {
85 if ( defined $cmd->{$key} ) {
86 my $val = $cmd->{$key};
87 $val =~ s/[\r\n]//msx;
88 $tmp .= "${key}=${val}\n";
89 }
90 }
91 } else {
92 $tmp = $cmd;
93 }
94 if ( defined($secured) && $secured == 1 ) {
95 $tmp =~ s/PASSWORD\=[^\n]+/PASSWORD=***/gmsx;
96 }
97 $tmp =~ s/\n$//msx;
98 if ( utf8::is_utf8($tmp) ) {
99 utf8::encode($tmp);
100 }
101 $post->{'s_command'} = $tmp;
102 return $post;
103 }
104  
105  
106 sub getSession {
107 my $self = shift;
108 my $sessid = $self->{socketConfig}->getSession();
109 if ( length $sessid ) {
110 return $sessid;
111 }
112 return;
113 }
114  
115  
116 sub getURL {
117 my $self = shift;
118 return $self->{socketURL};
119 }
120  
121  
122 sub getUserAgent {
123 my $self = shift;
124 if ( !( length $self->{ua} ) ) {
125 my $arch = (POSIX::uname)[ $IDX4 ];
126 my $os = (POSIX::uname)[ 0 ];
127 my $rv = $self->getVersion();
128 $self->{ua} = "PERL-SDK ($os; $arch; rv:$rv) perl/$Config{version}";
129 }
130 return $self->{ua};
131 }
132  
133  
134 sub setUserAgent {
135 my ( $self, $str, $rv, $modules ) = @_;
136 my $arch = (POSIX::uname)[ $IDX4 ];
137 my $os = (POSIX::uname)[ 0 ];
138 my $rv2 = $self->getVersion();
139 my $mods = q{};
140 if ( defined $modules && length($modules) > 0 ) {
141 $mods = q{ } . join q{ }, @{$modules};
142 }
143 $self->{ua} = "$str ($os; $arch; rv:$rv)$mods perl-sdk/$rv2 perl/$Config{version}";
144 return $self;
145 }
146  
147  
148 sub getProxy {
149 my ($self) = @_;
150 if ( exists $self->{curlopts}->{'PROXY'} ) {
151 return $self->{curlopts}->{'PROXY'};
152 }
153 return;
154 }
155  
156  
157 sub setProxy {
158 my ( $self, $proxy ) = @_;
159 if ( length($proxy) == 0 ) {
160 delete $self->{curlopts}->{'PROXY'};
161 } else {
162 $self->{curlopts}->{'PROXY'} = $proxy;
163 }
164 return $self;
165 }
166  
167  
168 sub getReferer {
169 my ($self) = @_;
170 if ( exists $self->{curlopts}->{'REFERER'} ) {
171 return $self->{curlopts}->{'REFERER'};
172 }
173 return;
174 }
175  
176  
177 sub setReferer {
178 my ( $self, $referer ) = @_;
179 if ( length($referer) == 0 ) {
180 delete $self->{curlopts}->{'REFERER'};
181 } else {
182 $self->{curlopts}->{'REFERER'} = $referer;
183 }
184 return $self;
185 }
186  
187  
188 sub getVersion {
189 my $self = shift;
190 return $VERSION;
191 }
192  
193  
194 sub saveSession {
195 my ( $self, $session ) = @_;
196 $session->{socketcfg} = {
197 entity => $self->{socketConfig}->getSystemEntity(),
198 session => $self->{socketConfig}->getSession()
199 };
200 return $self;
201 }
202  
203  
204 sub reuseSession {
205 my ( $self, $session ) = @_;
206 $self->{socketConfig}->setSystemEntity( $session->{socketcfg}->{entity} );
207 $self->setSession( $session->{socketcfg}->{session} );
208 return $self;
209 }
210  
211  
212 sub setURL {
213 my ( $self, $value ) = @_;
214 $self->{socketURL} = $value;
215 return $self;
216 }
217  
218  
219 sub setOTP {
220 my ( $self, $value ) = @_;
221 $self->{socketConfig}->setOTP($value);
222 return $self;
223 }
224  
225  
226 sub setSession {
227 my ( $self, $value ) = @_;
228 $self->{socketConfig}->setSession($value);
229 return $self;
230 }
231  
232  
233 sub setRemoteIPAddress {
234 my ( $self, $value ) = @_;
235 $self->{socketConfig}->setRemoteAddress($value);
236 return $self;
237 }
238  
239  
240 sub setCredentials {
241 my ( $self, $uid, $pw ) = @_;
242 $self->{socketConfig}->setLogin($uid);
243 $self->{socketConfig}->setPassword($pw);
244 return $self;
245 }
246  
247  
248 sub setRoleCredentials {
249 my ( $self, $uid, $role, $pw ) = @_;
250 my $myuid = "${uid}!${role}";
251 $myuid =~ s/^\!$//msx;
252 return $self->setCredentials( $myuid, $pw );
253 }
254  
255  
256 sub login {
257 my $self = shift;
258 my $otp = shift;
259 $self->setOTP( $otp || q{} );
260 my $rr = $self->request( { COMMAND => 'StartSession' } );
261 if ( $rr->isSuccess() ) {
262 my $col = $rr->getColumn('SESSION');
263 my $sessid = q{};
264 if ( defined $col ) {
265 my @d = $col->getData();
266 $sessid = $d[ 0 ];
267 }
268 $self->setSession($sessid);
269 }
270 return $rr;
271 }
272  
273  
274 sub loginExtended {
275 my $self = shift;
276 my $params = shift;
277 my $otpc = shift;
278 if ( !defined $otpc ) {
279 $otpc = q{};
280 }
281 $self->setOTP($otpc);
282 my $cmd = { COMMAND => 'StartSession' };
283 foreach my $key ( keys %{$params} ) {
284 $cmd->{$key} = $params->{$key};
285 }
286 my $rr = $self->request($cmd);
287 if ( $rr->isSuccess() ) {
288 my $col = $rr->getColumn('SESSION');
289 my $sessid = q{};
290 if ( defined $col ) {
291 my @d = $col->getData();
292 $sessid = $d[ 0 ];
293 }
294 $self->setSession($sessid);
295 }
296 return $rr;
297 }
298  
299  
300 sub logout {
301 my $self = shift;
302 my $rr = $self->request( { COMMAND => 'EndSession' } );
303 if ( $rr->isSuccess() ) {
304 $self->setSession(q{});
305 }
306 return $rr;
307 }
308  
309  
310 sub request {
311 my ( $self, $cmd ) = @_;
312 # flatten nested api command bulk parameters
313 my $newcmd = $self->_flattenCommand($cmd);
314 # auto convert umlaut names to punycode
315 $newcmd = $self->_autoIDNConvert($newcmd);
316  
317 # request command to API
318 my $cfg = { CONNECTION_URL => $self->{socketURL} };
319 my $post = $self->getPOSTData($newcmd);
320 my $secured = $self->getPOSTData( $newcmd, 1 );
321  
322 my $ua = LWP::UserAgent->new();
323 $ua->agent( $self->getUserAgent() );
324 $ua->default_header( 'Expect', q{} );
325 $ua->timeout($SOCKETTIMEOUT);
326 my $referer = $self->getReferer();
327 if ($referer) {
328 $ua->default_header( 'Referer', $referer );
329 }
330 my $proxy = $self->getProxy();
331 if ($proxy) {
332 $ua->proxy( [ 'http', 'https' ], $proxy );
333 }
334  
335 my $r = $ua->post( $cfg->{CONNECTION_URL}, $post );
336 if ( $r->is_success ) {
337 $r = WebService::Hexonet::Connector::Response->new( $r->decoded_content, $newcmd, $cfg );
338 if ( $self->{debugMode} ) {
339 $self->{logger}->log( $secured, $r );
340 }
341 } else {
342 $r = WebService::Hexonet::Connector::Response->new( $rtm->getTemplate('httperror')->getPlain(), $newcmd, $cfg );
343 if ( $self->{debugMode} ) {
344 $self->{logger}->log( $secured, $r, $r->status_line );
345 }
346 }
347 return $r;
348 }
349  
350  
351 sub requestNextResponsePage {
352 my ( $self, $rr ) = @_;
353 my $mycmd = $rr->getCommand();
354 if ( defined $mycmd->{LAST} ) {
355 croak 'Parameter LAST in use! Please remove it to avoid issues in requestNextPage.';
356 }
357 my $first = 0;
358 if ( defined $mycmd->{FIRST} ) {
359 $first = $mycmd->{FIRST};
360 }
361 my $total = $rr->getRecordsTotalCount();
362 my $limit = $rr->getRecordsLimitation();
363 $first += $limit;
364 if ( $first < $total ) {
365 $mycmd->{FIRST} = $first;
366 $mycmd->{LIMIT} = $limit;
367 return $self->request($mycmd);
368 }
369 return;
370 }
371  
372  
373 sub requestAllResponsePages {
374 my ( $self, $cmd ) = @_;
375 my @responses = ();
376 my $command = {};
377 foreach my $key ( keys %{$cmd} ) {
378 $command->{$key} = $cmd->{$key};
379 }
380 $command->{FIRST} = 0;
381 my $rr = $self->request($command);
382 my $tmp = $rr;
383 my $idx = 0;
384 while ( defined $tmp ) {
385 push @responses, $tmp;
386 $tmp = $self->requestNextResponsePage($tmp);
387 }
388 return \@responses;
389 }
390  
391  
392 sub setUserView {
393 my ( $self, $uid ) = @_;
394 $self->{socketConfig}->setUser($uid);
395 return $self;
396 }
397  
398  
399 sub resetUserView {
400 my $self = shift;
401 $self->{socketConfig}->setUser(q{});
402 return $self;
403 }
404  
405  
406 sub useDefaultConnectionSetup {
407 my $self = shift;
408 return $self->setURL($ISPAPI_CONNECTION_URL_LIVE);
409 }
410  
411  
412 sub useHighPerformanceConnectionSetup {
413 my $self = shift;
414 return $self->setURL($ISPAPI_CONNECTION_URL_PROXY);
415 }
416  
417  
418 sub useOTESystem {
419 my $self = shift;
420 $self->setURL($ISPAPI_CONNECTION_URL_OTE);
421 $self->{socketConfig}->setSystemEntity('1234');
422 return $self;
423 }
424  
425  
426 sub useLIVESystem {
427 my $self = shift;
428 $self->setURL($ISPAPI_CONNECTION_URL_LIVE);
429 $self->{socketConfig}->setSystemEntity('54cd');
430 return $self;
431 }
432  
433  
434 sub _flattenCommand {
435 my ( $self, $cmd ) = @_;
436 for my $key ( keys %{$cmd} ) {
437 my $newkey = uc $key;
438 if ( $newkey ne $key ) {
439 $cmd->{$newkey} = delete $cmd->{$key};
440 }
441 if ( ref( $cmd->{$newkey} ) eq 'ARRAY' ) {
442 my @val = @{ $cmd->{$newkey} };
443 my $idx = 0;
444 for my $str (@val) {
445 $str =~ s/[\r\n]//gmsx;
446 $cmd->{"${key}${idx}"} = $str;
447 $idx++;
448 }
449 delete $cmd->{$newkey};
450 }
451 }
452 return $cmd;
453 }
454  
455  
456 sub _autoIDNConvert {
457 my ( $self, $cmd ) = @_;
458 if ( $cmd->{'COMMAND'} =~ /^CONVERTIDN$/imsx ) {
459 return $cmd;
460 }
461 my @keys = grep {/^(DOMAIN|NAMESERVER|DNSZONE)(\d*)$/imsx} keys %{$cmd};
462 if ( scalar @keys == 0 ) {
463 return $cmd;
464 }
465 my @toconvert = ();
466 my @idxs = ();
467 foreach my $key (@keys) {
468 my $val = $cmd->{$key};
469 if ( $val =~ /[^[:lower:]\d. -]/imsx ) {
470 push @toconvert, $val;
471 push @idxs, $key;
472 }
473 }
474 if ( scalar @toconvert == 0 ) {
475 return $cmd;
476 }
477 my $r = $self->request(
478 { COMMAND => 'ConvertIDN',
479 DOMAIN => \@toconvert
480 }
481 );
482 if ( $r->isSuccess() ) {
483 my $col = $r->getColumn('ACE');
484 if ($col) {
485 my $data = $col->getData();
486 my $idx = 0;
487 foreach my $pc ( @{$data} ) {
488 $cmd->{ $idxs[ $idx ] } = $pc;
489 $idx++;
490 }
491 }
492 }
493 return $cmd;
494 }
495  
496 1;
497  
498 __END__