File: HaCiAPI.pm

package info (click to toggle)
haci 0.98c-2.2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,240 kB
  • sloc: perl: 23,790; javascript: 1,817; sh: 225; makefile: 8
file content (593 lines) | stat: -rw-r--r-- 15,858 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
package HaCi::HaCiAPI;

use strict;
use warnings;
use File::Basename;

use vars qw/$workDir/;

# Polluting Environment for Config::General
$ENV{script_name}	= $ENV{SCRIPT_NAME};

($workDir	= dirname( __FILE__ )) =~ s#/modules/HaCi##;
$ENV{workdir}	= $workDir;
unshift @INC, $ENV{workdir} . '/modules';

use HaCi::Conf;
use HaCi::HaCi;
use HaCi::Utils qw/networkStateName2ID getNetID checkNetACL rootName2ID netv6Dec2ipv6ID tmplName2ID tmplEntryDescr2EntryID/;
use HaCi::Log qw/warnl debug/;
use HaCi::Mathematics qw/netv62Dec &net2dec/;
use HaCi::SOAP::Type::network;

our $conf; *conf		= \$HaCi::Conf::conf;

sub init {
	my @args	= @_;

	map {
		warn "  ARGS: $_\n";
	} @args if 0;

	&HaCi::Conf::init($workDir);
}

sub fillParams {
	my $q				= shift;
	my $params	= shift;

	return unless ref($params) eq 'HASH';

	foreach (keys %{$params}) {
		my $key		= $_;
		my $value	= $params->{$key};
		if (defined $value) {
			$q->delete($key);
			if (ref($value) eq 'ARRAY') {
				$q->param($key, @{$value});
			} else {
				$q->param($key, $value);
			}
			warn "\$q->param($key, $value);\n" if $conf->{static}->{misc}->{debug};
		}
	}
}

=begin WSDL

_IN username        $string  Username
_IN password        $string  Password
_IN searchString    $string  Search String
_IN state           $string  (optional) (One of: UNSPECIFIED, ALLOCATED PA, ALLOCATED PI, ALLOCATED UNSPECIFIED, SUB-ALLOCATED PA, LIR-PARTITIONED PA, LIR-PARTITIONED PI, EARLY-REGISTRATION, NOT-SET, ASSIGNED PA, ASSIGNED PI, ASSIGNED ANYCAST, ALLOCATED-BY-RIR, ALLOCATED-BY-LIR, ASSIGNED, RESERVED, LOCKED, FREE)
_IN exact           $boolean (optional) Search for the Exact search String?
_IN fuzzy           $boolean (optional) Fuzzy search?
_IN template        $string  (optional) isolate your Search by defining a Template
_IN templateQueries $string  (optional) Define special Queries for the specified Template. spererated by semicolon. E.g.: value1=foo;value2=bar
_IN root            $string  (optional) Define special root to search in
_IN tags            $string  (optional) return only networks with this tags, seperate with spaces (i.e.: 'OR foo bar', 'AND foo bar')
_RETURN	@HaCi::SOAP::Type::network
_DOC	This is a search function

=cut
sub search {
	my ($class, $user, $pass, @funcArgs)	= @_;
	&init();

	my $result	= '';
	eval {
		$result	= &HaCi::HaCi::run(1, [$user, $pass, @funcArgs], \&search_pre, \&search_post);
	};
	if ($@) {
		warn "Error: $@";
		return $@;
	}

	return $result;
}

