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 my $event_dir = "/usr/lib/gosa-si/server/events";
17 use lib "/usr/lib/gosa-si/server/events";
19 BEGIN{}
20 END{}
22 my ($server_activ, $server_ip, $server_mac_address, $server_port, $server_passwd, $max_clients, $server_event_dir);
23 my ($bus_activ, $bus_passwd, $bus_ip, $bus_port);
24 my ($gosa_activ, $gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
25 my ($job_queue_timeout, $job_queue_file_name);
27 my $gosa_server;
28 my $event_hash;
30 my %cfg_defaults =
31 ("general" =>
32 {"job_queue_file_name" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
33 },
34 "server" =>
35 {"server_activ" => [\$server_activ, "on"],
36 "server_ip" => [\$server_ip, "0.0.0.0"],
37 "server_port" => [\$server_port, "20081"],
38 "server_passwd" => [\$server_passwd, ""],
39 "max_clients" => [\$max_clients, 100],
40 },
41 "bus" =>
42 {"bus_activ" => [\$bus_activ, "on"],
43 "bus_passwd" => [\$bus_passwd, ""],
44 "bus_ip" => [\$bus_ip, "0.0.0.0"],
45 "bus_port" => [\$bus_port, "20080"],
46 },
47 "gosa" =>
48 {"gosa_activ" => [\$gosa_activ, "on"],
49 "gosa_ip" => [\$gosa_ip, "0.0.0.0"],
50 "gosa_port" => [\$gosa_port, "20082"],
51 "gosa_passwd" => [\$gosa_passwd, "none"],
52 },
53 );
56 ## START ##########################
58 # read configfile and import variables
59 &read_configfile();
60 $network_interface= &get_interface_for_ip($server_ip);
61 $gosa_mac_address= &get_mac($network_interface);
63 # complete addresses
64 my $server_address = "$server_ip:$server_port";
65 my $bus_address = "$bus_ip:$bus_port";
66 my $gosa_address = "$gosa_ip:$gosa_port";
68 # create general settings for this module
69 #y $gosa_cipher = &create_ciphering($gosa_passwd);
70 my $xml = new XML::Simple();
73 # import events
74 &import_events();
76 ## FUNCTIONS #################################################################
78 sub get_module_info {
79 my @info = ($gosa_address,
80 $gosa_passwd,
81 $gosa_server,
82 $gosa_activ,
83 "socket",
84 );
85 return \@info;
86 }
89 #=== FUNCTION ================================================================
90 # NAME: read_configfile
91 # PARAMETERS: cfg_file - string -
92 # RETURNS: nothing
93 # DESCRIPTION: read cfg_file and set variables
94 #===============================================================================
95 sub read_configfile {
96 my $cfg;
97 if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
98 if( -r $main::cfg_file ) {
99 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
100 } else {
101 print STDERR "Couldn't read config file!";
102 }
103 } else {
104 $cfg = Config::IniFiles->new() ;
105 }
106 foreach my $section (keys %cfg_defaults) {
107 foreach my $param (keys %{$cfg_defaults{ $section }}) {
108 my $pinfo = $cfg_defaults{ $section }{ $param };
109 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
110 }
111 }
112 }
114 #=== FUNCTION ================================================================
115 # NAME: get_interface_for_ip
116 # PARAMETERS: ip address (i.e. 192.168.0.1)
117 # RETURNS: array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
118 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
119 #===============================================================================
120 sub get_interface_for_ip {
121 my $result;
122 my $ip= shift;
123 if ($ip && length($ip) > 0) {
124 my @ifs= &get_interfaces();
125 if($ip eq "0.0.0.0") {
126 $result = "all";
127 } else {
128 foreach (@ifs) {
129 my $if=$_;
130 if(get_ip($if) eq $ip) {
131 $result = $if;
132 }
133 }
134 }
135 }
136 return $result;
137 }
139 #=== FUNCTION ================================================================
140 # NAME: get_interfaces
141 # PARAMETERS: none
142 # RETURNS: (list of interfaces)
143 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
144 #===============================================================================
145 sub get_interfaces {
146 my @result;
147 my $PROC_NET_DEV= ('/proc/net/dev');
149 open(PROC_NET_DEV, "<$PROC_NET_DEV")
150 or die "Could not open $PROC_NET_DEV";
152 my @ifs = <PROC_NET_DEV>;
154 close(PROC_NET_DEV);
156 # Eat first two line
157 shift @ifs;
158 shift @ifs;
160 chomp @ifs;
161 foreach my $line(@ifs) {
162 my $if= (split /:/, $line)[0];
163 $if =~ s/^\s+//;
164 push @result, $if;
165 }
167 return @result;
168 }
170 #=== FUNCTION ================================================================
171 # NAME: get_mac
172 # PARAMETERS: interface name (i.e. eth0)
173 # RETURNS: (mac address)
174 # DESCRIPTION: Uses ioctl to get mac address directly from system.
175 #===============================================================================
176 sub get_mac {
177 my $ifreq= shift;
178 my $result;
179 if ($ifreq && length($ifreq) > 0) {
180 if($ifreq eq "all") {
181 $result = "00:00:00:00:00:00";
182 } else {
183 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
185 # A configured MAC Address should always override a guessed value
186 if ($gosa_mac_address and length($gosa_mac_address) > 0) {
187 $result= $gosa_mac_address;
188 }
190 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
191 or die "socket: $!";
193 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
194 my ($if, $mac)= unpack 'h36 H12', $ifreq;
196 if (length($mac) > 0) {
197 $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])$/;
198 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
199 $result = $mac;
200 }
201 }
202 }
203 }
204 return $result;
205 }
207 #=== FUNCTION ================================================================
208 # NAME: get_ip
209 # PARAMETERS: interface name (i.e. eth0)
210 # RETURNS: (ip address)
211 # DESCRIPTION: Uses ioctl to get ip address directly from system.
212 #===============================================================================
213 sub get_ip {
214 my $ifreq= shift;
215 my $result= "";
216 my $SIOCGIFADDR= 0x8915; # man 2 ioctl_list
217 my $proto= getprotobyname('ip');
219 socket SOCKET, PF_INET, SOCK_DGRAM, $proto
220 or die "socket: $!";
222 if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
223 my ($if, $sin) = unpack 'a16 a16', $ifreq;
224 my ($port, $addr) = sockaddr_in $sin;
225 my $ip = inet_ntoa $addr;
227 if ($ip && length($ip) > 0) {
228 $result = $ip;
229 }
230 }
232 return $result;
233 }
236 sub import_events {
237 if (not -e $event_dir) {
238 daemon_log("ERROR: cannot find directory or directory is not readable: $event_dir", 1);
239 }
240 opendir (DIR, $event_dir) or die "ERROR while loading gosa-si-events from directory $event_dir : $!\n";
242 while (defined (my $event = readdir (DIR))) {
243 if( $event eq "." || $event eq ".." ) { next; }
245 eval{ require $event; };
246 if( $@ ) {
247 &main::daemon_log("import of event module '$event' failed", 1);
248 &main::daemon_log("$@", 8);
249 next;
250 }
252 $event =~ /(\S*?).pm$/;
253 my $event_module = $1;
254 my $events_l = eval( $1."::get_events()") ;
255 foreach my $event_name (@{$events_l}) {
256 $event_hash->{$event_name} = $event_module;
257 }
259 }
260 }
263 #=== FUNCTION ================================================================
264 # NAME: process_incoming_msg
265 # PARAMETERS: crypted_msg - string - incoming crypted message
266 # RETURNS: nothing
267 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
268 #===============================================================================
269 sub process_incoming_msg {
270 my ($msg, $msg_hash) = @_ ;
271 my $header = @{$msg_hash->{header}}[0];
272 my $out_msg;
274 &main::daemon_log("GosaPackages: receive '$header'", 1);
276 if ($header =~ /^job_/) {
277 $out_msg = &process_job_msg($msg, $msg_hash);
278 }
279 elsif ($header =~ /^gosa_/) {
280 $out_msg = &process_gosa_msg($msg, $msg_hash);
281 }
282 else {
283 &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
284 }
286 # keep job queue uptodate and save result and status
287 if (defined ($out_msg) && $out_msg =~ /<jobdb_id>(\d*?)<\/jobdb_id>/) {
288 my $job_id = $1;
289 my $sql = "UPDATE '".$main::job_queue_table_name.
290 "' SET status='done', result='".$out_msg.
291 "' WHERE id='$job_id'";
292 my $res = $main::job_db->exec_statement($sql);
293 }
295 my @out_msg_l;
296 if (defined $out_msg){
297 push(@out_msg_l, $out_msg);
298 }
299 return \@out_msg_l;
300 }
303 sub process_gosa_msg {
304 my ($msg, $msg_hash) = @_ ;
305 my $out_msg;
307 my $header = @{$msg_hash->{'header'}}[0];
308 $header =~ s/gosa_//;
310 # decide wether msg is a core function or a event handler
311 if ( $header eq 'query_jobdb') {
312 $out_msg = &query_jobdb
313 } elsif ($header eq 'delete_jobdb_entry') {
314 $out_msg = &delete_jobdb_entry
315 } elsif ($header eq 'clear_jobdb') {
316 $out_msg = &clear_jobdb
317 } elsif ($header eq 'update_status_jobdb_entry' ) {
318 $out_msg = &update_status_jobdb_entry
319 } elsif ($header eq 'count_jobdb' ) {
320 $out_msg = &count_jobdb
321 } elsif ($header eq 'trigger_action_reboot' ) {
322 print STDERR "trigger_action_reboot\n";
323 print STDERR Dumper($msg);
324 } elsif ($header eq 'trigger_action_wake' ) {
325 # Forward messages to all known servers as "trigger_wake"
326 my $in_hash= &transform_msg2hash($msg);
327 my %data = ( 'macAddress' => \@{$in_hash->{macAddress}} );
328 $out_msg = &send_msg("trigger_wake", $server_address, "KNOWN_SERVER", \%data);
329 } else {
330 # msg could not be assigned to core function
331 # maybe it is an eventa
332 if( exists $event_hash->{$header} ) {
333 # a event exists with the header as name
334 &main::daemon_log("found event '$header' at event-module '".$event_hash->{$header}."'", 5);
335 no strict 'refs';
336 $out_msg = &{$event_hash->{$header}."::$header"}($msg, $msg_hash);
337 }
339 # opendir (DIR, $server_event_dir) or &main::daemon_log("ERROR cannot open $server_event_dir: $!\n", 1) and return;
340 # while (defined (my $file = readdir (DIR))) {
341 # if (not $file eq $header) {
342 # next;
343 # }
344 # # try to deliver incoming msg to eventhandler
345 # my $cmd = File::Spec->join($server_event_dir, $header)." '$msg'";
346 # &main::daemon_log("GosaPackages: execute event_handler $header", 3);
347 # &main::daemon_log("GosaPackages: cmd: $cmd", 8);
348 #
349 # $out_msg = "";
350 # open(PIPE, "$cmd 2>&1 |");
351 # while(<PIPE>) {
352 # $out_msg.=$_;
353 # }
354 # close(PIPE);
355 # &main::daemon_log("GosaPackages: answer of cmd: $out_msg", 5);
356 # last;
357 # }
358 }
360 # if delivery not possible raise error and return
361 if (not defined $out_msg) {
362 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
363 } elsif ($out_msg eq "") {
364 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
365 }
366 return $out_msg;
368 }
371 sub process_job_msg {
372 my ($msg, $msg_hash)= @_ ;
374 my $header = @{$msg_hash->{header}}[0];
375 $header =~ s/job_//;
377 # check wether mac address is already known in known_daemons or known_clients
378 my $target = 'none';
380 # add job to job queue
381 my $func_dic = {table=>$main::job_queue_table_name,
382 primkey=>'id',
383 timestamp=>@{$msg_hash->{timestamp}}[0],
384 status=>'waiting',
385 result=>'none',
386 headertag=>$header,
387 targettag=>$target,
388 xmlmessage=>$msg,
389 macaddress=>@{$msg_hash->{mac}}[0],
390 };
391 my $res = $main::job_db->add_dbentry($func_dic);
392 if (not $res == 0) {
393 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
394 }
396 &main::daemon_log("GosaPackages: $header job successfully added to job queue", 3);
397 return "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
399 }
402 sub db_res_2_xml {
403 my ($db_res) = @_ ;
405 my $xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target>";
407 my $len_db_res= keys %{$db_res};
409 for( my $i= 1; $i<= $len_db_res; $i++ ) {
410 $xml .= "\n<answer$i>";
411 my $hash= $db_res->{$i};
412 while ( my ($column_name, $column_value) = each %{$hash} ) {
413 $xml .= "<$column_name>";
414 my $xml_content;
415 if( $column_name eq "xmlmessage" ) {
416 $xml_content = &encode_base64($column_value);
417 } else {
418 $xml_content = $column_value;
419 }
420 $xml .= $xml_content;
421 $xml .= "</$column_name>";
422 }
423 $xml .= "</answer$i>";
425 }
427 $xml .= "</xml>";
428 return $xml;
429 }
432 ## CORE FUNCTIONS ############################################################
434 sub query_jobdb {
435 my ($msg) = @_;
436 my $msg_hash = &transform_msg2hash($msg);
438 # prepare query sql statement
439 my $select= &get_select_statement($msg, $msg_hash);
440 my $table= $main::job_queue_table_name;
441 my $where= &get_where_statement($msg, $msg_hash);
442 my $limit= &get_limit_statement($msg, $msg_hash);
443 my $orderby= &get_orderby_statement($msg, $msg_hash);
444 my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
446 # execute db query
447 my $res_hash = $main::job_db->select_dbentry($sql_statement);
448 my $out_xml = &db_res_2_xml($res_hash);
450 return $out_xml;
451 }
454 sub count_jobdb {
455 my ($msg)= @_;
456 my $out_xml= "<xml><count>error</count></xml>";
458 # prepare query sql statement
459 my $table= $main::job_queue_table_name;
460 my $sql_statement= "SELECT * FROM $table ";
462 # execute db query
463 my $res_hash = $main::job_db->select_dbentry($sql_statement);
465 my $count = keys(%{$res_hash});
466 $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><count>$count</count></xml>";
468 return $out_xml;
469 }
472 sub delete_jobdb_entry {
473 my ($msg) = @_ ;
474 my $msg_hash = &transform_msg2hash($msg);
476 # prepare query sql statement
477 my $table= $main::job_queue_table_name;
478 my $where= &get_where_statement($msg, $msg_hash);
479 my $sql_statement = "DELETE FROM $table $where";
481 # execute db query
482 my $db_res = $main::job_db->del_dbentry($sql_statement);
484 my $res;
485 if( $db_res > 0 ) {
486 $res = 0 ;
487 } else {
488 $res = 1;
489 }
491 # prepare xml answer
492 my $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
493 return $out_xml;
495 }
498 sub clear_jobdb {
499 my ($msg) = @_ ;
500 my $msg_hash = &transform_msg2hash($msg);
501 my $error= 0;
502 my $out_xml= "<xml><answer1>1</answer1></xml>";
504 my $table= $main::job_queue_table_name;
506 my $sql_statement = "DELETE FROM $table";
507 my $db_res = $main::job_db->del_dbentry($sql_statement);
508 if( not $db_res > 0 ) { $error++; };
510 if( $error == 0 ) {
511 $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
512 }
514 return $out_xml;
515 }
518 sub update_status_jobdb_entry {
519 my ($msg) = @_ ;
520 my $msg_hash = &transform_msg2hash($msg);
521 my $error= 0;
522 my $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>1</answer1></xml>";
524 my @len_hash = keys %{$msg_hash};
525 if( 0 == @len_hash) { $error++; };
527 # prepare query sql statement
528 if( $error == 0) {
529 my $table= $main::job_queue_table_name;
530 my $where= &get_where_statement($msg, $msg_hash);
531 my $update= &get_update_statement($msg, $msg_hash);
533 my $sql_statement = "UPDATE $table $update $where";
535 # execute db query
536 my $db_res = $main::job_db->update_dbentry($sql_statement);
538 # check success of db update
539 if( not $db_res > 0 ) { $error++; };
540 }
542 if( $error == 0) {
543 $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
544 }
546 return $out_xml;
547 }
550 1;