Code

Added branches container for old stuff
[gosa.git] / gosa-si / modules / GosaSupportDaemon.pm
index c9b6f865ed6d0f774d24f9fdf180c8adf5d32449..f732b34859c0ba7ccdf9c317b1182c8e667a836d 100644 (file)
@@ -3,12 +3,14 @@ package GOSA::GosaSupportDaemon;
 use Exporter;
 @ISA = qw(Exporter);
 my @functions = (
+    "create_passwd",
     "create_xml_hash",
     "get_content_from_xml_hash",
     "add_content2xml_hash",
     "create_xml_string",
     "transform_msg2hash",
     "get_time",
+    "get_utc_time",
     "build_msg",
     "db_res2xml",
     "db_res2si_msg",
@@ -21,6 +23,19 @@ my @functions = (
     "get_server_addresses",
     "get_logged_in_users",
     "import_events",
+    "del_doubles",
+    "get_ip",
+    "get_interface_for_ip",
+    "get_interfaces",
+    "get_mac_for_interface",
+    "get_local_ip_for_remote_ip",
+    "is_local",
+    "run_as",
+    "inform_all_other_si_server",
+    "read_configfile",
+    "check_opsi_res",
+    "calc_timestamp",
+    "opsi_callobj2string",
     ); 
 @EXPORT = @functions;
 use strict;
@@ -32,6 +47,7 @@ use MIME::Base64;
 use XML::Simple;
 use Data::Dumper;
 use Net::DNS;
+use DateTime;
 
 
 my $op_hash = {
@@ -60,6 +76,21 @@ sub daemon_log {
 }
 
 
+sub create_passwd {
+    my $new_passwd = "";
+    for(my $i=0; $i<31; $i++) {
+        $new_passwd .= ("a".."z","A".."Z",0..9)[int(rand(62))]
+    }
+
+    return $new_passwd;
+}
+
+
+sub del_doubles { 
+    my %all; 
+    $all{$_}=0 for @_; 
+    return (keys %all); 
+}
 
 
 #===  FUNCTION  ================================================================
@@ -152,7 +183,7 @@ sub add_content2xml_hash {
 
 sub get_time {
     my ($seconds, $minutes, $hours, $monthday, $month,
-            $year, $weekday, $yearday, $sommertime) = localtime(time);
+            $year, $weekday, $yearday, $sommertime) = localtime;
     $hours = $hours < 10 ? $hours = "0".$hours : $hours;
     $minutes = $minutes < 10 ? $minutes = "0".$minutes : $minutes;
     $seconds = $seconds < 10 ? $seconds = "0".$seconds : $seconds;
@@ -164,6 +195,12 @@ sub get_time {
 
 }
 
+sub get_utc_time {
+    my $utc_time = qx(date --utc +%Y%m%d%H%M%S);
+    $utc_time =~ s/\s$//;
+    return $utc_time;
+}
+
 
 #===  FUNCTION  ================================================================
 #         NAME: build_msg
@@ -209,7 +246,7 @@ sub db_res2xml {
             if( $column_name eq "xmlmessage" ) {
                 $xml_content = &encode_base64($column_value);
             } else {
-                $xml_content = $column_value;
+                $xml_content = defined $column_value ? $column_value : "";
             }
             $xml .= $xml_content;
             $xml .= "</$column_name>"; 
@@ -271,6 +308,8 @@ sub get_where_statement {
                 my @xml_tags = keys %{$phrase};
                 my $tag = $xml_tags[0];
                 my $val = $phrase->{$tag}[0];
+                if( ref($val) eq "HASH" ) { next; }  # empty xml-tags should not appear in where statement
+
                                # integer columns do not have to have single quotes besides the value
                                if ($tag eq "id") {
                                                push(@phrase_l, "$tag$operator$val");
@@ -278,8 +317,11 @@ sub get_where_statement {
                                                push(@phrase_l, "$tag$operator'$val'");
                                }
             }
-            my $clause_str .= join(" $connector ", @phrase_l);
-            push(@clause_l, "($clause_str)");
+
+            if (not 0 == @phrase_l) {
+                my $clause_str .= join(" $connector ", @phrase_l);
+                push(@clause_l, "($clause_str)");
+            }
         }
 
         if( not 0 == @clause_l ) {
@@ -402,12 +444,10 @@ sub get_dns_domains() {
 }
 
 
-#############################################
-# moved from gosa-si-client: rettenbe, 16.05.2008
-# outcommented at gosa-si-client
 sub get_server_addresses {
     my $domain= shift;
     my @result;
+    my $error_string;
 
     my $error = 0;
     my $res   = Net::DNS::Resolver->new;
@@ -420,7 +460,7 @@ sub get_server_addresses {
         }
     }
     else {
-        #warn "query failed: ", $res->errorstring, "\n";
+        $error_string = "determination of '_gosa-si._tcp' server in domain '$domain' failed: ".$res->errorstring;
         $error++;
     }
 
@@ -439,7 +479,7 @@ sub get_server_addresses {
         }
     }
 
-    return @result;
+    return \@result, $error_string;
 }
 
 
@@ -465,10 +505,10 @@ sub get_logged_in_users {
 
 
 sub import_events {
-    my ($event_dir)= @_;
+    my ($event_dir) = @_;
+    my $event_hash;
     my $error = 0;
     my @result = ();
-
     if (not -e $event_dir) {
         $error++;
         push(@result, "cannot find directory or directory is not readable: $event_dir");   
@@ -476,23 +516,25 @@ sub import_events {
 
     my $DIR;
     if ($error == 0) {
-        opendir (DIR, $event_dir) or sub { 
+        opendir ($DIR, $event_dir) or do { 
             $error++;
             push(@result, "cannot open directory '$event_dir' for reading: $!\n");
         }
     }
 
     if ($error == 0) {
-        while (defined (my $event = readdir (DIR))) {
+        while (defined (my $event = readdir ($DIR))) {
             if( $event eq "." || $event eq ".." ) { next; }  
-            if ($event ne "server_server_com.pm") { next; }
 
             # try to import event module
             eval{ require $event; };
             if( $@ ) {
                 $error++;
-                push(@result, "import of event module '$event' failed: $@");
-                next;
+                #push(@result, "import of event module '$event' failed: $@");
+                #next;
+                
+                &main::daemon_log("ERROR: Import of event module '$event' failed: $@",1);
+                exit(1);
             }
 
             # fetch all single events
@@ -500,16 +542,338 @@ sub import_events {
             my $event_module = $1;
             my $events_l = eval( $1."::get_events()") ;
             foreach my $event_name (@{$events_l}) {
-                $event_hash->{$event_name} = $event_module;
+                $event_hash->{$event_module}->{$event_name} = "";
             }
             my $events_string = join( ", ", @{$events_l});
             push(@result, "import of event module '$event' succeed: $events_string");
         }
+        
+        close $DIR;
+    }
+
+    return ($error, \@result, $event_hash);
+
+}
+
+
+#===  FUNCTION  ================================================================
+#         NAME:  get_ip 
+#   PARAMETERS:  interface name (i.e. eth0)
+#      RETURNS:  (ip address) 
+#  DESCRIPTION:  Uses ioctl to get ip address directly from system.
+#===============================================================================
+sub get_ip {
+       my $ifreq= shift;
+       my $result= "";
+       my $SIOCGIFADDR= 0x8915;       # man 2 ioctl_list
+       my $proto= getprotobyname('ip');
+
+       socket SOCKET, PF_INET, SOCK_DGRAM, $proto
+               or die "socket: $!";
+
+       if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
+               my ($if, $sin)    = unpack 'a16 a16', $ifreq;
+               my ($port, $addr) = sockaddr_in $sin;
+               my $ip            = inet_ntoa $addr;
+
+               if ($ip && length($ip) > 0) {
+                       $result = $ip;
+               }
+       }
+
+       return $result;
+}
+
+
+#===  FUNCTION  ================================================================
+#         NAME:  get_interface_for_ip
+#   PARAMETERS:  ip address (i.e. 192.168.0.1)
+#      RETURNS:  array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
+#  DESCRIPTION:  Uses proc fs (/proc/net/dev) to get list of interfaces.
+#===============================================================================
+sub get_interface_for_ip {
+       my $result;
+       my $ip= shift;
+       if ($ip && length($ip) > 0) {
+               my @ifs= &get_interfaces();
+               if($ip eq "0.0.0.0") {
+                       $result = "all";
+               } else {
+                       foreach (@ifs) {
+                               my $if=$_;
+                               if(&get_ip($if) eq $ip) {
+                                       $result = $if;
+                               }
+                       }       
+               }
+       }       
+       return $result;
+}
+
+#===  FUNCTION  ================================================================
+#         NAME:  get_interfaces 
+#   PARAMETERS:  none
+#      RETURNS:  (list of interfaces) 
+#  DESCRIPTION:  Uses proc fs (/proc/net/dev) to get list of interfaces.
+#===============================================================================
+sub get_interfaces {
+       my @result;
+       my $PROC_NET_DEV= ('/proc/net/dev');
+
+       open(PROC_NET_DEV, "<$PROC_NET_DEV")
+               or die "Could not open $PROC_NET_DEV";
+
+       my @ifs = <PROC_NET_DEV>;
+
+       close(PROC_NET_DEV);
+
+       # Eat first two line
+       shift @ifs;
+       shift @ifs;
+
+       chomp @ifs;
+       foreach my $line(@ifs) {
+               my $if= (split /:/, $line)[0];
+               $if =~ s/^\s+//;
+               push @result, $if;
+       }
+
+       return @result;
+}
+
+sub get_local_ip_for_remote_ip {
+       my $remote_ip= shift;
+       my $result="0.0.0.0";
+
+    if($remote_ip =~ /^(\d\d?\d?\.){3}\d\d?\d?$/) {
+        my $PROC_NET_ROUTE= ('/proc/net/route');
+
+        open(PROC_NET_ROUTE, "<$PROC_NET_ROUTE")
+            or die "Could not open $PROC_NET_ROUTE";
+
+        my @ifs = <PROC_NET_ROUTE>;
+
+        close(PROC_NET_ROUTE);
+
+        # Eat header line
+        shift @ifs;
+        chomp @ifs;
+        foreach my $line(@ifs) {
+            my ($Iface,$Destination,$Gateway,$Flags,$RefCnt,$Use,$Metric,$Mask,$MTU,$Window,$IRTT)=split(/\s/, $line);
+            my $destination;
+            my $mask;
+            my ($d,$c,$b,$a)=unpack('a2 a2 a2 a2', $Destination);
+            $destination= sprintf("%d.%d.%d.%d", hex($a), hex($b), hex($c), hex($d));
+            ($d,$c,$b,$a)=unpack('a2 a2 a2 a2', $Mask);
+            $mask= sprintf("%d.%d.%d.%d", hex($a), hex($b), hex($c), hex($d));
+            if(new NetAddr::IP($remote_ip)->within(new NetAddr::IP($destination, $mask))) {
+                # destination matches route, save mac and exit
+                $result= &get_ip($Iface);
+                last;
+            }
+        }
+    } else {
+               daemon_log("0 WARNING: get_local_ip_for_remote_ip() was called with a non-ip parameter: '$remote_ip'", 1);
+       }
+       return $result;
+}
+
+
+sub get_mac_for_interface {
+       my $ifreq= shift;
+       my $result;
+       if ($ifreq && length($ifreq) > 0) { 
+               if($ifreq eq "all") {
+                       $result = "00:00:00:00:00:00";
+               } else {
+                       my $SIOCGIFHWADDR= 0x8927;     # man 2 ioctl_list
+
+                       # A configured MAC Address should always override a guessed value
+                       if ($main::server_mac_address and length($main::server_mac_address) > 0) {
+                               $result= $main::server_mac_address;
+                       }
+
+                       socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
+                               or die "socket: $!";
+
+                       if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
+                               my ($if, $mac)= unpack 'h36 H12', $ifreq;
+
+                               if (length($mac) > 0) {
+                                       $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])$/;
+                                       $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
+                                       $result = $mac;
+                               }
+                       }
+               }
+       }
+       return $result;
+}
+
+
+#===  FUNCTION  ================================================================
+#         NAME:  is_local
+#   PARAMETERS:  Server Address
+#      RETURNS:  true if Server Address is on this host, false otherwise
+#  DESCRIPTION:  Checks all interface addresses, stops on first match
+#===============================================================================
+sub is_local {
+    my $server_address = shift || "";
+    my $result = 0;
+
+    my $server_ip = $1 if $server_address =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}):\d{1,6}$/;
+
+    if(defined($server_ip) && length($server_ip) > 0) {
+        foreach my $interface(&get_interfaces()) {
+            my $ip_address= &get_ip($interface);
+            if($ip_address eq $server_ip) {
+                $result = 1;
+                last;
+            }
+        }
+    }
+
+    return $result;
+}
+
+
+#===  FUNCTION  ================================================================
+#         NAME:  run_as
+#   PARAMETERS:  uid, command
+#      RETURNS:  hash with keys 'resultCode' = resultCode of command and 
+#                'output' = program output
+#  DESCRIPTION:  Runs command as uid using the sudo utility.
+#===============================================================================
+sub run_as {
+       my ($uid, $command) = @_;
+       my $sudo_cmd = `which sudo`;
+       chomp($sudo_cmd);
+       if(! -x $sudo_cmd) {
+               &main::daemon_log("ERROR: The sudo utility is not available! Please fix this!");
+       }
+       my $cmd_line= "$sudo_cmd su - $uid -c '$command'";
+       open(PIPE, "$cmd_line |");
+       my $result = {'resultCode' => $?};
+       $result->{'command'} = $cmd_line;
+       push @{$result->{'output'}}, <PIPE>;
+       return $result;
+}
+
+
+#===  FUNCTION  ================================================================
+#         NAME:  inform_other_si_server
+#   PARAMETERS:  message
+#      RETURNS:  nothing
+#  DESCRIPTION:  Sends message to all other SI-server found in known_server_db. 
+#===============================================================================
+sub inform_all_other_si_server {
+    my ($msg) = @_;
+
+    # determine all other si-server from known_server_db
+    my $sql_statement= "SELECT * FROM $main::known_server_tn";
+    my $res = $main::known_server_db->select_dbentry( $sql_statement ); 
+
+    while( my ($hit_num, $hit) = each %$res ) {    
+        my $act_target_address = $hit->{hostname};
+        my $act_target_key = $hit->{hostkey};
+
+        # determine the source address corresponding to the actual target address
+        my ($act_target_ip, $act_target_port) = split(/:/, $act_target_address);
+        my $act_source_address = &main::get_local_ip_for_remote_ip($act_target_ip).":$act_target_port";
+
+        # fill into message the correct target and source addresses
+        my $act_msg = $msg;
+        $act_msg =~ s/<target>\w*<\/target>/<target>$act_target_address<\/target>/g;
+        $act_msg =~ s/<source>\w*<\/source>/<source>$act_source_address<\/source>/g;
+
+        # send message to the target
+        &main::send_msg_to_target($act_msg, $act_target_address, $act_target_key, "foreign_job_updates" , "J");
+    }
+
+    return;
+}
+
+
+sub read_configfile {
+    my ($cfg_file, %cfg_defaults) = @_ ;
+    my $cfg;
+    if( defined( $cfg_file) && ( (-s $cfg_file) > 0 )) {
+        if( -r $cfg_file ) {
+            $cfg = Config::IniFiles->new( -file => $cfg_file );
+        } else {
+            print STDERR "Couldn't read config file!";
+        }
+    } else {
+        $cfg = Config::IniFiles->new() ;
     }
+    foreach my $section (keys %cfg_defaults) {
+        foreach my $param (keys %{$cfg_defaults{ $section }}) {
+            my $pinfo = $cfg_defaults{ $section }{ $param };
+           ${@$pinfo[ 0 ]} = $cfg->val( $section, $param, @$pinfo[ 1 ] );
+        }
+    }
+}
+
 
-    return ($error, \@result);
+sub check_opsi_res {
+    my $res= shift;
 
+    if($res) {
+        if ($res->is_error) {
+            my $error_string;
+            if (ref $res->error_message eq "HASH") { 
+                $error_string = $res->error_message->{'message'}; 
+            } else { 
+                $error_string = $res->error_message; 
+            }
+            return 1, $error_string;
+        }
+    } else {
+        return 1, $main::opsi_client->status_line;
+    }
+    return 0;
 }
 
+sub calc_timestamp {
+    my ($timestamp, $operation, $value) = @_ ;
+    my $res_timestamp = 0;
+    
+    $value = int($value);
+    $timestamp = int($timestamp);
+    $timestamp =~ /(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)/;
+    my $dt = DateTime->new( year   => $1,
+            month  => $2,
+            day    => $3,
+            hour   => $4,
+            minute => $5,
+            second => $6,
+            );
+
+    if ($operation eq "plus" || $operation eq "+") {
+        $dt->add( seconds => $value);
+        $res_timestamp = $dt->ymd('').$dt->hms('');
+    }
+
+    if ($operation eq "minus" || $operation eq "-") {
+        $dt->subtract(seconds => $value);
+        $res_timestamp = $dt->ymd('').$dt->hms('');
+    }
+
+    return $res_timestamp;
+}
 
+sub opsi_callobj2string { 
+    my ($callobj) = @_; 
+    my @callobj_string; 
+    while(my ($key, $value) = each(%$callobj)) { 
+        my $value_string = ""; 
+        if (ref($value) eq "ARRAY") { 
+            $value_string = join(",", @$value); 
+        } else { 
+            $value_string = $value; 
+        } 
+        push(@callobj_string, "$key=$value_string") 
+    } 
+    return join(", ", @callobj_string); 
+} 
 1;