sub search_pre {
	my $funcArgs	= shift;
	my $q					= shift;

	return unless ref($funcArgs) eq 'ARRAY';

	my $searchStr	= $$funcArgs[0] || '';
	my $state			= $$funcArgs[1] || '';
	my $exact			= $$funcArgs[2] || '';
	my $fuzzy			= $$funcArgs[3] || '';
	my $tmplName	= $$funcArgs[4] || '';
	my $tmplQuery	= $$funcArgs[5] || '';
	my $rootName	= $$funcArgs[6] || '';
	my $tagsT			= $$funcArgs[7] || '';
	$tagsT				=~ s/^\s+//;
	$tagsT				=~ s/\s+$//;
	my @tags			= split(/\s+/, $tagsT);
	my $tagOp			= ($tagsT ne '') ? shift @tags : 0;
	if ($tagsT ne '' && scalar @tags == 0) {
		@tags		= ($tagOp);
		$tagOp	= 'OR';
	}

	my $tmplID		= ($tmplName ne '') ? &tmplName2ID($tmplName) : -1;
	my $rootID		= ($rootName ne '') ? &rootName2ID($rootName) : 0;
	unless (defined $tmplID) {
		&warnl("No such Template found! ($tmplName)");
		$tmplID	= -1;
	}
	unless (defined $rootID) {
		&warnl("No such root found! ($rootName)");
		$rootID	= -1;
	}

	foreach (split(/;/, $tmplQuery)) {
		my $query	= $_;
		next if !$query || $query !~ /=/;

		my ($key, $value)	= split(/=/, $query, 2);
		my $tmplEntryID		= &tmplEntryDescr2EntryID($tmplID, $key);
		next unless defined $tmplEntryID;

		my $tmplDescr			= 'tmplEntryDescrID_' . $tmplEntryID;
		my $tmplEntry			= 'tmplEntryID_' . $tmplEntryID;
		&fillParams($q, {
			$tmplDescr	=> $key,
			$tmplEntry	=> $value,
		});
	}

	&fillParams($q, {
		searchButton	=> 1,
		search				=> $searchStr || '',
		state					=> (($state eq '') ? -1 : &networkStateName2ID($state) || 0),
		exact					=> $exact || undef,
		fuzzy					=> $fuzzy || undef,
		tmplID				=> $tmplID,
		rootID				=> $rootID,
		tags					=> (scalar @tags > 0) ? \@tags : undef,
		tagOp					=> $tagOp,
	});
}

sub search_post {
	my $funcArgs	= shift;
	my $q					= shift;
	my $t					= shift;
	my $warnings	= shift;
	my $result		= $t->{V}->{searchResult};

	&dieWarnings($warnings) if $warnings ne '';

	if (defined $result && ref($result) eq 'ARRAY') {
		my $networks	= [];
		foreach (@{$result}) {
			push @{$networks}, new HaCi::SOAP::Type::network($_->{rootName}, $_->{network}, $_->{description}, $_->{state}, $_->{tags});
		}
		return $networks;
	} else {
		return [];
	}
}


=begin WSDL

_IN username	$string Username
_IN password	$string Password
_IN root			$string	Root Name
_IN supernet	$string	Supernet (e.g. 192.168.0.0/24)
_IN size			$int		Subnet CIDR (e.g. 29)
_IN amount		$int		(optional) Amount of returned Networks (e.g. 1)
_RETURN @HaCi::SOAP::Type::network
_DOC This Service returns all free Subnets of a certain size from a given Supernet

=cut
sub getFreeSubnets {
	my ($class, $user, $pass, @funcArgs)	= @_;
	&init(@funcArgs);

	my $result	= '';
	eval {
		$result	= &HaCi::HaCi::run(1, [$user, $pass, @funcArgs], \&getFreeSubnets_pre, \&getFreeSubnets_post);
	};
	if ($@) {
		warn "Error: $@";
		return $@;
	}

	return $result;
}

sub getFreeSubnets_pre {
	my $funcArgs	= shift;
	my $q					= shift;

	return unless ref($funcArgs) eq 'ARRAY';

	my $rootName		= $$funcArgs[0] || 0;
	my $rootID			= &rootName2ID($rootName);
	unless ($rootID) {
		&warnl("No such Root found! ($rootName)");
		return;
	}

	my $network			= $$funcArgs[1] || 0;
	my $ipv6				= ($network =~ /:/) ? 1 : 0;
	my $networkDec  = ($ipv6) ? &netv62Dec($network) : &net2dec($network);
	my $cidr				= $$funcArgs[2] || (($ipv6) ? 128 : 32);
	my $amount			= $$funcArgs[3] || 0;
	my $ipv6ID			= ($ipv6) ? &netv6Dec2ipv6ID($networkDec) : '';
	my $netID				= &getNetID($rootID, $networkDec, $ipv6ID);

	unless ($netID) {
		&warnl("No such network found! ($network)");
		return;
	}
	unless (&checkNetACL($netID, 'r')) {
		&warnl("Not enouph permissions to read this Network");
		return;
	}
	
	&fillParams($q, {
		getFreeSubnets	=> 1,
		netID				=> $netID,
		subnetSize	=> $cidr,
		amount			=> $amount,
	});
}

