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;
16 BEGIN{}
17 END{}
19 my ($server_activ, $server_port, $server_passwd, $max_clients, $server_event_dir);
20 my ($bus_activ, $bus_passwd, $bus_ip, $bus_port);
21 my ($gosa_activ, $gosa_ip, $gosa_port, $gosa_passwd);
22 my ($job_queue_timeout, $job_queue_file_name);
24 my $gosa_server;
26 my %cfg_defaults =
27 ("general" =>
28 {"job_queue_file_name" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
29 },
30 "server" =>
31 {"server_activ" => [\$server_activ, "on"],
32 "server_port" => [\$server_port, "20081"],
33 "server_passwd" => [\$server_passwd, ""],
34 "max_clients" => [\$max_clients, 100],
35 "server_event_dir" => [\$server_event_dir, '/usr/lib/gosa-si/server/events'],
36 },
37 "bus" =>
38 {"bus_activ" => [\$bus_activ, "on"],
39 "bus_passwd" => [\$bus_passwd, ""],
40 "bus_ip" => [\$bus_ip, ""],
41 "bus_port" => [\$bus_port, "20080"],
42 },
43 "gosa" =>
44 {"gosa_activ" => [\$gosa_activ, "on"],
45 "gosa_ip" => [\$gosa_ip, ""],
46 "gosa_port" => [\$gosa_port, "20082"],
47 "gosa_passwd" => [\$gosa_passwd, "none"],
48 },
49 );
52 ## START ##########################
54 # read configfile and import variables
55 &read_configfile();
57 # detect own ip and mac address
58 my ($server_ip, $server_mac_address) = &get_ip_and_mac();
60 # complete addresses
61 my $server_address = "$server_ip:$server_port";
62 my $bus_address = "$bus_ip:$bus_port";
63 my $gosa_address = "$gosa_ip:$gosa_port";
65 # create general settings for this module
66 my $gosa_cipher = &create_ciphering($gosa_passwd);
67 my $xml = new XML::Simple();
69 # open gosa socket
70 if ($gosa_activ eq "on") {
71 &main::daemon_log(" ",1);
72 $gosa_server = IO::Socket::INET->new(LocalPort => $gosa_port,
73 Type => SOCK_STREAM,
74 Reuse => 1,
75 Listen => 1,
76 );
77 if (not defined $gosa_server) {
78 &main::daemon_log("cannot start tcp server at $gosa_port for communication to gosa: $@", 1);
79 } else {
80 &main::daemon_log("start server for communication to gosa: $gosa_address", 1);
82 }
83 }
85 # create gosa job queue as a SQLite DB
86 my $table_name = "jobs";
87 my $sqlite = GOSA::DBsqlite->new($job_queue_file_name);
92 ## FUNCTIONS #################################################################
94 sub get_module_info {
95 my @info = ($gosa_address,
96 $gosa_passwd,
97 $gosa_server,
98 $gosa_activ,
99 "socket",
100 );
101 return \@info;
102 }
105 #=== FUNCTION ================================================================
106 # NAME: read_configfile
107 # PARAMETERS: cfg_file - string -
108 # RETURNS: nothing
109 # DESCRIPTION: read cfg_file and set variables
110 #===============================================================================
111 sub read_configfile {
112 my $cfg;
113 if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
114 if( -r $main::cfg_file ) {
115 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
116 } else {
117 print STDERR "Couldn't read config file!";
118 }
119 } else {
120 $cfg = Config::IniFiles->new() ;
121 }
122 foreach my $section (keys %cfg_defaults) {
123 foreach my $param (keys %{$cfg_defaults{ $section }}) {
124 my $pinfo = $cfg_defaults{ $section }{ $param };
125 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
126 }
127 }
128 }
131 #=== FUNCTION ================================================================
132 # NAME: get_ip_and_mac
133 # PARAMETERS: nothing
134 # RETURNS: (ip, mac)
135 # DESCRIPTION: executes /sbin/ifconfig and parses the output, the first occurence
136 # of a inet address is returned as well as the mac address in the line
137 # above the inet address
138 #===============================================================================
139 sub get_ip_and_mac {
140 my $ip = "0.0.0.0.0"; # Defualt-IP
141 my $mac = "00:00:00:00:00:00"; # Default-MAC
142 my @ifconfig = qx(/sbin/ifconfig);
143 foreach(@ifconfig) {
144 if (/Hardware Adresse (\S{2}):(\S{2}):(\S{2}):(\S{2}):(\S{2}):(\S{2})/) {
145 $mac = "$1:$2:$3:$4:$5:$6";
146 next;
147 }
148 if (/inet Adresse:(\d+).(\d+).(\d+).(\d+)/) {
149 $ip = "$1.$2.$3.$4";
150 last;
151 }
152 }
153 return ($ip, $mac);
154 }
157 #=== FUNCTION ================================================================
158 # NAME: open_socket
159 # PARAMETERS: PeerAddr string something like 192.168.1.1 or 192.168.1.1:10000
160 # [PeerPort] string necessary if port not appended by PeerAddr
161 # RETURNS: socket IO::Socket::INET
162 # DESCRIPTION: open a socket to PeerAddr
163 #===============================================================================
164 sub open_socket {
165 my ($PeerAddr, $PeerPort) = @_ ;
166 if(defined($PeerPort)){
167 $PeerAddr = $PeerAddr.":".$PeerPort;
168 }
169 my $socket;
170 $socket = new IO::Socket::INET(PeerAddr => $PeerAddr ,
171 Porto => "tcp" ,
172 Type => SOCK_STREAM,
173 Timeout => 5,
174 );
175 if(not defined $socket) {
176 return;
177 }
178 &main::daemon_log("open_socket to: $PeerAddr", 7);
179 return $socket;
180 }
183 #=== FUNCTION ================================================================
184 # NAME: process_incoming_msg
185 # PARAMETERS: crypted_msg - string - incoming crypted message
186 # RETURNS: nothing
187 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
188 #===============================================================================
189 sub process_incoming_msg {
190 my ($crypted_msg) = @_ ;
191 if(not defined $crypted_msg) {
192 &main::daemon_log("function 'process_incoming_msg': got no msg", 7);
193 }
194 &main::daemon_log("GosaPackages: incoming msg: \n$crypted_msg", 7);
196 $crypted_msg =~ /^([\s\S]*?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)$/;
197 $crypted_msg = $1;
198 my $host = sprintf("%s.%s.%s.%s", $2, $3, $4, $5);
200 # collect addresses from possible incoming clients
201 # only gosa is allowd as incoming client
202 &main::daemon_log("GosaPackages: host_key: $host", 7);
203 &main::daemon_log("GosaPackages: key_passwd: $gosa_passwd", 7);
205 $gosa_cipher = &create_ciphering($gosa_passwd);
207 # determine the correct passwd for deciphering of the incoming msgs
208 my $msg = "";
209 my $msg_hash;
210 eval{
211 $msg = &decrypt_msg($crypted_msg, $gosa_cipher);
212 &main::daemon_log("GosaPackages: decrypted_msg: \n$msg", 7);
214 $msg_hash = $xml->XMLin($msg, ForceArray=>1);
215 };
216 if($@) {
217 &main::daemon_log("WARNING: GosaPackages do not understand the message:", 5);
218 &main::daemon_log("$@", 7);
219 return;
220 }
222 my $header = @{$msg_hash->{header}}[0];
224 &main::daemon_log("recieve '$header' at GosaPackages from $host", 1);
225 &main::daemon_log("$msg", 7);
227 my $out_msg;
228 if ($header =~ /^job_/) {
229 $out_msg = &process_job_msg($msg, $msg_hash);
230 } elsif ($header =~ /^gosa_/) {
231 $out_msg = &process_gosa_msg($msg, $header);
232 } else {
233 &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
234 }
236 if (not defined $out_msg) {
237 return;
238 }
240 if ($out_msg =~ /<jobdb_id>(\d*?)<\/jobdb_id>/) {
241 my $job_id = $1;
242 my $sql = "UPDATE '$main::job_queue_table_name' SET status='done', result='$out_msg' WHERE id='$job_id'";
243 my $res = $main::job_db->exec_statement($sql);
244 return;
246 } else {
247 my $out_cipher = &create_ciphering($gosa_passwd);
248 $out_msg = &encrypt_msg($out_msg, $out_cipher);
249 return $out_msg;
250 }
252 }
254 sub process_gosa_msg {
255 my ($msg, $header) = @_ ;
256 my $out_msg;
257 $header =~ s/gosa_//;
258 &main::daemon_log("GosaPackages: got a gosa msg $header", 5);
260 # decide wether msg is a core function or a event handler
261 if ( $header eq 'query_jobdb') { $out_msg = &query_jobdb }
262 elsif ($header eq 'delete_jobdb_entry') { $out_msg = &delete_jobdb_entry }
263 elsif ($header eq 'clear_jobdb') { $out_msg = &clear_jobdb }
264 elsif ($header eq 'update_status_jobdb_entry' ) { $out_msg = &update_status_jobdb_entry }
265 elsif ($header eq 'update_timestamp_jobdb_entry' ) { $out_msg = &update_timestamp_jobdb_entry }
266 else {
267 # msg could not be assigned to core function
268 # fetch all available eventhandler under $server_event_dir
269 opendir (DIR, $server_event_dir) or &main::daemon_log("ERROR cannot open $server_event_dir: $!\n", 1) and return;
270 while (defined (my $file = readdir (DIR))) {
271 if (not $file eq $header) {
272 next;
273 }
274 # try to deliver incoming msg to eventhandler
275 my $cmd = File::Spec->join($server_event_dir, $header)." '$msg'";
276 &main::daemon_log("GosaPackages: execute event_handler $header", 3);
277 &main::daemon_log("GosaPackages: cmd: $cmd", 7);
279 $out_msg = "";
280 open(PIPE, "$cmd 2>&1 |");
281 while(<PIPE>) {
282 $out_msg.=$_;
283 }
284 close(PIPE);
285 &main::daemon_log("GosaPackages: answer of cmd: $out_msg", 5);
286 last;
287 }
288 }
290 # if delivery not possible raise error and return
291 if (not defined $out_msg) {
292 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
293 } elsif ($out_msg eq "") {
294 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
295 }
296 return $out_msg;
298 }
301 sub process_job_msg {
302 my ($msg, $msg_hash)= @_ ;
304 my $header = @{$msg_hash->{header}}[0];
305 $header =~ s/job_//;
306 &main::daemon_log("GosaPackages: got a job msg $header", 5);
308 # check wether mac address is already known in known_daemons or known_clients
309 my $target = 'not known until now';
311 # add job to job queue
312 my $func_dic = {table=>$main::job_queue_table_name,
313 timestamp=>@{$msg_hash->{timestamp}}[0],
314 status=>'waiting',
315 result=>'none',
316 headertag=>$header,
317 targettag=>$target,
318 xmlmessage=>$msg,
319 macaddress=>@{$msg_hash->{mac}}[0],
320 };
321 my $res = $main::job_db->add_dbentry($func_dic);
322 if (not $res == 0) {
323 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
324 }
326 &main::daemon_log("GosaPackages: $header job successfully added to job queue", 3);
327 return "<xml><1>$res</1></xml>";
329 }
332 sub db_res_2_xml {
333 my ($db_res) = @_ ;
334 my $xml = "<xml>";
336 while ( my ($hit, $hash) = each %{ $db_res } ) {
337 $xml .= "<$hit>";
339 while ( my ($column_name, $column_value) = each %{$hash} ) {
340 $xml .= "<$column_name>";
341 my $xml_content = $column_value;
342 if( $column_name eq "xml" ) {
343 $xml_content = &encode_base64($column_value);
344 }
345 $xml .= $xml_content;
346 $xml .= "</$column_name>";
347 }
349 $xml .= "</$hit>";
350 }
352 $xml .= "</xml>";
353 return $xml;
354 }
357 ## CORE FUNCTIONS ############################################################
359 sub query_jobdb {
360 my ($msg) = @_;
361 my $msg_hash = &transform_msg2hash($msg);
363 # prepare query sql statement
364 my @where = @{$msg_hash->{where}};
365 my $where_hash = {table=>$main::job_queue_table_name };
366 foreach my $where_pram (@where) {
367 my $where_val = @{$msg_hash->{$where_pram}}[0];
368 if (defined $where_val) {
369 $where_hash->{$where_pram} = $where_val;
370 }
371 }
373 # execute db query
374 my $res_hash = $main::job_db->select_dbentry($where_hash);
376 my $out_xml = &db_res_2_xml($res_hash);
377 return $out_xml;
378 }
380 sub delete_jobdb_entry {
381 my ($msg) = @_ ;
382 my $msg_hash = &transform_msg2hash($msg);
384 # prepare query sql statement
385 my @where = @{$msg_hash->{where}};
386 my $where_hash = {table=>$main::job_queue_table_name };
387 foreach my $where_pram (@where) {
388 my $where_val = @{$msg_hash->{$where_pram}}[0];
389 if (defined $where_val) {
390 $where_hash->{$where_pram} = $where_val;
391 }
392 }
394 # execute db query
395 my $db_res = $main::job_db->del_dbentry($where_hash);
397 my $res;
398 if( $db_res > 0 ) {
399 $res = 0 ;
400 } else {
401 $res = 1;
402 }
404 # prepare xml answer
405 my $out_xml = "<xml><1>$res</1></xml>";
406 return $out_xml;
408 }
410 sub clear_jobdb {
411 my ($msg) = @_ ;
412 my $msg_hash = &transform_msg2hash($msg);
414 my $where_hash = {table=>$main::job_queue_table_name };
416 # execute db query
417 my $db_res = $main::job_db->del_dbentry($where_hash);
418 print STDERR "db_res=$db_res\n";
419 my $res;
420 if( $db_res eq '0E0' ) {
421 $res = 0 ;
422 } else {
423 $res = 1;
424 }
426 # prepare xml answer
427 my $out_xml = "<xml><1>$res</1></xml>";
428 return $out_xml;
429 }
431 sub update_status_jobdb_entry {
432 my ($msg) = @_ ;
433 my $msg_hash = &transform_msg2hash($msg);
435 # prepare query sql statement
436 my $update_hash = {table=>$main::job_queue_table_name };
437 if( exists $msg_hash->{where} ) {
438 $update_hash->{where} = $msg_hash->{where};
439 } else {
440 $update_hash->{where} = [];
441 }
443 if( not exists $msg_hash->{update}[0]->{status} ) {
444 return "<xml><1>1</1></xml>";
445 }
446 $update_hash->{update} = [ { status=>$msg_hash->{update}[0]->{status} } ];
448 # execute db query
449 my $db_res = $main::job_db->update_dbentry($update_hash);
451 # transform db answer to error returnment
452 my $res;
453 if( $db_res > 0 ) {
454 $res = 0 ;
455 } else {
456 $res = 1;
457 }
459 # prepare xml answer
460 my $out_xml = "<xml><1>$res</1></xml>";
461 return $out_xml;
462 }
464 sub update_timestamp_jobdb_entry {
465 my ($msg) = @_ ;
466 my $msg_hash = &transform_msg2hash($msg);
468 # prepare query sql statement
469 my $update_hash = {table=>$main::job_queue_table_name };
470 if( exists $msg_hash->{where} ) {
471 $update_hash->{where} = $msg_hash->{where};
472 } else {
473 $update_hash->{where} = [];
474 }
476 if( not exists $msg_hash->{update}[0]->{timestamp} ) {
477 return "<xml><1>1</1></xml>";
478 }
480 $update_hash->{update} = [ { timestamp=>$msg_hash->{update}[0]->{timestamp} } ];
482 # execute db query
483 my $db_res = $main::job_db->update_dbentry($update_hash);
485 # transform db answer to error returnment
486 my $res;
487 if( $db_res > 0 ) {
488 $res = 0 ;
489 } else {
490 $res = 1;
491 }
493 # prepare xml answer
494 my $out_xml = "<xml><1>$res</1></xml>";
495 return $out_xml;
497 }
500 1;