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_ip, $server_mac_address, $server_port, $server_passwd, $max_clients);
23 my ($gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
24 my ($job_queue_timeout, $job_queue_file_name);
26 my $gosa_server;
27 my $event_hash;
29 my %cfg_defaults = (
30 "server" => {
31 "ip" => [\$server_ip, "0.0.0.0"],
32 "port" => [\$server_port, "20081"],
33 "key" => [\$server_passwd, ""],
34 "max-clients" => [\$max_clients, 100],
35 },
36 "GOsaPackages" => {
37 "ip" => [\$gosa_ip, "0.0.0.0"],
38 "port" => [\$gosa_port, "20082"],
39 "key" => [\$gosa_passwd, "none"],
40 "job-queue" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
41 },
42 );
45 ## START ##########################
47 # read configfile and import variables
48 &read_configfile();
49 $network_interface= &get_interface_for_ip($server_ip);
50 $gosa_mac_address= &get_mac($network_interface);
52 # complete addresses
53 our $server_address = "$server_ip:$server_port";
54 my $gosa_address = "$gosa_ip:$gosa_port";
56 # create general settings for this module
57 #y $gosa_cipher = &create_ciphering($gosa_passwd);
58 my $xml = new XML::Simple();
61 # import events
62 &import_events();
64 ## FUNCTIONS #################################################################
66 sub get_module_info {
67 my @info = ($gosa_address,
68 $gosa_passwd,
69 );
70 return \@info;
71 }
74 #=== FUNCTION ================================================================
75 # NAME: read_configfile
76 # PARAMETERS: cfg_file - string -
77 # RETURNS: nothing
78 # DESCRIPTION: read cfg_file and set variables
79 #===============================================================================
80 sub read_configfile {
81 my $cfg;
82 if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
83 if( -r $main::cfg_file ) {
84 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
85 } else {
86 print STDERR "Couldn't read config file!";
87 }
88 } else {
89 $cfg = Config::IniFiles->new() ;
90 }
91 foreach my $section (keys %cfg_defaults) {
92 foreach my $param (keys %{$cfg_defaults{ $section }}) {
93 my $pinfo = $cfg_defaults{ $section }{ $param };
94 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
95 }
96 }
97 }
99 #=== FUNCTION ================================================================
100 # NAME: get_interface_for_ip
101 # PARAMETERS: ip address (i.e. 192.168.0.1)
102 # RETURNS: array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
103 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
104 #===============================================================================
105 sub get_interface_for_ip {
106 my $result;
107 my $ip= shift;
108 if ($ip && length($ip) > 0) {
109 my @ifs= &get_interfaces();
110 if($ip eq "0.0.0.0") {
111 $result = "all";
112 } else {
113 foreach (@ifs) {
114 my $if=$_;
115 if(get_ip($if) eq $ip) {
116 $result = $if;
117 }
118 }
119 }
120 }
121 return $result;
122 }
124 #=== FUNCTION ================================================================
125 # NAME: get_interfaces
126 # PARAMETERS: none
127 # RETURNS: (list of interfaces)
128 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
129 #===============================================================================
130 sub get_interfaces {
131 my @result;
132 my $PROC_NET_DEV= ('/proc/net/dev');
134 open(PROC_NET_DEV, "<$PROC_NET_DEV")
135 or die "Could not open $PROC_NET_DEV";
137 my @ifs = <PROC_NET_DEV>;
139 close(PROC_NET_DEV);
141 # Eat first two line
142 shift @ifs;
143 shift @ifs;
145 chomp @ifs;
146 foreach my $line(@ifs) {
147 my $if= (split /:/, $line)[0];
148 $if =~ s/^\s+//;
149 push @result, $if;
150 }
152 return @result;
153 }
155 #=== FUNCTION ================================================================
156 # NAME: get_mac
157 # PARAMETERS: interface name (i.e. eth0)
158 # RETURNS: (mac address)
159 # DESCRIPTION: Uses ioctl to get mac address directly from system.
160 #===============================================================================
161 sub get_mac {
162 my $ifreq= shift;
163 my $result;
164 if ($ifreq && length($ifreq) > 0) {
165 if($ifreq eq "all") {
166 $result = "00:00:00:00:00:00";
167 } else {
168 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
170 # A configured MAC Address should always override a guessed value
171 if ($gosa_mac_address and length($gosa_mac_address) > 0) {
172 $result= $gosa_mac_address;
173 }
175 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
176 or die "socket: $!";
178 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
179 my ($if, $mac)= unpack 'h36 H12', $ifreq;
181 if (length($mac) > 0) {
182 $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])$/;
183 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
184 $result = $mac;
185 }
186 }
187 }
188 }
189 return $result;
190 }
192 #=== FUNCTION ================================================================
193 # NAME: get_ip
194 # PARAMETERS: interface name (i.e. eth0)
195 # RETURNS: (ip address)
196 # DESCRIPTION: Uses ioctl to get ip address directly from system.
197 #===============================================================================
198 sub get_ip {
199 my $ifreq= shift;
200 my $result= "";
201 my $SIOCGIFADDR= 0x8915; # man 2 ioctl_list
202 my $proto= getprotobyname('ip');
204 socket SOCKET, PF_INET, SOCK_DGRAM, $proto
205 or die "socket: $!";
207 if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
208 my ($if, $sin) = unpack 'a16 a16', $ifreq;
209 my ($port, $addr) = sockaddr_in $sin;
210 my $ip = inet_ntoa $addr;
212 if ($ip && length($ip) > 0) {
213 $result = $ip;
214 }
215 }
217 return $result;
218 }
221 sub import_events {
222 if (not -e $event_dir) {
223 daemon_log("ERROR: cannot find directory or directory is not readable: $event_dir", 1);
224 }
225 opendir (DIR, $event_dir) or die "ERROR while loading gosa-si-events from directory $event_dir : $!\n";
227 while (defined (my $event = readdir (DIR))) {
228 if( $event eq "." || $event eq ".." ) { next; }
230 eval{ require $event; };
231 if( $@ ) {
232 &main::daemon_log("import of event module '$event' failed", 1);
233 &main::daemon_log("$@", 8);
234 next;
235 }
237 $event =~ /(\S*?).pm$/;
238 my $event_module = $1;
239 my $events_l = eval( $1."::get_events()") ;
240 foreach my $event_name (@{$events_l}) {
241 $event_hash->{$event_name} = $event_module;
242 }
244 }
245 }
248 #=== FUNCTION ================================================================
249 # NAME: process_incoming_msg
250 # PARAMETERS: crypted_msg - string - incoming crypted message
251 # RETURNS: nothing
252 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
253 #===============================================================================
254 sub process_incoming_msg {
255 my ($msg, $msg_hash, $session_id) = @_ ;
256 my $header = @{$msg_hash->{header}}[0];
257 my @msg_l;
258 my @out_msg_l;
260 &main::daemon_log("GosaPackages: receive '$header'", 1);
262 if ($header =~ /^job_/) {
263 @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
264 }
265 elsif ($header =~ /^gosa_/) {
266 @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
267 }
268 else {
269 &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
270 }
272 foreach my $out_msg ( @msg_l ) {
274 # keep job queue uptodate and save result and status
275 if (defined ($out_msg) && $out_msg =~ /<jobdb_id>(\d*?)<\/jobdb_id>/) {
276 my $job_id = $1;
277 my $sql = "UPDATE '".$main::job_queue_table_name.
278 "' SET status='done', result='".$out_msg.
279 "' WHERE id='$job_id'";
280 my $res = $main::job_db->exec_statement($sql);
281 }
283 # substitute in all outgoing msg <source>GOSA</source> of <source>$server_address</source>
284 $out_msg =~ s/<source>GOSA<\/source>/<source>$server_address<\/source>/g;
286 if (defined $out_msg){
287 push(@out_msg_l, $out_msg);
288 }
290 }
292 return \@out_msg_l;
293 }
296 sub process_gosa_msg {
297 my ($msg, $msg_hash, $session_id) = @_ ;
298 my $out_msg;
299 my @out_msg_l;
301 my $header = @{$msg_hash->{'header'}}[0];
302 $header =~ s/gosa_//;
304 # decide wether msg is a core function or a event handler
305 if ( $header eq 'query_jobdb') {
306 $out_msg = &query_jobdb
307 } elsif ($header eq 'delete_jobdb_entry') {
308 $out_msg = &delete_jobdb_entry
309 } elsif ($header eq 'clear_jobdb') {
310 $out_msg = &clear_jobdb
311 } elsif ($header eq 'update_status_jobdb_entry' ) {
312 $out_msg = &update_status_jobdb_entry
313 } elsif ($header eq 'count_jobdb' ) {
314 $out_msg = &count_jobdb
315 } elsif ($header eq 'trigger_action_wake' ) {
316 # Forward messages to all known servers as "trigger_wake"
317 my $in_hash= &transform_msg2hash($msg);
318 my %data = ( 'macAddress' => \@{$in_hash->{macAddress}} );
319 $out_msg = &send_msg("trigger_wake", $server_address, "KNOWN_SERVER", \%data);
320 } else {
321 # msg could not be assigned to core function
322 # maybe it is an eventa
323 if( exists $event_hash->{$header} ) {
324 # a event exists with the header as name
325 &main::daemon_log("found event '$header' at event-module '".$event_hash->{$header}."'", 5);
326 no strict 'refs';
327 @out_msg_l = &{$event_hash->{$header}."::$header"}($msg, $msg_hash, $session_id);
328 }
329 }
331 # if delivery not possible raise error and return
332 if( not @out_msg_l ) {
333 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
334 } elsif( 0 == @out_msg_l) {
335 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
336 } elsif( $out_msg ) {
337 push(@out_msg_l, $out_msg);
338 }
340 return @out_msg_l;
342 }
345 sub process_job_msg {
346 my ($msg, $msg_hash)= @_ ;
347 my $out_msg;
348 my @out_msg_l;
350 my $header = @{$msg_hash->{header}}[0];
351 $header =~ s/job_//;
353 # check wether mac address is already known in known_daemons or known_clients
354 my $target = 'none';
356 # add job to job queue
357 my $func_dic = {table=>$main::job_queue_table_name,
358 primkey=>'id',
359 timestamp=>@{$msg_hash->{timestamp}}[0],
360 status=>'waiting',
361 result=>'none',
362 headertag=>$header,
363 targettag=>$target,
364 xmlmessage=>$msg,
365 macaddress=>@{$msg_hash->{mac}}[0],
366 };
367 my $res = $main::job_db->add_dbentry($func_dic);
368 if (not $res == 0) {
369 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
370 }
371 else {
372 &main::daemon_log("INFO: GosaPackages: $header job successfully added to job queue", 5);
373 }
375 $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
376 push( @out_msg_l, $out_msg );
378 return @out_msg_l;
380 }
383 sub db_res_2_xml {
384 my ($db_res) = @_ ;
386 my $xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target>";
388 my $len_db_res= keys %{$db_res};
390 for( my $i= 1; $i<= $len_db_res; $i++ ) {
391 $xml .= "\n<answer$i>";
392 my $hash= $db_res->{$i};
393 while ( my ($column_name, $column_value) = each %{$hash} ) {
394 $xml .= "<$column_name>";
395 my $xml_content;
396 if( $column_name eq "xmlmessage" ) {
397 $xml_content = &encode_base64($column_value);
398 } else {
399 $xml_content = $column_value;
400 }
401 $xml .= $xml_content;
402 $xml .= "</$column_name>";
403 }
404 $xml .= "</answer$i>";
406 }
408 $xml .= "</xml>";
409 return $xml;
410 }
413 ## CORE FUNCTIONS ############################################################
415 sub query_jobdb {
416 my ($msg) = @_;
417 my $msg_hash = &transform_msg2hash($msg);
419 # prepare query sql statement
420 my $select= &get_select_statement($msg, $msg_hash);
421 my $table= $main::job_queue_table_name;
422 my $where= &get_where_statement($msg, $msg_hash);
423 my $limit= &get_limit_statement($msg, $msg_hash);
424 my $orderby= &get_orderby_statement($msg, $msg_hash);
425 my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
427 # execute db query
428 my $res_hash = $main::job_db->select_dbentry($sql_statement);
429 my $out_xml = &db_res_2_xml($res_hash);
431 return $out_xml;
432 }
435 sub count_jobdb {
436 my ($msg)= @_;
437 my $out_xml= "<xml><count>error</count></xml>";
439 # prepare query sql statement
440 my $table= $main::job_queue_table_name;
441 my $sql_statement= "SELECT * FROM $table ";
443 # execute db query
444 my $res_hash = $main::job_db->select_dbentry($sql_statement);
446 my $count = keys(%{$res_hash});
447 $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><count>$count</count></xml>";
449 return $out_xml;
450 }
453 sub delete_jobdb_entry {
454 my ($msg) = @_ ;
455 my $msg_hash = &transform_msg2hash($msg);
457 # prepare query sql statement
458 my $table= $main::job_queue_table_name;
459 my $where= &get_where_statement($msg, $msg_hash);
460 my $sql_statement = "DELETE FROM $table $where";
462 # execute db query
463 my $db_res = $main::job_db->del_dbentry($sql_statement);
465 my $res;
466 if( $db_res > 0 ) {
467 $res = 0 ;
468 } else {
469 $res = 1;
470 }
472 # prepare xml answer
473 my $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
474 return $out_xml;
476 }
479 sub clear_jobdb {
480 my ($msg) = @_ ;
481 my $msg_hash = &transform_msg2hash($msg);
482 my $error= 0;
483 my $out_xml= "<xml><answer1>1</answer1></xml>";
485 my $table= $main::job_queue_table_name;
487 my $sql_statement = "DELETE FROM $table";
488 my $db_res = $main::job_db->del_dbentry($sql_statement);
489 if( not $db_res > 0 ) { $error++; };
491 if( $error == 0 ) {
492 $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
493 }
495 return $out_xml;
496 }
499 sub update_status_jobdb_entry {
500 my ($msg) = @_ ;
501 my $msg_hash = &transform_msg2hash($msg);
502 my $error= 0;
503 my $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>1</answer1></xml>";
505 my @len_hash = keys %{$msg_hash};
506 if( 0 == @len_hash) { $error++; };
508 # prepare query sql statement
509 if( $error == 0) {
510 my $table= $main::job_queue_table_name;
511 my $where= &get_where_statement($msg, $msg_hash);
512 my $update= &get_update_statement($msg, $msg_hash);
514 my $sql_statement = "UPDATE $table $update $where";
516 # execute db query
517 my $db_res = $main::job_db->update_dbentry($sql_statement);
519 # check success of db update
520 if( not $db_res > 0 ) { $error++; };
521 }
523 if( $error == 0) {
524 $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
525 }
527 return $out_xml;
528 }
531 1;