sub getFreeSubnets_post {
	my $funcArgs	= shift;
	my $q					= shift;
	my $t					= shift;
	my $warnings	= shift;
	my $result		= $t->{V}->{freeSubnets};
	my $amount		= &getParam($q, 1, 0, 'amount');
	my $rootName	= $$funcArgs[0] || 0;

	&dieWarnings($warnings) if $warnings ne '';
	if (defined $result && ref($result) eq 'ARRAY') {
		my $networks	= [];
		my $cnter			= 0;
		foreach (@{$result}) {
			my $cRootName	= ($_->{rootName}) ? $_->{rootName} : $rootName;
			my $cNetwork	= ($_->{network}) ? $_->{network} : $_->{net};
			push @{$networks}, new HaCi::SOAP::Type::network($cRootName, $cNetwork);
			return $networks if $amount && ++$cnter == $amount;
		}
		return $networks;
	} else {
		return [];
	}
}

sub dieWarnings {
	my $warnings	= shift;

	die SOAP::Fault->faultcode('HaCiAPI')->faultstring($warnings);
}

=begin WSDL

_IN username        $string  Username
_IN password        $string  Password
_IN searchString    $string  Search String
_IN state           $string  (optional) (One of: UNSPECIFIED, ALLOCATED PA, ALLOCATED PI, ALLOCATED UNSPECIFIED, SUB-ALLOCATED PA, LIR-PARTITIONED PA, LIR-PARTITIONED PI, EARLY-REGISTRATION, NOT-SET, ASSIGNED PA, ASSIGNED PI, ASSIGNED ANYCAST, ALLOCATED-BY-RIR, ALLOCATED-BY-LIR, ASSIGNED, RESERVED, LOCKED, FREE)
_IN exact           $boolean (optional) Search for the Exact search String?
_IN fuzzy           $boolean (optional) Fuzzy search?
_IN template        $string  (optional) isolate your Search by defining a Template
_IN templateQueries $string  (optional) Define special Queries for the specified Template. spererated by semicolon. E.g.: value1=foo;value2=bar
_IN size            $int     Subnet CIDR (e.g. 29)
_IN amount          $int     (optional) Amount of returned Networks (e.g. 1)
_RETURN	@HaCi::SOAP::Type::network
_DOC This Service returns all free Subnets of a certain size from networks, that fit the search criteria

=cut
sub getFreeSubnetsFromSearch {
	my ($class, $user, $pass, @funcArgs)	= @_;
	&init();
	
	my $result	= '';
	eval {
		$result	= &HaCi::HaCi::run(1, [$user, $pass, @funcArgs], \&getFreeSubnetsFromSearch_pre, \&getFreeSubnets_post);
	};
	if ($@) {
		warn "Error: $@";
		return $@;
	}

	return $result;
}

sub getFreeSubnetsFromSearch_pre {
	my $funcArgs	= shift;
	my $q					= shift;

	return unless ref($funcArgs) eq 'ARRAY';

	my $searchStr	= $$funcArgs[0] || '';
	my $state			= $$funcArgs[1] || '';
	my $exact			= $$funcArgs[2] || '';
	my $fuzzy			= $$funcArgs[3] || '';
	my $tmplName	= $$funcArgs[4] || '';
	my $tmplQuery	= $$funcArgs[5] || '';
	my $size			= $$funcArgs[6] || -1;
	my $amount		= $$funcArgs[7] || 1;
	my $tmplID		= ($tmplName ne '') ? &tmplName2ID($tmplName) : 0;
	unless (defined $tmplID) {
		&warnl("No such Template found! ($tmplName)");
		$tmplID	= -1;
	}
	foreach (split(/;/, $tmplQuery)) {
		my $query	= $_;
		next if !$query || $query !~ /=/;

		my ($key, $value)	= split(/=/, $query, 2);
		my $tmplEntryID		= &tmplEntryDescr2EntryID($tmplID, $key);
		next unless defined $tmplEntryID;

		my $tmplDescr			= 'tmplEntryDescrID_' . $tmplEntryID;
		my $tmplEntry			= 'tmplEntryID_' . $tmplEntryID;
		&fillParams($q, {
			$tmplDescr	=> $key,
			$tmplEntry	=> $value,
		});
	}

	&fillParams($q, {
		searchAndGetFreeSubnets	=> 1,
		search				=> $searchStr || '',
		state					=> (($state eq '') ? -1 : &networkStateName2ID($state) || 0),
		exact					=> $exact || undef,
		fuzzy					=> $fuzzy || undef,
		tmplID				=> $tmplID,
		size					=> $size,
		amount				=> $amount,
	});
}

