5c9bb9a472130f1352390931c23114317f147577
1 package GosaPackages;
3 use Exporter;
4 @ISA = ("Exporter");
6 use strict;
7 use warnings;
8 use GOSA::GosaSupportDaemon;
9 use IO::Socket::INET;
10 use Socket;
11 use XML::Simple;
12 use File::Spec;
13 use Data::Dumper;
14 use GOSA::DBsqlite;
15 use MIME::Base64;
16 use utf8;
18 my $event_dir = "/usr/lib/gosa-si/server/events";
19 use lib "/usr/lib/gosa-si/server/events";
21 BEGIN{}
22 END{}
24 my ($server_ip, $server_mac_address, $server_port, $server_passwd, $max_clients);
25 my ($gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
26 my ($job_queue_timeout, $job_queue_file_name);
28 my $gosa_server;
29 my $event_hash;
31 my %cfg_defaults = (
32 "server" => {
33 "ip" => [\$server_ip, "0.0.0.0"],
34 "port" => [\$server_port, "20081"],
35 "key" => [\$server_passwd, ""],
36 "max-clients" => [\$max_clients, 100],
37 },
38 "GOsaPackages" => {
39 "ip" => [\$gosa_ip, "0.0.0.0"],
40 "port" => [\$gosa_port, "20082"],
41 "key" => [\$gosa_passwd, "none"],
42 "job-queue" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
43 },
44 );
47 ## START ##########################
49 # read configfile and import variables
50 &read_configfile();
51 $network_interface= &get_interface_for_ip($server_ip);
52 $gosa_mac_address= &get_mac($network_interface);
54 # complete addresses
55 if( inet_aton($server_ip) ){ $server_ip = inet_ntoa(inet_aton($server_ip)); }
56 our $server_address = "$server_ip:$server_port";
57 if( inet_aton($gosa_ip) ){ $gosa_ip = inet_ntoa(inet_aton($gosa_ip)); }
58 my $gosa_address = "$gosa_ip:$gosa_port";
60 # create general settings for this module
61 #y $gosa_cipher = &create_ciphering($gosa_passwd);
62 my $xml = new XML::Simple();
65 # import events
66 &import_events();
68 ## FUNCTIONS #################################################################
70 sub get_module_info {
71 my @info = ($gosa_address,
72 $gosa_passwd,
73 );
74 return \@info;
75 }
78 #=== FUNCTION ================================================================
79 # NAME: read_configfile
80 # PARAMETERS: cfg_file - string -
81 # RETURNS: nothing
82 # DESCRIPTION: read cfg_file and set variables
83 #===============================================================================
84 sub read_configfile {
85 my $cfg;
86 if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
87 if( -r $main::cfg_file ) {
88 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
89 } else {
90 print STDERR "Couldn't read config file!";
91 }
92 } else {
93 $cfg = Config::IniFiles->new() ;
94 }
95 foreach my $section (keys %cfg_defaults) {
96 foreach my $param (keys %{$cfg_defaults{ $section }}) {
97 my $pinfo = $cfg_defaults{ $section }{ $param };
98 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
99 }
100 }
101 }
103 #=== FUNCTION ================================================================
104 # NAME: get_interface_for_ip
105 # PARAMETERS: ip address (i.e. 192.168.0.1)
106 # RETURNS: array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
107 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
108 #===============================================================================
109 sub get_interface_for_ip {
110 my $result;
111 my $ip= shift;
112 if ($ip && length($ip) > 0) {
113 my @ifs= &get_interfaces();
114 if($ip eq "0.0.0.0") {
115 $result = "all";
116 } else {
117 foreach (@ifs) {
118 my $if=$_;
119 if(get_ip($if) eq $ip) {
120 $result = $if;
121 }
122 }
123 }
124 }
125 return $result;
126 }
128 #=== FUNCTION ================================================================
129 # NAME: get_interfaces
130 # PARAMETERS: none
131 # RETURNS: (list of interfaces)
132 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
133 #===============================================================================
134 sub get_interfaces {
135 my @result;
136 my $PROC_NET_DEV= ('/proc/net/dev');
138 open(PROC_NET_DEV, "<$PROC_NET_DEV")
139 or die "Could not open $PROC_NET_DEV";
141 my @ifs = <PROC_NET_DEV>;
143 close(PROC_NET_DEV);
145 # Eat first two line
146 shift @ifs;
147 shift @ifs;
149 chomp @ifs;
150 foreach my $line(@ifs) {
151 my $if= (split /:/, $line)[0];
152 $if =~ s/^\s+//;
153 push @result, $if;
154 }
156 return @result;
157 }
159 #=== FUNCTION ================================================================
160 # NAME: get_mac
161 # PARAMETERS: interface name (i.e. eth0)
162 # RETURNS: (mac address)
163 # DESCRIPTION: Uses ioctl to get mac address directly from system.
164 #===============================================================================
165 sub get_mac {
166 my $ifreq= shift;
167 my $result;
168 if ($ifreq && length($ifreq) > 0) {
169 if($ifreq eq "all") {
170 $result = "00:00:00:00:00:00";
171 } else {
172 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
174 # A configured MAC Address should always override a guessed value
175 if ($gosa_mac_address and length($gosa_mac_address) > 0) {
176 $result= $gosa_mac_address;
177 }
179 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
180 or die "socket: $!";
182 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
183 my ($if, $mac)= unpack 'h36 H12', $ifreq;
185 if (length($mac) > 0) {
186 $mac=~ m/^([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])$/;
187 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
188 $result = $mac;
189 }
190 }
191 }
192 }
193 return $result;
194 }
196 #=== FUNCTION ================================================================
197 # NAME: get_ip
198 # PARAMETERS: interface name (i.e. eth0)
199 # RETURNS: (ip address)
200 # DESCRIPTION: Uses ioctl to get ip address directly from system.
201 #===============================================================================
202 sub get_ip {
203 my $ifreq= shift;
204 my $result= "";
205 my $SIOCGIFADDR= 0x8915; # man 2 ioctl_list
206 my $proto= getprotobyname('ip');
208 socket SOCKET, PF_INET, SOCK_DGRAM, $proto
209 or die "socket: $!";
211 if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
212 my ($if, $sin) = unpack 'a16 a16', $ifreq;
213 my ($port, $addr) = sockaddr_in $sin;
214 my $ip = inet_ntoa $addr;
216 if ($ip && length($ip) > 0) {
217 $result = $ip;
218 }
219 }
221 return $result;
222 }
225 sub import_events {
226 if (not -e $event_dir) {
227 &main::daemon_log("ERROR: cannot find directory or directory is not readable: $event_dir", 1);
228 }
229 opendir (DIR, $event_dir) or die "ERROR while loading gosa-si-events from directory $event_dir : $!\n";
231 while (defined (my $event = readdir (DIR))) {
232 if( $event eq "." || $event eq ".." ) { next; }
233 if( $event eq "siTriggered.pm" ) { next; } # SI specific events not needed in GosaPackages.pm
234 if( $event eq "clMessages.pm" ) { next; } # SI specific events not needed in GosaPackages.pm
236 eval{ require $event; };
237 if( $@ ) {
238 &main::daemon_log("ERROR: import of event module '$event' failed", 1);
239 &main::daemon_log("$@", 1);
240 next;
241 }
243 $event =~ /(\S*?).pm$/;
244 my $event_module = $1;
245 my $events_l = eval( $1."::get_events()") ;
246 foreach my $event_name (@{$events_l}) {
247 $event_hash->{$event_name} = $event_module;
248 }
249 my $events_string = join( ", ", @{$events_l});
250 &main::daemon_log("INFO: GosaPackages imported events $events_string", 5);
251 }
252 }
255 #=== FUNCTION ================================================================
256 # NAME: process_incoming_msg
257 # PARAMETERS: crypted_msg - string - incoming crypted message
258 # RETURNS: nothing
259 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
260 #===============================================================================
261 sub process_incoming_msg {
262 my ($msg, $msg_hash, $session_id) = @_ ;
263 my $header = @{$msg_hash->{header}}[0];
264 my @msg_l;
265 my @out_msg_l;
267 &main::daemon_log("DEBUG: GosaPackages: receive '$header'", 8);
269 if ($header =~ /^job_/) {
270 @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
271 }
272 elsif ($header =~ /^gosa_/) {
273 @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
274 }
275 else {
276 &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix", 1);
277 }
279 foreach my $out_msg ( @msg_l ) {
281 # keep job queue up-to-date and save result and status
282 if (defined ($out_msg) && $out_msg =~ /<jobdb_id>(\d+)<\/jobdb_id>/) {
283 my $job_id = $1;
284 my $sql = "UPDATE '".$main::job_queue_table_name."'".
285 " SET status='processing'".
286 " WHERE id='$job_id'";
287 my $res = $main::job_db->exec_statement($sql);
288 }
290 # substitute in all outgoing msg <source>GOSA</source> of <source>$server_address</source>
291 $out_msg =~ s/<source>GOSA<\/source>/<source>$server_address<\/source>/g;
293 if (defined $out_msg){
294 push(@out_msg_l, $out_msg);
295 }
297 }
299 return \@out_msg_l;
300 }
303 sub process_gosa_msg {
304 my ($msg, $msg_hash, $session_id) = @_ ;
305 my $out_msg;
306 my @out_msg_l;
308 my $header = @{$msg_hash->{'header'}}[0];
309 $header =~ s/gosa_//;
311 # decide wether msg is a core function or a event handler
312 if ( $header eq 'query_jobdb') {
313 @out_msg_l = &query_jobdb
314 } elsif ($header eq 'delete_jobdb_entry') {
315 @out_msg_l = &delete_jobdb_entry
316 } elsif ($header eq 'clear_jobdb') {
317 @out_msg_l = &clear_jobdb
318 } elsif ($header eq 'update_status_jobdb_entry' ) {
319 @out_msg_l = &update_status_jobdb_entry
320 } elsif ($header eq 'count_jobdb' ) {
321 @out_msg_l = &count_jobdb
322 } else {
323 # msg could not be assigned to core function
324 # maybe it is an eventa
325 if( exists $event_hash->{$header} ) {
326 # a event exists with the header as name
327 &main::daemon_log("found event '$header' at event-module '".$event_hash->{$header}."'", 5);
328 no strict 'refs';
329 @out_msg_l = &{$event_hash->{$header}."::$header"}($msg, $msg_hash, $session_id);
330 }
331 }
333 # if delivery not possible raise error and return
334 if( not @out_msg_l ) {
335 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
336 } elsif( 0 == @out_msg_l) {
337 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
338 }
340 return @out_msg_l;
341 }
344 sub process_job_msg {
345 my ($msg, $msg_hash, $session_id)= @_ ;
346 my $out_msg;
347 my $error = 0;
349 my $header = @{$msg_hash->{'header'}}[0];
350 $header =~ s/job_//;
352 # if no timestamp is specified, use 19700101000000
353 my $timestamp = "19700101000000";
354 if( exists $msg_hash->{'timestamp'} ) {
355 $timestamp = @{$msg_hash->{'timestamp'}}[0];
356 }
358 #if no macaddress is specified, raise error
359 my $macaddress;
360 if( exists $msg_hash->{'macaddress'} ) {
361 $macaddress = @{$msg_hash->{'macaddress'}}[0];
362 } else {
363 $error ++;
364 $out_msg = "<xml>".
365 "<header>answer</header>".
366 "<source>$server_address</source>".
367 "<target>GOSA</target>".
368 "<answer1>1</answer1>".
369 "<error_string>no mac address specified</error_string>".
370 "</xml>";
371 }
373 # check wether mac address is already known in known_daemons or known_clients
374 my $target = 'none';
376 if( $error == 0 ) {
377 # add job to job queue
378 my $func_dic = {table=>$main::job_queue_table_name,
379 primkey=>'id',
380 timestamp=>$timestamp,
381 status=>'waiting',
382 result=>'none',
383 progress=>'none',
384 headertag=>$header,
385 targettag=>$target,
386 xmlmessage=>$msg,
387 macaddress=>$macaddress,
388 };
390 my $res = $main::job_db->add_dbentry($func_dic);
391 if (not $res == 0) {
392 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
393 } else {
394 &main::daemon_log("INFO: GosaPackages: $header job successfully added to job queue", 5);
395 }
396 $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
397 }
399 my @out_msg_l = ( $out_msg );
400 return @out_msg_l;
401 }
405 ## CORE FUNCTIONS ############################################################
407 sub query_jobdb {
408 my ($msg) = @_;
409 my $msg_hash = &transform_msg2hash($msg);
410 my $target = @{$msg_hash->{'target'}}[0];
411 my $source = @{$msg_hash->{'source'}}[0];
413 # prepare query sql statement
414 my $select= &get_select_statement($msg, $msg_hash);
415 my $table= $main::job_queue_tn;
416 my $where= &get_where_statement($msg, $msg_hash);
417 my $limit= &get_limit_statement($msg, $msg_hash);
418 my $orderby= &get_orderby_statement($msg, $msg_hash);
419 my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
421 # execute db query
422 my $res_hash = $main::job_db->select_dbentry($sql_statement);
423 my $out_xml = &db_res2si_msg($res_hash, "query_jobdb", $target, $source);
424 my @out_msg_l = ( $out_xml );
425 return @out_msg_l;
426 }
429 sub count_jobdb {
430 my ($msg)= @_;
431 my $out_xml= "<xml><count>error</count></xml>";
433 # prepare query sql statement
434 my $table= $main::job_queue_table_name;
435 my $sql_statement= "SELECT * FROM $table ";
437 # execute db query
438 my $res_hash = $main::job_db->select_dbentry($sql_statement);
440 my $count = keys(%{$res_hash});
441 $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><count>$count</count></xml>";
442 my @out_msg_l = ( $out_xml );
443 return @out_msg_l;
444 }
447 sub delete_jobdb_entry {
448 my ($msg) = @_ ;
449 my $msg_hash = &transform_msg2hash($msg);
451 # prepare query sql statement
452 my $table= $main::job_queue_table_name;
453 my $where= &get_where_statement($msg, $msg_hash);
454 my $sql_statement = "DELETE FROM $table $where";
456 # execute db query
457 my $db_res = $main::job_db->del_dbentry($sql_statement);
459 my $res;
460 if( $db_res > 0 ) {
461 $res = 0 ;
462 } else {
463 $res = 1;
464 }
466 # prepare xml answer
467 my $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
468 my @out_msg_l = ( $out_xml );
469 return @out_msg_l;
471 }
474 sub clear_jobdb {
475 my ($msg) = @_ ;
476 my $msg_hash = &transform_msg2hash($msg);
477 my $error= 0;
478 my $out_xml= "<xml><answer1>1</answer1></xml>";
480 my $table= $main::job_queue_table_name;
482 my $sql_statement = "DELETE FROM $table";
483 my $db_res = $main::job_db->del_dbentry($sql_statement);
484 if( not $db_res > 0 ) { $error++; };
486 if( $error == 0 ) {
487 $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
488 }
489 my @out_msg_l = ( $out_xml );
490 return @out_msg_l;
491 }
494 sub update_status_jobdb_entry {
495 my ($msg) = @_ ;
496 my $msg_hash = &transform_msg2hash($msg);
497 my $error= 0;
498 my $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>1</answer1></xml>";
500 my @len_hash = keys %{$msg_hash};
501 if( 0 == @len_hash) { $error++; };
503 # prepare query sql statement
504 if( $error == 0) {
505 my $table= $main::job_queue_table_name;
506 my $where= &get_where_statement($msg, $msg_hash);
507 my $update= &get_update_statement($msg, $msg_hash);
509 # conditions
510 # no timestamp update if status eq waiting
511 my $res_hash = $main::job_db->select_dbentry("SELECT * FROM $table $where AND status='processing' ");
512 if( (0 != keys(%$res_hash)) && ($update =~ /timestamp/i) ) {
513 $error ++;
514 $out_xml = "<answer1>1</answer1><error_string>there is no timestamp update allowed while status is 'processing'</error_string>";
515 }
517 if( $error == 0 ) {
518 my $sql_statement = "UPDATE $table $update $where";
519 # execute db query
520 my $db_res = $main::job_db->update_dbentry($sql_statement);
522 # check success of db update
523 if( not $db_res > 0 ) { $error++; };
525 }
526 }
528 if( $error == 0) {
529 $out_xml = "<answer1>0</answer1>";
530 }
532 my $out_msg = sprintf("<xml><header>answer</header><source>%s</source><target>GOSA</target>%s</xml>", $server_address, $out_xml);
533 my @out_msg_l = ( $out_msg );
534 return @out_msg_l;
535 }
538 1;