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 #y $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 }
231 #=== FUNCTION ================================================================
232 # NAME: process_incoming_msg
233 # PARAMETERS: crypted_msg - string - incoming crypted message
234 # RETURNS: nothing
235 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
236 #===============================================================================
237 sub process_incoming_msg {
238 my ($msg, $msg_hash) = @_ ;
239 my $header = @{$msg_hash->{header}}[0];
240 my $out_msg;
242 &main::daemon_log("GosaPackages: receive '$header'", 1);
244 if ($header =~ /^job_/) {
245 $out_msg = &process_job_msg($msg, $msg_hash);
246 }
247 elsif ($header =~ /^gosa_/) {
248 $out_msg = &process_gosa_msg($msg, $header);
249 }
250 else {
251 &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
252 }
254 # keep job queue uptodate and save result and status
255 if ($out_msg =~ /<jobdb_id>(\d*?)<\/jobdb_id>/) {
256 my $job_id = $1;
257 my $sql = "UPDATE '".$main::job_queue_table_name.
258 "' SET status='done', result='".$out_msg.
259 "' WHERE id='$job_id'";
260 my $res = $main::job_db->exec_statement($sql);
261 }
263 my @out_msg_l;
264 push(@out_msg_l, $out_msg);
265 return \@out_msg_l;
266 }
269 sub process_gosa_msg {
270 my ($msg, $header) = @_ ;
271 my $out_msg;
272 $header =~ s/gosa_//;
274 # decide wether msg is a core function or a event handler
275 if ( $header eq 'query_jobdb') { $out_msg = &query_jobdb }
276 elsif ($header eq 'delete_jobdb_entry') { $out_msg = &delete_jobdb_entry }
277 elsif ($header eq 'clear_jobdb') { $out_msg = &clear_jobdb }
278 elsif ($header eq 'update_status_jobdb_entry' ) { $out_msg = &update_status_jobdb_entry }
279 elsif ($header eq 'count_jobdb' ) { $out_msg = &count_jobdb }
280 else {
281 # msg could not be assigned to core function
282 # fetch all available eventhandler under $server_event_dir
283 opendir (DIR, $server_event_dir) or &main::daemon_log("ERROR cannot open $server_event_dir: $!\n", 1) and return;
284 while (defined (my $file = readdir (DIR))) {
285 if (not $file eq $header) {
286 next;
287 }
288 # try to deliver incoming msg to eventhandler
289 my $cmd = File::Spec->join($server_event_dir, $header)." '$msg'";
290 &main::daemon_log("GosaPackages: execute event_handler $header", 3);
291 &main::daemon_log("GosaPackages: cmd: $cmd", 8);
293 $out_msg = "";
294 open(PIPE, "$cmd 2>&1 |");
295 while(<PIPE>) {
296 $out_msg.=$_;
297 }
298 close(PIPE);
299 &main::daemon_log("GosaPackages: answer of cmd: $out_msg", 5);
300 last;
301 }
302 }
304 # if delivery not possible raise error and return
305 if (not defined $out_msg) {
306 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
307 } elsif ($out_msg eq "") {
308 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
309 }
310 return $out_msg;
312 }
315 sub process_job_msg {
316 my ($msg, $msg_hash)= @_ ;
318 my $header = @{$msg_hash->{header}}[0];
319 $header =~ s/job_//;
321 # check wether mac address is already known in known_daemons or known_clients
322 my $target = 'none';
324 # add job to job queue
325 my $func_dic = {table=>$main::job_queue_table_name,
326 primkey=>'id',
327 timestamp=>@{$msg_hash->{timestamp}}[0],
328 status=>'waiting',
329 result=>'none',
330 headertag=>$header,
331 targettag=>$target,
332 xmlmessage=>$msg,
333 macaddress=>@{$msg_hash->{mac}}[0],
334 };
335 my $res = $main::job_db->add_dbentry($func_dic);
336 if (not $res == 0) {
337 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
338 }
340 &main::daemon_log("GosaPackages: $header job successfully added to job queue", 3);
341 return "<xml><answer1>$res</answer1></xml>";
343 }
346 sub db_res_2_xml {
347 my ($db_res) = @_ ;
349 my $xml = "<xml>";
351 my $len_db_res= keys %{$db_res};
353 for( my $i= 1; $i<= $len_db_res; $i++ ) {
354 $xml .= "\n<answer$i>";
355 my $hash= $db_res->{$i};
356 while ( my ($column_name, $column_value) = each %{$hash} ) {
357 $xml .= "<$column_name>";
358 my $xml_content;
359 if( $column_name eq "xmlmessage" ) {
360 $xml_content = &encode_base64($column_value);
361 } else {
362 $xml_content = $column_value;
363 }
364 $xml .= $xml_content;
365 $xml .= "</$column_name>";
366 }
367 $xml .= "</answer$i>";
369 }
371 $xml .= "</xml>";
372 return $xml;
373 }
376 ## CORE FUNCTIONS ############################################################
378 sub query_jobdb {
379 my ($msg) = @_;
380 my $msg_hash = &transform_msg2hash($msg);
382 # prepare query sql statement
383 my $select= &get_select_statement($msg, $msg_hash);
384 my $table= $main::job_queue_table_name;
385 my $where= &get_where_statement($msg, $msg_hash);
386 my $limit= &get_limit_statement($msg, $msg_hash);
387 my $orderby= &get_orderby_statement($msg, $msg_hash);
388 my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
390 # execute db query
391 my $res_hash = $main::job_db->select_dbentry($sql_statement);
392 my $out_xml = &db_res_2_xml($res_hash);
394 return $out_xml;
395 }
398 sub count_jobdb {
399 my ($msg)= @_;
400 my $out_xml= "<xml><count>error</count></xml>";
402 # prepare query sql statement
403 my $table= $main::job_queue_table_name;
404 my $sql_statement= "SELECT * FROM $table ";
406 # execute db query
407 my $res_hash = $main::job_db->select_dbentry($sql_statement);
409 my $count = keys(%{$res_hash});
410 $out_xml= "<xml><count>$count</count></xml>";
412 return $out_xml;
413 }
416 sub delete_jobdb_entry {
417 my ($msg) = @_ ;
418 my $msg_hash = &transform_msg2hash($msg);
420 # prepare query sql statement
421 my $table= $main::job_queue_table_name;
422 my $where= &get_where_statement($msg, $msg_hash);
423 my $sql_statement = "DELETE FROM $table $where";
425 # execute db query
426 my $db_res = $main::job_db->del_dbentry($sql_statement);
428 my $res;
429 if( $db_res > 0 ) {
430 $res = 0 ;
431 } else {
432 $res = 1;
433 }
435 # prepare xml answer
436 my $out_xml = "<xml><answer1>$res</answer1></xml>";
437 return $out_xml;
439 }
442 sub clear_jobdb {
443 my ($msg) = @_ ;
444 my $msg_hash = &transform_msg2hash($msg);
445 my $error= 0;
446 my $out_xml= "<xml><answer1>1</answer1></xml>";
448 my $table= $main::job_queue_table_name;
450 my $sql_statement = "DELETE FROM $table";
451 my $db_res = $main::job_db->del_dbentry($sql_statement);
452 if( not $db_res > 0 ) { $error++; };
454 if( $error == 0 ) {
455 $out_xml = "<xml><answer1>0</answer1></xml>";
456 }
458 return $out_xml;
459 }
462 sub update_status_jobdb_entry {
463 my ($msg) = @_ ;
464 my $msg_hash = &transform_msg2hash($msg);
465 my $error= 0;
466 my $out_xml= "<xml><answer1>1</answer1></xml>";
468 my @len_hash = keys %{$msg_hash};
469 if( 0 == @len_hash) { $error++; };
471 # prepare query sql statement
472 if( $error == 0) {
473 my $table= $main::job_queue_table_name;
474 my $where= &get_where_statement($msg, $msg_hash);
475 my $update= &get_update_statement($msg, $msg_hash);
477 my $sql_statement = "UPDATE $table $update $where";
479 # execute db query
480 my $db_res = $main::job_db->update_dbentry($sql_statement);
482 # check success of db update
483 if( not $db_res > 0 ) { $error++; };
484 }
486 if( $error == 0) {
487 $out_xml = "<xml><answer1>0</answer1></xml>";
488 }
490 return $out_xml;
491 }
493 #sub update_timestamp_jobdb_entry {
494 # my ($msg) = @_ ;
495 # my $msg_hash = &transform_msg2hash($msg);
496 #
497 # # prepare query sql statement
498 # my $update_hash = {table=>$main::job_queue_table_name };
499 # if( exists $msg_hash->{where} ) {
500 # $update_hash->{where} = $msg_hash->{where};
501 # } else {
502 # $update_hash->{where} = [];
503 # }
504 #
505 # if( not exists $msg_hash->{update}[0]->{timestamp} ) {
506 # return "<xml><answer1>1</answer1></xml>";
507 # }
508 #
509 # $update_hash->{update} = [ { timestamp=>$msg_hash->{update}[0]->{timestamp} } ];
510 #
511 # # execute db query
512 # my $db_res = $main::job_db->update_dbentry($update_hash);
513 #
514 # # transform db answer to error returnment
515 # my $res;
516 # if( $db_res > 0 ) {
517 # $res = 0 ;
518 # } else {
519 # $res = 1;
520 # }
521 #
522 # # prepare xml answer
523 # my $out_xml = "<xml><answer1>$res</answer1></xml>";
524 # return $out_xml;
525 #
526 #}
529 1;