=begin WSDL

_IN username		$string		Username
_IN password		$string		Password
_IN rootName		$string		Name of Root
_IN ipaddress		$string		IP Address (E.g.: 192.168.0.1)
_IN cidr				$int			CIDR (E.g.: 24)
_IN description	$string		(optional) Description of the Network
_IN state				$string		(optional) The State of the Network.  (One of: UNSPECIFIED, ALLOCATED PA, ALLOCATED PI, ALLOCATED UNSPECIFIED, SUB-ALLOCATED PA, LIR-PARTITIONED PA, LIR-PARTITIONED PI, EARLY-REGISTRATION, NOT-SET, ASSIGNED PA, ASSIGNED PI, ASSIGNED ANYCAST, ALLOCATED-BY-RIR, ALLOCATED-BY-LIR, ASSIGNED, RESERVED, LOCKED, FREE)
_IN defSubnetSize	$int		(optional) Default CIDR for Subnets 
_IN templateName	$string	(optional) Template, which should be linked to the Network 
_IN tags					$string	(optional) Tags (seperate by comma)
_RETURN $string	Prints if addition has failed or was successfull
_DOC This function adds a Network

=cut
sub addNet {
	my ($class, $user, $pass, @funcArgs)	= @_;
	&init(@funcArgs);

	my $result	= '';
	eval {
		$result	= &HaCi::HaCi::run(1, [$user, $pass, @funcArgs], \&addNet_pre, \&addNet_post);
	};
	if ($@) {
		warn "Error: $@";
		return $@;
	}

	return $result;
}

sub addNet_pre {
	my $funcArgs	= shift;
	my $q					= shift;

	return unless ref($funcArgs) eq 'ARRAY';

	my $rootName	= $$funcArgs[0] || '';
	my $ip				= $$funcArgs[1] || 0;
	my $cidr			= $$funcArgs[2];
	my $descr			= $$funcArgs[3] || '';
	my $state			= (($$funcArgs[1] eq '') ? -1 : &networkStateName2ID($$funcArgs[1]) || 0),
	my $defss			= $$funcArgs[5] || 0;
	my $tmplName	= $$funcArgs[6] || '';
	my $tags			= $$funcArgs[7] || '';
	$cidr					= (($ip =~ /:/) ? 128 : 32) if !defined $cidr || !$cidr;

	my $rootID		= &rootName2ID($rootName);
	unless ($rootID) {
		&warnl("No such Root found! ($rootName)");
		return;
	}

	my $tmplID		= ($tmplName ne '') ? &tmplName2ID($tmplName) : 0;
	unless (defined $tmplID) {
		&warnl("No such Template found! ($tmplName)");
		$tmplID	= 0;
	}
	
	&fillParams($q, {
		submitAddNet	=> 1,
		func					=> 'addNet',
		rootID				=> $rootID,
		netaddress		=> $ip,
		cidr					=> $cidr,
		descr					=> $descr,
		state					=> $state,
		defSubnetSize	=> $defss,
		tmplID				=> $tmplID,
		tags					=> $tags,
		forceState		=> 1
	});
}

sub addNet_post {
	my $funcArgs	= shift;
	my $q					= shift;
	my $t					= shift;
	my $warnings	= shift;

	my $rootName	= $$funcArgs[0] || '';
	my $ip				= $$funcArgs[1] || 0;
	my $cidr			= $$funcArgs[2];
	$cidr					= (($ip =~ /:/) ? 128 : 32) if !defined $cidr || !$cidr;
	my $network		= $ip . '/' . $cidr;

	my $func	= &getParam($q, 1, undef, 'func');
	warn "FUNC: $func\n";
	if (defined $func && $func eq 'showAllNets') {
		return "Sucessfully added Network '$network' to Root '$rootName'" . (($warnings) ? " ($warnings)" : '');
	} else {
		return "Error while adding Network '$network' to Root '$rootName': $warnings";
	}
}


