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 XML::Simple;
11 use File::Spec;
12 use Data::Dumper;
13 use GOSA::DBsqlite;
14 use MIME::Base64;
17 BEGIN{}
18 END{}
20 my ($server_activ, $server_ip, $server_mac_address, $server_port, $server_passwd, $max_clients, $server_event_dir);
21 my ($bus_activ, $bus_passwd, $bus_ip, $bus_port);
22 my ($gosa_activ, $gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
23 my ($job_queue_timeout, $job_queue_file_name);
25 my $gosa_server;
27 my %cfg_defaults =
28 ("general" =>
29 {"job_queue_file_name" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
30 },
31 "server" =>
32 {"server_activ" => [\$server_activ, "on"],
33 "server_ip" => [\$server_ip, "0.0.0.0"],
34 "server_port" => [\$server_port, "20081"],
35 "server_passwd" => [\$server_passwd, ""],
36 "max_clients" => [\$max_clients, 100],
37 "server_event_dir" => [\$server_event_dir, '/usr/lib/gosa-si/server/events'],
38 },
39 "bus" =>
40 {"bus_activ" => [\$bus_activ, "on"],
41 "bus_passwd" => [\$bus_passwd, ""],
42 "bus_ip" => [\$bus_ip, "0.0.0.0"],
43 "bus_port" => [\$bus_port, "20080"],
44 },
45 "gosa" =>
46 {"gosa_activ" => [\$gosa_activ, "on"],
47 "gosa_ip" => [\$gosa_ip, "0.0.0.0"],
48 "gosa_port" => [\$gosa_port, "20082"],
49 "gosa_passwd" => [\$gosa_passwd, "none"],
50 },
51 );
54 ## START ##########################
56 # read configfile and import variables
57 &read_configfile();
58 $network_interface= &get_interface_for_ip($server_ip);
59 $gosa_mac_address= &get_mac($network_interface);
61 # complete addresses
62 my $server_address = "$server_ip:$server_port";
63 my $bus_address = "$bus_ip:$bus_port";
64 my $gosa_address = "$gosa_ip:$gosa_port";
66 # create general settings for this module
67 my $gosa_cipher = &create_ciphering($gosa_passwd);
68 my $xml = new XML::Simple();
71 ## FUNCTIONS #################################################################
73 sub get_module_info {
74 my @info = ($gosa_address,
75 $gosa_passwd,
76 $gosa_server,
77 $gosa_activ,
78 "socket",
79 );
80 return \@info;
81 }
84 #=== FUNCTION ================================================================
85 # NAME: read_configfile
86 # PARAMETERS: cfg_file - string -
87 # RETURNS: nothing
88 # DESCRIPTION: read cfg_file and set variables
89 #===============================================================================
90 sub read_configfile {
91 my $cfg;
92 if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
93 if( -r $main::cfg_file ) {
94 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
95 } else {
96 print STDERR "Couldn't read config file!";
97 }
98 } else {
99 $cfg = Config::IniFiles->new() ;
100 }
101 foreach my $section (keys %cfg_defaults) {
102 foreach my $param (keys %{$cfg_defaults{ $section }}) {
103 my $pinfo = $cfg_defaults{ $section }{ $param };
104 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
105 }
106 }
107 }
109 #=== FUNCTION ================================================================
110 # NAME: get_interface_for_ip
111 # PARAMETERS: ip address (i.e. 192.168.0.1)
112 # RETURNS: array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
113 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
114 #===============================================================================
115 sub get_interface_for_ip {
116 my $result;
117 my $ip= shift;
118 if ($ip && length($ip) > 0) {
119 my @ifs= &get_interfaces();
120 if($ip eq "0.0.0.0") {
121 $result = "all";
122 } else {
123 foreach (@ifs) {
124 my $if=$_;
125 if(get_ip($if) eq $ip) {
126 $result = $if;
127 }
128 }
129 }
130 }
131 return $result;
132 }
134 #=== FUNCTION ================================================================
135 # NAME: get_interfaces
136 # PARAMETERS: none
137 # RETURNS: (list of interfaces)
138 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
139 #===============================================================================
140 sub get_interfaces {
141 my @result;
142 my $PROC_NET_DEV= ('/proc/net/dev');
144 open(PROC_NET_DEV, "<$PROC_NET_DEV")
145 or die "Could not open $PROC_NET_DEV";
147 my @ifs = <PROC_NET_DEV>;
149 close(PROC_NET_DEV);
151 # Eat first two line
152 shift @ifs;
153 shift @ifs;
155 chomp @ifs;
156 foreach my $line(@ifs) {
157 my $if= (split /:/, $line)[0];
158 $if =~ s/^\s+//;
159 push @result, $if;
160 }
162 return @result;
163 }
165 #=== FUNCTION ================================================================
166 # NAME: get_mac
167 # PARAMETERS: interface name (i.e. eth0)
168 # RETURNS: (mac address)
169 # DESCRIPTION: Uses ioctl to get mac address directly from system.
170 #===============================================================================
171 sub get_mac {
172 my $ifreq= shift;
173 my $result;
174 if ($ifreq && length($ifreq) > 0) {
175 if($ifreq eq "all") {
176 $result = "00:00:00:00:00:00";
177 } else {
178 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
180 # A configured MAC Address should always override a guessed value
181 if ($gosa_mac_address and length($gosa_mac_address) > 0) {
182 $result= $gosa_mac_address;
183 }
185 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
186 or die "socket: $!";
188 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
189 my ($if, $mac)= unpack 'h36 H12', $ifreq;
191 if (length($mac) > 0) {
192 $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])$/;
193 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
194 $result = $mac;
195 }
196 }
197 }
198 }
199 return $result;
200 }
202 #=== FUNCTION ================================================================
203 # NAME: get_ip
204 # PARAMETERS: interface name (i.e. eth0)
205 # RETURNS: (ip address)
206 # DESCRIPTION: Uses ioctl to get ip address directly from system.
207 #===============================================================================
208 sub get_ip {
209 my $ifreq= shift;
210 my $result= "";
211 my $SIOCGIFADDR= 0x8915; # man 2 ioctl_list
212 my $proto= getprotobyname('ip');
214 socket SOCKET, PF_INET, SOCK_DGRAM, $proto
215 or die "socket: $!";
217 if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
218 my ($if, $sin) = unpack 'a16 a16', $ifreq;
219 my ($port, $addr) = sockaddr_in $sin;
220 my $ip = inet_ntoa $addr;
222 if ($ip && length($ip) > 0) {
223 $result = $ip;
224 }
225 }
227 return $result;
228 }
230 #=== FUNCTION ================================================================
231 # NAME: open_socket
232 # PARAMETERS: PeerAddr string something like 192.168.1.1 or 192.168.1.1:10000
233 # [PeerPort] string necessary if port not appended by PeerAddr
234 # RETURNS: socket IO::Socket::INET
235 # DESCRIPTION: open a socket to PeerAddr
236 #===============================================================================
237 #sub open_socket {
238 # my ($PeerAddr, $PeerPort) = @_ ;
239 # if(defined($PeerPort)){
240 # $PeerAddr = $PeerAddr.":".$PeerPort;
241 # }
242 # my $socket;
243 # $socket = new IO::Socket::INET(PeerAddr => $PeerAddr ,
244 # Porto => "tcp" ,
245 # Type => SOCK_STREAM,
246 # Timeout => 5,
247 # );
248 # if(not defined $socket) {
249 # return;
250 # }
251 # &main::daemon_log("open_socket to: $PeerAddr", 7);
252 # return $socket;
253 #}
256 #=== FUNCTION ================================================================
257 # NAME: process_incoming_msg
258 # PARAMETERS: crypted_msg - string - incoming crypted message
259 # RETURNS: nothing
260 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
261 #===============================================================================
262 sub process_incoming_msg {
263 my ($crypted_msg) = @_ ;
264 if( (not(defined($crypted_msg))) || (length($crypted_msg) <= 0)) {
265 &main::daemon_log("function 'process_incoming_msg': got no msg", 7);
266 return;
267 }
269 $crypted_msg =~ /^([\s\S]*?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)$/;
270 $crypted_msg = $1;
271 my $host = sprintf("%s.%s.%s.%s", $2, $3, $4, $5);
273 # collect addresses from possible incoming clients
274 # only gosa is allowd as incoming client
275 &main::daemon_log("GosaPackages: host_key: $host", 7);
276 &main::daemon_log("GosaPackages: key_passwd: $gosa_passwd", 7);
278 $gosa_cipher = &create_ciphering($gosa_passwd);
280 # determine the correct passwd for deciphering of the incoming msgs
281 my $msg = "";
282 my $msg_hash;
283 eval{
284 $msg = &decrypt_msg($crypted_msg, $gosa_cipher);
285 &main::daemon_log("GosaPackages: decrypted_msg: \n$msg", 8);
287 $msg_hash = $xml->XMLin($msg, ForceArray=>1);
288 };
289 if($@) {
290 &main::daemon_log("WARNING: GosaPackages do not understand the message:", 5);
291 &main::daemon_log("$@", 7);
292 return;
293 }
295 my $header = @{$msg_hash->{header}}[0];
297 &main::daemon_log("GosaPackages: receive '$header' from $host", 1);
299 my $out_msg;
300 if ($header =~ /^job_/) {
301 $out_msg = &process_job_msg($msg, $msg_hash);
302 } elsif ($header =~ /^gosa_/) {
303 $out_msg = &process_gosa_msg($msg, $header);
304 } else {
305 &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
306 }
308 if (not defined $out_msg) {
309 return;
310 }
312 if ($out_msg =~ /<jobdb_id>(\d*?)<\/jobdb_id>/) {
313 my $job_id = $1;
314 my $sql = "UPDATE '".$main::job_queue_table_name.
315 "' SET status='done', result='".$out_msg.
316 "' WHERE id='$job_id'";
317 my $res = $main::job_db->exec_statement($sql);
318 return;
320 } else {
322 my $out_cipher = &create_ciphering($gosa_passwd);
323 $out_msg = &encrypt_msg($out_msg, $out_cipher);
324 return $out_msg;
325 }
327 }
329 sub process_gosa_msg {
330 my ($msg, $header) = @_ ;
331 my $out_msg;
332 $header =~ s/gosa_//;
334 # decide wether msg is a core function or a event handler
335 if ( $header eq 'query_jobdb') { $out_msg = &query_jobdb }
336 elsif ($header eq 'delete_jobdb_entry') { $out_msg = &delete_jobdb_entry }
337 elsif ($header eq 'clear_jobdb') { $out_msg = &clear_jobdb }
338 elsif ($header eq 'update_status_jobdb_entry' ) { $out_msg = &update_status_jobdb_entry }
339 elsif ($header eq 'count_jobdb' ) { $out_msg = &count_jobdb }
340 else {
341 # msg could not be assigned to core function
342 # fetch all available eventhandler under $server_event_dir
343 opendir (DIR, $server_event_dir) or &main::daemon_log("ERROR cannot open $server_event_dir: $!\n", 1) and return;
344 while (defined (my $file = readdir (DIR))) {
345 if (not $file eq $header) {
346 next;
347 }
348 # try to deliver incoming msg to eventhandler
349 my $cmd = File::Spec->join($server_event_dir, $header)." '$msg'";
350 &main::daemon_log("GosaPackages: execute event_handler $header", 3);
351 &main::daemon_log("GosaPackages: cmd: $cmd", 7);
353 $out_msg = "";
354 open(PIPE, "$cmd 2>&1 |");
355 while(<PIPE>) {
356 $out_msg.=$_;
357 }
358 close(PIPE);
359 &main::daemon_log("GosaPackages: answer of cmd: $out_msg", 5);
360 last;
361 }
362 }
364 # if delivery not possible raise error and return
365 if (not defined $out_msg) {
366 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
367 } elsif ($out_msg eq "") {
368 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
369 }
370 return $out_msg;
372 }
375 sub process_job_msg {
376 my ($msg, $msg_hash)= @_ ;
378 my $header = @{$msg_hash->{header}}[0];
379 $header =~ s/job_//;
381 # check wether mac address is already known in known_daemons or known_clients
382 my $target = 'none';
384 # add job to job queue
385 my $func_dic = {table=>$main::job_queue_table_name,
386 primkey=>'id',
387 timestamp=>@{$msg_hash->{timestamp}}[0],
388 status=>'waiting',
389 result=>'none',
390 headertag=>$header,
391 targettag=>$target,
392 xmlmessage=>$msg,
393 macaddress=>@{$msg_hash->{mac}}[0],
394 };
395 my $res = $main::job_db->add_dbentry($func_dic);
396 if (not $res == 0) {
397 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
398 }
400 &main::daemon_log("GosaPackages: $header job successfully added to job queue", 3);
401 return "<xml><answer1>$res</answer1></xml>";
403 }
406 sub db_res_2_xml {
407 my ($db_res) = @_ ;
409 my $xml = "<xml>";
411 my $len_db_res= keys %{$db_res};
413 for( my $i= 1; $i<= $len_db_res; $i++ ) {
414 $xml .= "\n<answer$i>";
415 my $hash= $db_res->{$i};
416 while ( my ($column_name, $column_value) = each %{$hash} ) {
417 $xml .= "<$column_name>";
418 my $xml_content;
419 if( $column_name eq "xmlmessage" ) {
420 $xml_content = &encode_base64($column_value);
421 } else {
422 $xml_content = $column_value;
423 }
424 $xml .= $xml_content;
425 $xml .= "</$column_name>";
426 }
427 $xml .= "</answer$i>";
429 }
431 $xml .= "</xml>";
432 return $xml;
433 }
436 ## CORE FUNCTIONS ############################################################
438 sub query_jobdb {
439 my ($msg) = @_;
440 my $msg_hash = &transform_msg2hash($msg);
442 # prepare query sql statement
443 my $select= &get_select_statement($msg, $msg_hash);
444 my $table= $main::job_queue_table_name;
445 my $where= &get_where_statement($msg, $msg_hash);
446 my $limit= &get_limit_statement($msg, $msg_hash);
447 my $orderby= &get_orderby_statement($msg, $msg_hash);
448 my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
450 # execute db query
451 my $res_hash = $main::job_db->select_dbentry($sql_statement);
452 my $out_xml = &db_res_2_xml($res_hash);
454 return $out_xml;
455 }
458 sub count_jobdb {
459 my ($msg)= @_;
460 my $out_xml= "<xml><count>error</count></xml>";
462 # prepare query sql statement
463 my $table= $main::job_queue_table_name;
464 my $sql_statement= "SELECT * FROM $table ";
466 # execute db query
467 my $res_hash = $main::job_db->select_dbentry($sql_statement);
469 my $count = keys(%{$res_hash});
470 $out_xml= "<xml><count>$count</count></xml>";
472 return $out_xml;
473 }
476 sub delete_jobdb_entry {
477 my ($msg) = @_ ;
478 my $msg_hash = &transform_msg2hash($msg);
480 # prepare query sql statement
481 my $table= $main::job_queue_table_name;
482 my $where= &get_where_statement($msg, $msg_hash);
483 my $sql_statement = "DELETE FROM $table $where";
485 # execute db query
486 my $db_res = $main::job_db->del_dbentry($sql_statement);
488 my $res;
489 if( $db_res > 0 ) {
490 $res = 0 ;
491 } else {
492 $res = 1;
493 }
495 # prepare xml answer
496 my $out_xml = "<xml><answer1>$res</answer1></xml>";
497 return $out_xml;
499 }
502 sub clear_jobdb {
503 my ($msg) = @_ ;
504 my $msg_hash = &transform_msg2hash($msg);
505 my $error= 0;
506 my $out_xml= "<xml><answer1>1</answer1></xml>";
508 my $table= $main::job_queue_table_name;
510 my $sql_statement = "DELETE FROM $table";
511 my $db_res = $main::job_db->del_dbentry($sql_statement);
512 if( not $db_res > 0 ) { $error++; };
514 if( $error == 0 ) {
515 $out_xml = "<xml><answer1>0</answer1></xml>";
516 }
518 return $out_xml;
519 }
522 sub update_status_jobdb_entry {
523 my ($msg) = @_ ;
524 my $msg_hash = &transform_msg2hash($msg);
525 my $error= 0;
526 my $out_xml= "<xml><answer1>1</answer1></xml>";
528 my @len_hash = keys %{$msg_hash};
529 if( 0 == @len_hash) { $error++; };
531 # prepare query sql statement
532 if( $error == 0) {
533 my $table= $main::job_queue_table_name;
534 my $where= &get_where_statement($msg, $msg_hash);
535 my $update= &get_update_statement($msg, $msg_hash);
537 my $sql_statement = "UPDATE $table $update $where";
539 # execute db query
540 my $db_res = $main::job_db->update_dbentry($sql_statement);
542 # check success of db update
543 if( not $db_res > 0 ) { $error++; };
544 }
546 if( $error == 0) {
547 $out_xml = "<xml><answer1>0</answer1></xml>";
548 }
550 return $out_xml;
551 }
553 #sub update_timestamp_jobdb_entry {
554 # my ($msg) = @_ ;
555 # my $msg_hash = &transform_msg2hash($msg);
556 #
557 # # prepare query sql statement
558 # my $update_hash = {table=>$main::job_queue_table_name };
559 # if( exists $msg_hash->{where} ) {
560 # $update_hash->{where} = $msg_hash->{where};
561 # } else {
562 # $update_hash->{where} = [];
563 # }
564 #
565 # if( not exists $msg_hash->{update}[0]->{timestamp} ) {
566 # return "<xml><answer1>1</answer1></xml>";
567 # }
568 #
569 # $update_hash->{update} = [ { timestamp=>$msg_hash->{update}[0]->{timestamp} } ];
570 #
571 # # execute db query
572 # my $db_res = $main::job_db->update_dbentry($update_hash);
573 #
574 # # transform db answer to error returnment
575 # my $res;
576 # if( $db_res > 0 ) {
577 # $res = 0 ;
578 # } else {
579 # $res = 1;
580 # }
581 #
582 # # prepare xml answer
583 # my $out_xml = "<xml><answer1>$res</answer1></xml>";
584 # return $out_xml;
585 #
586 #}
589 1;