Code

* gosa-si-server-nobus
[gosa.git] / gosa-si / modules / GosaPackages.pm
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 Socket;
11 use XML::Simple;
12 use File::Spec;
13 use Data::Dumper;
14 use GOSA::DBsqlite;
15 use MIME::Base64;
17 my $event_dir = "/usr/lib/gosa-si/server/GosaPackages";
18 use lib "/usr/lib/gosa-si/server/GosaPackages";
20 BEGIN{}
21 END{}
23 my ($server_ip, $server_port, $server_passwd, $max_clients);
24 my ($gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
25 my ($job_queue_timeout, $job_queue_file_name);
27 my %cfg_defaults = (
28 "server" => {
29     "ip" => [\$server_ip, "0.0.0.0"],
30     "port" => [\$server_port, "20081"],
31     "key" => [\$server_passwd, ""],
32     "max-clients" => [\$max_clients, 100],
33     },
34 "GOsaPackages" => {
35     "ip" => [\$gosa_ip, "0.0.0.0"],
36     "port" => [\$gosa_port, "20082"],
37     "key" => [\$gosa_passwd, "none"],
38     "job-queue" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
39     },
40 );
41  
43 ## START ##########################
45 # read configfile and import variables
46 &read_configfile();
47 $network_interface= &get_interface_for_ip($server_ip);
48 $gosa_mac_address= &get_mac($network_interface);
50 # complete addresses
51 if( inet_aton($server_ip) ){ $server_ip = inet_ntoa(inet_aton($server_ip)); } 
52 our $server_address = "$server_ip:$server_port";
53 if( inet_aton($gosa_ip) ){ $gosa_ip = inet_ntoa(inet_aton($gosa_ip)); }
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();
60 # import local events
61 my ($error, $result, $event_hash) = &import_events($event_dir);
62 if ($error == 0) {
63     foreach my $log_line (@$result) {
64         &main::daemon_log("0 DEBUG: GosaPackages - $log_line", 7);
65     }
66 } else {
67     foreach my $log_line (@$result) {
68         &main::daemon_log("0 ERROR: GosaPackages - $log_line", 1);
69     }
70 }
73 ## FUNCTIONS #################################################################
75 sub get_module_info {
76     my @info = ($gosa_address,
77                 $gosa_passwd,
78                 );
79     return \@info;
80 }
83 #===  FUNCTION  ================================================================
84 #         NAME:  read_configfile
85 #   PARAMETERS:  cfg_file - string -
86 #      RETURNS:  nothing
87 #  DESCRIPTION:  read cfg_file and set variables
88 #===============================================================================
89 sub read_configfile {
90     my $cfg;
91     if( defined( $main::cfg_file) && ( (-s $main::cfg_file) > 0 )) {
92         if( -r $main::cfg_file ) {
93             $cfg = Config::IniFiles->new( -file => $main::cfg_file );
94         } else {
95             print STDERR "Couldn't read config file!";
96         }
97     } else {
98         $cfg = Config::IniFiles->new() ;
99     }
100     foreach my $section (keys %cfg_defaults) {
101         foreach my $param (keys %{$cfg_defaults{ $section }}) {
102             my $pinfo = $cfg_defaults{ $section }{ $param };
103             ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
104         }
105     }
108 #===  FUNCTION  ================================================================
109 #         NAME:  get_interface_for_ip
110 #   PARAMETERS:  ip address (i.e. 192.168.0.1)
111 #      RETURNS:  array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
112 #  DESCRIPTION:  Uses proc fs (/proc/net/dev) to get list of interfaces.
113 #===============================================================================
114 sub get_interface_for_ip {
115         my $result;
116         my $ip= shift;
117         if ($ip && length($ip) > 0) {
118                 my @ifs= &get_interfaces();
119                 if($ip eq "0.0.0.0") {
120                         $result = "all";
121                 } else {
122                         foreach (@ifs) {
123                                 my $if=$_;
124                                 if(get_ip($if) eq $ip) {
125                                         $result = $if;
126                                 }
127                         }       
128                 }
129         }       
130         return $result;
133 #===  FUNCTION  ================================================================
134 #         NAME:  get_interfaces 
135 #   PARAMETERS:  none
136 #      RETURNS:  (list of interfaces) 
137 #  DESCRIPTION:  Uses proc fs (/proc/net/dev) to get list of interfaces.
138 #===============================================================================
139 sub get_interfaces {
140         my @result;
141         my $PROC_NET_DEV= ('/proc/net/dev');
143         open(PROC_NET_DEV, "<$PROC_NET_DEV")
144                 or die "Could not open $PROC_NET_DEV";
146         my @ifs = <PROC_NET_DEV>;
148         close(PROC_NET_DEV);
150         # Eat first two line
151         shift @ifs;
152         shift @ifs;
154         chomp @ifs;
155         foreach my $line(@ifs) {
156                 my $if= (split /:/, $line)[0];
157                 $if =~ s/^\s+//;
158                 push @result, $if;
159         }
161         return @result;
164 #===  FUNCTION  ================================================================
165 #         NAME:  get_mac 
166 #   PARAMETERS:  interface name (i.e. eth0)
167 #      RETURNS:  (mac address) 
168 #  DESCRIPTION:  Uses ioctl to get mac address directly from system.
169 #===============================================================================
170 sub get_mac {
171         my $ifreq= shift;
172         my $result;
173         if ($ifreq && length($ifreq) > 0) { 
174                 if($ifreq eq "all") {
175                         $result = "00:00:00:00:00:00";
176                 } else {
177                         my $SIOCGIFHWADDR= 0x8927;     # man 2 ioctl_list
179                         # A configured MAC Address should always override a guessed value
180                         if ($gosa_mac_address and length($gosa_mac_address) > 0) {
181                                 $result= $gosa_mac_address;
182                         }
184                         socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
185                                 or die "socket: $!";
187                         if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
188                                 my ($if, $mac)= unpack 'h36 H12', $ifreq;
190                                 if (length($mac) > 0) {
191                                         $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])$/;
192                                         $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
193                                         $result = $mac;
194                                 }
195                         }
196                 }
197         }
198         return $result;
201 #===  FUNCTION  ================================================================
202 #         NAME:  get_ip 
203 #   PARAMETERS:  interface name (i.e. eth0)
204 #      RETURNS:  (ip address) 
205 #  DESCRIPTION:  Uses ioctl to get ip address directly from system.
206 #===============================================================================
207 sub get_ip {
208         my $ifreq= shift;
209         my $result= "";
210         my $SIOCGIFADDR= 0x8915;       # man 2 ioctl_list
211         my $proto= getprotobyname('ip');
213         socket SOCKET, PF_INET, SOCK_DGRAM, $proto
214                 or die "socket: $!";
216         if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
217                 my ($if, $sin)    = unpack 'a16 a16', $ifreq;
218                 my ($port, $addr) = sockaddr_in $sin;
219                 my $ip            = inet_ntoa $addr;
221                 if ($ip && length($ip) > 0) {
222                         $result = $ip;
223                 }
224         }
226         return $result;
230 #sub import_events {
231 #    if (not -e $event_dir) {
232 #        &main::daemon_log("G ERROR: cannot find directory or directory is not readable: $event_dir", 1);   
233 #    }
234 #    opendir (DIR, $event_dir) or die "ERROR while loading gosa-si-events from directory $event_dir : $!\n";
236 #    while (defined (my $event = readdir (DIR))) {
237 #        if( $event eq "." || $event eq ".." ) { next; }   
238 #        if( $event eq "siTriggered.pm" ) { next; }                  # SI specific events not needed in GosaPackages.pm
239 #        if( $event eq "clMessages.pm" ) { next; }                   # SI specific events not needed in GosaPackages.pm
241 #        eval{ require $event; };
242 #        if( $@ ) {
243 #            &main::daemon_log("G ERROR: import of event module '$event' failed", 1);
244 #            &main::daemon_log("$@", 1);
245 #            next;
246 #        }
248 #        $event =~ /(\S*?).pm$/;
249 #        my $event_module = $1;
250 #        my $events_l = eval( $1."::get_events()") ;
251 #        foreach my $event_name (@{$events_l}) {
252 #            $event_hash->{$event_name} = $event_module;
253 #        }
254 #        my $events_string = join( ", ", @{$events_l});
255 #        &main::daemon_log("G DEBUG: GosaPackages from '$1' imported events $events_string", 8);
256 #    }
257 #}
260 #===  FUNCTION  ================================================================
261 #         NAME:  process_incoming_msg
262 #   PARAMETERS:  crypted_msg - string - incoming crypted message
263 #      RETURNS:  nothing
264 #  DESCRIPTION:  handels the proceeded distribution to the appropriated functions
265 #===============================================================================
266 sub process_incoming_msg {
267     my ($msg, $msg_hash, $session_id) = @_ ;
268     my $header = @{$msg_hash->{header}}[0];
269     my @msg_l;
270     my @out_msg_l;
272     &main::daemon_log("$session_id DEBUG: GosaPackages: msg to process '$header'", 7);
273     
274     if ($header =~ /^job_/) {
275         @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
276     } 
277     elsif ($header =~ /^gosa_/) {
278         @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
279     } 
280     else {
281         &main::daemon_log("$session_id ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix", 1);
282     }
284     foreach my $out_msg ( @msg_l ) {
285         # substitute in all outgoing msg <source>GOSA</source> of <source>$server_address</source>
286         $out_msg =~ s/<source>GOSA<\/source>/<source>$server_address<\/source>/g;
287         $out_msg =~ s/<\/xml>/<session_id>$session_id<\/session_id><\/xml>/;
288         if (defined $out_msg){
289             push(@out_msg_l, $out_msg);
290         }
292     }
294     return \@out_msg_l;
298 sub process_gosa_msg {
299     my ($msg, $msg_hash, $session_id) = @_ ;
300     my $out_msg;
301     my @out_msg_l = ('nohandler');
302     my $sql_events;
304     my $header = @{$msg_hash->{'header'}}[0];
305     my $target = @{$msg_hash->{'target'}}[0];
306     $header =~ s/gosa_//;
308     # check local installed events
309     if( exists $event_hash->{$header} ) {
310         # a event exists with the header as name
311         &main::daemon_log("$session_id INFO: found event '$header' at event-module '".$event_hash->{$header}."'", 5);
312         no strict 'refs';
313         @out_msg_l = &{$event_hash->{$header}."::$header"}( $msg, $msg_hash, $session_id );
315     # check client registered events
316     } else {
317         $sql_events = "SELECT * FROM $main::known_clients_tn WHERE ( (macaddress LIKE '$target') OR (hostname='$target') )"; 
318         my $res = $main::known_clients_db->select_dbentry( $sql_events );
319         my $l = keys(%$res);
320         
321         # set error if no or more than 1 hits are found for sql query
322         if ( $l != 1) {
323             @out_msg_l = ('knownclienterror');
324         
325         # found exact 1 hit in db
326         } else {
327             my $client_events = $res->{'1'}->{'events'};
329             # client is registered for this event, deliver this message to client
330             if ($client_events =~ /,$header,/) {
331                 $msg =~ s/<header>gosa_/<header>/;
332                 @out_msg_l = ( $msg );
334             # client is not registered for this event, set error
335             } else {
336                 @out_msg_l = ('noeventerror');
337             }
338         }
339     }
341     # if delivery not possible raise error and return 
342     if (not defined $out_msg_l[0]) {
343         @out_msg_l = ();
344     } elsif ($out_msg_l[0] eq 'nohandler') {
345         &main::daemon_log("$session_id ERROR: GosaPackages: no event handler or core function defined for '$header'", 1);
346         @out_msg_l = ();
347     } elsif ($out_msg_l[0] eq 'knownclienterror') {
348         &main::daemon_log("$session_id ERROR: no or more than 1 hits are found at known_clients_db with sql query: '$sql_events'", 1);
349         &main::daemon_log("$session_id WARNING: processing is aborted and message will not be forwarded");
350         @out_msg_l = ();
351     } elsif ($out_msg_l[0] eq 'noeventerror') {
352         &main::daemon_log("$session_id WARNING: client '$target' is not registered for event '$header', processing is aborted", 1); 
353         @out_msg_l = ();
354     }
356     return @out_msg_l;
360 sub process_job_msg {
361     my ($msg, $msg_hash, $session_id)= @_ ;    
362     my $out_msg;
363     my $error = 0;
365     my $header = @{$msg_hash->{'header'}}[0];
366     $header =~ s/job_//;
367         my $target = @{$msg_hash->{'target'}}[0];
368     
369     # if no timestamp is specified, use 19700101000000
370     my $timestamp = "19700101000000";
371     if( exists $msg_hash->{'timestamp'} ) {
372         $timestamp = @{$msg_hash->{'timestamp'}}[0];
373     }
375     #if no macaddress is specified, raise error 
376     my $macaddress;
377     if( exists $msg_hash->{'macaddress'} ) {
378         $macaddress = @{$msg_hash->{'macaddress'}}[0];
379     } elsif (@{$msg_hash->{'target'}}[0] =~ /^([0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2})$/i ) {
380         $macaddress = $1;
381     } else {
382         $error ++;
383         $out_msg = "<xml>".
384             "<header>answer</header>".
385             "<source>$server_address</source>".
386             "<target>GOSA</target>".
387             "<answer1>1</answer1>".
388             "<error_string>no mac address specified, neither in target-tag nor in macaddres-tag</error_string>".
389             "</xml>";
390     }
391     
392         # if mac address is already known in ldap, set plain_name to 'cn'
393     my $plain_name;
394         my $ldap_handle = &main::get_ldap_handle($session_id); 
395         if( not defined $ldap_handle ) {
396                 &main::daemon_log("$session_id ERROR: cannot connect to ldap", 1);
397                 $plain_name = "none"; 
398                 
399         # try to fetch a 'real name'            
400         } else {
401                 my $mesg = $ldap_handle->search(
402                                                 base => $main::ldap_base,
403                                                 scope => 'sub',
404                                                 attrs => ['cn'],
405                                                 filter => "(macAddress=$macaddress)");
406                 if($mesg->code) {
407                         &main::daemon_log($mesg->error, 1);
408                         $plain_name = "none";
409                 } else {
410                         my $entry= $mesg->entry(0);
411                         $plain_name = $entry->get_value("cn");
412                 }
413         }
415     if( $error == 0 ) {
416         # add job to job queue
417         my $func_dic = {table=>$main::job_queue_tn, 
418             primkey=>[],
419             timestamp=>$timestamp,
420             status=>'waiting', 
421             result=>'none',
422             progress=>'none',
423             headertag=>$header, 
424             targettag=>$target,
425             xmlmessage=>$msg,
426             macaddress=>$macaddress,
427                         plainname=>$plain_name,
428         };
429         my $res = $main::job_db->add_dbentry($func_dic);
430         if (not $res == 0) {
431             &main::daemon_log("$session_id ERROR: GosaPackages: process_job_msg: $res", 1);
432         } else {
433             &main::daemon_log("$session_id INFO: GosaPackages: $header job successfully added to job queue", 5);
434         }
435         $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
436     }
437     
438     my @out_msg_l = ( $out_msg );
439     return @out_msg_l;
442 1;