=begin WSDL

_IN username	$string Username
_IN password	$string Password
_IN root			$string	Root Name
_IN network		$string	Network (e.g. 192.168.0.0/24)
_RETURN				$string	Prints if deletion has failed or was successfull
_DOC									This function deletes a Network

=cut
sub delNet {
	my ($class, $user, $pass, @funcArgs)	= @_;
	&init(@funcArgs);

	my $result	= '';
	eval {
		$result	= &HaCi::HaCi::run(1, [$user, $pass, @funcArgs], \&delNet_pre, \&delNet_post);
	};
	if ($@) {
		warn "Error: $@";
		return $@;
	}

	return $result;
}

sub delNet_pre {
	my $funcArgs	= shift;
	my $q					= shift;

	return unless ref($funcArgs) eq 'ARRAY';

	my $rootName		= $$funcArgs[0] || 0;
	my $rootID			= &rootName2ID($rootName);
	unless ($rootID) {
		&warnl("No such Root found! ($rootName)");
		return;
	}

	my $network			= $$funcArgs[1] || 0;
	my $ipv6				= ($network =~ /:/) ? 1 : 0;
	my $networkDec  = ($ipv6) ? &netv62Dec($network) : &net2dec($network);
	my $ipv6ID			= ($ipv6) ? &netv6Dec2ipv6ID($networkDec) : '';
	my $netID				= &getNetID($rootID, $networkDec, $ipv6ID);

	unless ($netID) {
		&warnl("No such network found! ($network)");
		return;
	}
	unless (&checkNetACL($netID, 'w')) {
		&warnl("Not enouph permissions to delete this Network");
		return;
	}
	
	&fillParams($q, {
		showSubnets		=> 1,
		netID					=> $netID,
		commitDelNet	=> 1, 
		delNet				=> 1,
	});
}

sub delNet_post {
	my $funcArgs	= shift;
	my $q					= shift;
	my $t					= shift;
	my $warnings	= shift;

	my $rootName	= $$funcArgs[0] || '';
	my $network		= $$funcArgs[1] || '0/0';

	my $func	= &getParam($q, 1, undef, 'func');
	if (defined $func && $func eq 'showAllNets') {
		return "Sucessfully deleted Network '$network' from Root '$rootName'" . (($warnings) ? " ($warnings)" : '');
	} else {
		return "Error while deleting Network '$network' from Root '$rootName': $warnings";
	}
}

=begin WSDL

_IN username	$string Username
_IN password	$string Password
_IN param			$string Parameter
_RETURN				$string	Return Stuff
_DOC									Template

=cut
sub template {
	my ($class, $user, $pass, @funcArgs)	= @_;
	&init(@funcArgs);

	my $result	= '';
	eval {
		$result	= &HaCi::HaCi::run(1, [$user, $pass, @funcArgs], \&template_pre, \&template_post);
	};
	if ($@) {
		warn "Error: $@";
		return $@;
	}

	return $result;
}

sub template_pre {
	my $funcArgs	= shift;
	my $q					= shift;

	return unless ref($funcArgs) eq 'ARRAY';

	my $param	= $$funcArgs[0] || 0;
	
	&fillParams($q, {
		param	=> $param,
	});
}

sub template_post {
	my $funcArgs	= shift;
	my $q					= shift;
	my $t					= shift;
	my $warnings	= shift;
}

sub getParam {
	warn 'SUB: ' . (caller(0))[3] . ' (' . (caller(1))[3] . ")\n" if $conf->{var}->{showsubs};

	my $q						= shift;
	my $onlyScalar	= shift;
	my $ifUndef			= shift;
	my $paramName		= shift;
	return $ifUndef unless defined $paramName;

	my @values			= $q->param($paramName);
	unless (defined $values[0]) {
		return $ifUndef if $onlyScalar;
		return () if $ifUndef == 0; # return empty list if onlyScalar != 1 && ifUndef == 0
		return $ifUndef;
	}

	if ($onlyScalar) {
		&debug("called function 'getParam' with option 'onlyScalar' AND more than one value! (" . (caller(0))[0] . '->' . (caller(0))[2] . ')') if $#values > 0;
		return $values[0];
	}

	return @values;
}

1;