![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index ab5938dc6f7026865bf7e9199f6cebbb575d6209..b3b6e2d847059315af60db588fa386f4485aa3af 100644 (file)
use Exporter;
@ISA = ("Exporter");
-# Each module has to have a function 'process_incoming_msg'. This function works as a interface to gosa-sd and recieves the msg hash from gosa-sd. 'process_incoming_function checks, wether it has a function to process the incoming msg and forward the msg to it.
-
-
use strict;
use warnings;
-use GosaSupportDaemon;
+use GOSA::GosaSupportDaemon;
+use IO::Socket::INET;
+use Socket;
+use XML::Simple;
+use File::Spec;
+use Data::Dumper;
+use GOSA::DBsqlite;
+use MIME::Base64;
-BEGIN{}
+my $event_dir = "/usr/lib/gosa-si/server/events";
+use lib "/usr/lib/gosa-si/server/events";
+BEGIN{}
END{}
+my ($server_ip, $server_mac_address, $server_port, $server_passwd, $max_clients);
+my ($gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
+my ($job_queue_timeout, $job_queue_file_name);
+
+my $gosa_server;
+my $event_hash;
-### START ##########################
+my %cfg_defaults = (
+"server" => {
+ "ip" => [\$server_ip, "0.0.0.0"],
+ "port" => [\$server_port, "20081"],
+ "key" => [\$server_passwd, ""],
+ "max-clients" => [\$max_clients, 100],
+ },
+"GOsaPackages" => {
+ "ip" => [\$gosa_ip, "0.0.0.0"],
+ "port" => [\$gosa_port, "20082"],
+ "key" => [\$gosa_passwd, "none"],
+ "job-queue" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
+ },
+);
+
+
+## START ##########################
+
+# read configfile and import variables
+&read_configfile();
+$network_interface= &get_interface_for_ip($server_ip);
+$gosa_mac_address= &get_mac($network_interface);
+
+# complete addresses
+if( inet_aton($server_ip) ){ $server_ip = inet_ntoa(inet_aton($server_ip)); }
+our $server_address = "$server_ip:$server_port";
+if( inet_aton($gosa_ip) ){ $gosa_ip = inet_ntoa(inet_aton($gosa_ip)); }
+my $gosa_address = "$gosa_ip:$gosa_port";
# create general settings for this module
-my $gosa_cipher = &create_ciphering($main::gosa_passwd);
+#y $gosa_cipher = &create_ciphering($gosa_passwd);
+my $xml = new XML::Simple();
-sub get_module_tags {
-
- # dort stehen drei packettypen, für die sich das modul anmelden kann, gosa-admin-packages,
- # server-packages, client-packages
- my %tag_hash = (gosa_admin_packages => "yes",
- server_packages => "no",
- client_packages => "no");
- return \%tag_hash;
+
+# import events
+&import_events();
+
+## FUNCTIONS #################################################################
+
+sub get_module_info {
+ my @info = ($gosa_address,
+ $gosa_passwd,
+ );
+ return \@info;
}
-sub process_incoming_msg {
- my ($crypted_msg) = @_ ;
- if(not defined $crypted_msg) {
- &main::daemon_log("function 'process_incoming_msg': got no msg", 7);
+#=== FUNCTION ================================================================
+# NAME: read_configfile
+# PARAMETERS: cfg_file - string -
+# RETURNS: nothing
+# DESCRIPTION: read cfg_file and set variables
+#===============================================================================
+sub read_configfile {
+ my $cfg;
+ if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
+ if( -r $main::cfg_file ) {
+ $cfg = Config::IniFiles->new( -file => $main::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] );
+ }
}
- &main::daemon_log("GosaPackages: crypted_msg:$crypted_msg", 7);
- &main::daemon_log("GosaPackages: crypted_msg len:".length($crypted_msg), 7);
+}
- $crypted_msg =~ /^([\s\S]*?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)$/;
- $crypted_msg = $1;
- my $host = sprintf("%s.%s.%s.%s", $2, $3, $4, $5);
-
- &main::daemon_log("GosaPackages: crypted_msg:$crypted_msg", 7);
- &main::daemon_log("GosaPackages: crypted_msg len:".length($crypted_msg), 7);
-
-
- # collect addresses from possible incoming clients
- # only gosa is allowd as incoming client
- &main::daemon_log("GosaPackages: host_key: $host", 7);
- &main::daemon_log("GosaPackages: key_passwd: $main::gosa_passwd", 7);
-
- $gosa_cipher = &main::create_ciphering($main::gosa_passwd);
- # determine the correct passwd for deciphering of the incoming msgs
- my $msg = "";
- my $msg_hash;
- eval{
- $msg = &main::decrypt_msg($crypted_msg, $gosa_cipher);
- &main::daemon_log("GosaPackages: decrypted_msg: $msg", 7);
-
- $msg_hash = $main::xml->XMLin($msg, ForceArray=>1);
- };
- if($@) {
- &main::daemon_log("WARNING: GosaPackages do not understand the message:", 5);
- &main::daemon_log("$@", 7);
- return;
+#=== 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;
+}
+
+#=== FUNCTION ================================================================
+# NAME: get_mac
+# PARAMETERS: interface name (i.e. eth0)
+# RETURNS: (mac address)
+# DESCRIPTION: Uses ioctl to get mac address directly from system.
+#===============================================================================
+sub get_mac {
+ 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 ($gosa_mac_address and length($gosa_mac_address) > 0) {
+ $result= $gosa_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: 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;
+}
+
+
+sub import_events {
+ if (not -e $event_dir) {
+ &main::daemon_log("ERROR: cannot find directory or directory is not readable: $event_dir", 1);
}
+ opendir (DIR, $event_dir) or die "ERROR while loading gosa-si-events from directory $event_dir : $!\n";
- &main::daemon_log("GosaPackages: msg for daemon from host:", 1);
- &main::daemon_log("\t$host", 1);
- &main::daemon_log("GosaPackages: msg to process:", 5);
- &main::daemon_log("\t$msg", 5);
-
- $msg = "gosaPackages hat was bekommen";
-
- my $out_cipher = &main::create_ciphering($main::gosa_passwd);
- my $out_msg = &main::encrypt_msg($msg, $out_cipher);
- return $out_msg;
+ while (defined (my $event = readdir (DIR))) {
+ if( $event eq "." || $event eq ".." ) { next; }
+ if( $event eq "siTriggered.pm" ) { next; } # SI specific events not needed in GosaPackages.pm
+ if( $event eq "clMessages.pm" ) { next; } # SI specific events not needed in GosaPackages.pm
+
+ eval{ require $event; };
+ if( $@ ) {
+ &main::daemon_log("ERROR: import of event module '$event' failed", 1);
+ &main::daemon_log("$@", 1);
+ next;
+ }
+ $event =~ /(\S*?).pm$/;
+ my $event_module = $1;
+ my $events_l = eval( $1."::get_events()") ;
+ foreach my $event_name (@{$events_l}) {
+ $event_hash->{$event_name} = $event_module;
+ }
+ my $events_string = join( ", ", @{$events_l});
+ &main::daemon_log("INFO: GosaPackages imported events $events_string", 5);
+ }
}
#=== FUNCTION ================================================================
-# NAME: got_ping
-# PARAMETERS: msg_hash - hash - hash from function create_xml_hash
+# NAME: process_incoming_msg
+# PARAMETERS: crypted_msg - string - incoming crypted message
# RETURNS: nothing
-# DESCRIPTION: process this incoming message
+# DESCRIPTION: handels the proceeded distribution to the appropriated functions
#===============================================================================
-sub got_ping {
- my ($msg_hash) = @_;
-
- my $source = @{$msg_hash->{source}}[0];
- my $target = @{$msg_hash->{target}}[0];
+sub process_incoming_msg {
+ my ($msg, $msg_hash, $session_id) = @_ ;
my $header = @{$msg_hash->{header}}[0];
+ my @msg_l;
+ my @out_msg_l;
+
+ &main::daemon_log("GosaPackages: receive '$header'", 1);
+
+ if ($header =~ /^job_/) {
+ @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
+ }
+ elsif ($header =~ /^gosa_/) {
+ @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
+ }
+ else {
+ &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
+ }
+
+ foreach my $out_msg ( @msg_l ) {
+
+ # keep job queue up-to-date and save result and status
+ if (defined ($out_msg) && $out_msg =~ /<jobdb_id>(\d+)<\/jobdb_id>/) {
+ my $job_id = $1;
+ my $sql = "UPDATE '".$main::job_queue_table_name."'".
+ " SET status='processing'".
+ " WHERE id='$job_id'";
+ my $res = $main::job_db->exec_statement($sql);
+ }
+
+ # substitute in all outgoing msg <source>GOSA</source> of <source>$server_address</source>
+ $out_msg =~ s/<source>GOSA<\/source>/<source>$server_address<\/source>/g;
+
+ if (defined $out_msg){
+ push(@out_msg_l, $out_msg);
+ }
+
+ }
+
+ return \@out_msg_l;
+}
+
+
+sub process_gosa_msg {
+ my ($msg, $msg_hash, $session_id) = @_ ;
+ my $out_msg;
+ my @out_msg_l;
+
+ my $header = @{$msg_hash->{'header'}}[0];
+ $header =~ s/gosa_//;
+
+ # decide wether msg is a core function or a event handler
+ if ( $header eq 'query_jobdb') {
+ @out_msg_l = &query_jobdb
+ } elsif ($header eq 'delete_jobdb_entry') {
+ @out_msg_l = &delete_jobdb_entry
+ } elsif ($header eq 'clear_jobdb') {
+ @out_msg_l = &clear_jobdb
+ } elsif ($header eq 'update_status_jobdb_entry' ) {
+ @out_msg_l = &update_status_jobdb_entry
+ } elsif ($header eq 'count_jobdb' ) {
+ @out_msg_l = &count_jobdb
+ } else {
+ # msg could not be assigned to core function
+ # maybe it is an eventa
+ if( exists $event_hash->{$header} ) {
+ # a event exists with the header as name
+ &main::daemon_log("found event '$header' at event-module '".$event_hash->{$header}."'", 5);
+ no strict 'refs';
+ @out_msg_l = &{$event_hash->{$header}."::$header"}($msg, $msg_hash, $session_id);
+ }
+ }
+
+ # if delivery not possible raise error and return
+ if( not @out_msg_l ) {
+ &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
+ } elsif( 0 == @out_msg_l) {
+ &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
+ }
+
+ return @out_msg_l;
+}
+
+
+sub process_job_msg {
+ my ($msg, $msg_hash, $session_id)= @_ ;
+ my $out_msg;
+ my $error = 0;
+
+ my $header = @{$msg_hash->{'header'}}[0];
+ $header =~ s/job_//;
- if(exists $main::known_daemons->{$source}) {
- &main::add_content2known_daemons(hostname=>$source, status=>$header);
+ # if no timestamp is specified, use 19700101000000
+ my $timestamp = "19700101000000";
+ if( exists $msg_hash->{'timestamp'} ) {
+ $timestamp = @{$msg_hash->{'timestamp'}}[0];
+ }
+
+ #if no macaddress is specified, raise error
+ my $macaddress;
+ if( exists $msg_hash->{'macaddress'} ) {
+ $macaddress = @{$msg_hash->{'macaddress'}}[0];
} else {
- &main::add_content2known_clients(hostname=>$source, status=>$header);
+ $error ++;
+ $out_msg = "<xml>".
+ "<header>answer</header>".
+ "<source>$server_address</source>".
+ "<target>GOSA</target>".
+ "<answer1>1</answer1>".
+ "<error_string>no mac address specified</error_string>".
+ "</xml>";
}
- return;
+ # check wether mac address is already known in known_daemons or known_clients
+ my $target = 'none';
+
+ if( $error == 0 ) {
+ # add job to job queue
+ my $func_dic = {table=>$main::job_queue_table_name,
+ primkey=>'id',
+ timestamp=>$timestamp,
+ status=>'waiting',
+ result=>'none',
+ progress=>'none',
+ headertag=>$header,
+ targettag=>$target,
+ xmlmessage=>$msg,
+ macaddress=>$macaddress,
+ };
+
+ my $res = $main::job_db->add_dbentry($func_dic);
+ if (not $res == 0) {
+ &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
+ } else {
+ &main::daemon_log("INFO: GosaPackages: $header job successfully added to job queue", 5);
+ }
+ $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
+ }
+
+ my @out_msg_l = ( $out_msg );
+ return @out_msg_l;
+}
+
+
+sub db_res_2_xml {
+ my ($db_res) = @_ ;
+ my $xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target>";
+
+ my $len_db_res= keys %{$db_res};
+ for( my $i= 1; $i<= $len_db_res; $i++ ) {
+ $xml .= "\n<answer$i>";
+ my $hash= $db_res->{$i};
+ while ( my ($column_name, $column_value) = each %{$hash} ) {
+ $xml .= "<$column_name>";
+ my $xml_content;
+ if( $column_name eq "xmlmessage" ) {
+ $xml_content = &encode_base64($column_value);
+ } else {
+ $xml_content = $column_value;
+ }
+ $xml .= $xml_content;
+ $xml .= "</$column_name>";
+ }
+ $xml .= "</answer$i>";
+
+ }
+
+ $xml .= "</xml>";
+ return $xml;
+}
+
+
+## CORE FUNCTIONS ############################################################
+
+sub query_jobdb {
+ my ($msg) = @_;
+ my $msg_hash = &transform_msg2hash($msg);
+
+ # prepare query sql statement
+ my $select= &get_select_statement($msg, $msg_hash);
+ my $table= $main::job_queue_table_name;
+ my $where= &get_where_statement($msg, $msg_hash);
+ my $limit= &get_limit_statement($msg, $msg_hash);
+ my $orderby= &get_orderby_statement($msg, $msg_hash);
+ my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
+
+ # execute db query
+ my $res_hash = $main::job_db->select_dbentry($sql_statement);
+ my $out_xml = &db_res_2_xml($res_hash);
+ my @out_msg_l = ( $out_xml );
+ return @out_msg_l;
+}
+
+
+sub count_jobdb {
+ my ($msg)= @_;
+ my $out_xml= "<xml><count>error</count></xml>";
+
+ # prepare query sql statement
+ my $table= $main::job_queue_table_name;
+ my $sql_statement= "SELECT * FROM $table ";
+
+ # execute db query
+ my $res_hash = $main::job_db->select_dbentry($sql_statement);
+
+ my $count = keys(%{$res_hash});
+ $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><count>$count</count></xml>";
+ my @out_msg_l = ( $out_xml );
+ return @out_msg_l;
+}
+
+
+sub delete_jobdb_entry {
+ my ($msg) = @_ ;
+ my $msg_hash = &transform_msg2hash($msg);
+
+ # prepare query sql statement
+ my $table= $main::job_queue_table_name;
+ my $where= &get_where_statement($msg, $msg_hash);
+ my $sql_statement = "DELETE FROM $table $where";
+
+ # execute db query
+ my $db_res = $main::job_db->del_dbentry($sql_statement);
+
+ my $res;
+ if( $db_res > 0 ) {
+ $res = 0 ;
+ } else {
+ $res = 1;
+ }
+
+ # prepare xml answer
+ my $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
+ my @out_msg_l = ( $out_xml );
+ return @out_msg_l;
+
+}
+
+
+sub clear_jobdb {
+ my ($msg) = @_ ;
+ my $msg_hash = &transform_msg2hash($msg);
+ my $error= 0;
+ my $out_xml= "<xml><answer1>1</answer1></xml>";
+
+ my $table= $main::job_queue_table_name;
+
+ my $sql_statement = "DELETE FROM $table";
+ my $db_res = $main::job_db->del_dbentry($sql_statement);
+ if( not $db_res > 0 ) { $error++; };
+
+ if( $error == 0 ) {
+ $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
+ }
+ my @out_msg_l = ( $out_xml );
+ return @out_msg_l;
+}
+
+
+sub update_status_jobdb_entry {
+ my ($msg) = @_ ;
+ my $msg_hash = &transform_msg2hash($msg);
+ my $error= 0;
+ my $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>1</answer1></xml>";
+
+ my @len_hash = keys %{$msg_hash};
+ if( 0 == @len_hash) { $error++; };
+
+ # prepare query sql statement
+ if( $error == 0) {
+ my $table= $main::job_queue_table_name;
+ my $where= &get_where_statement($msg, $msg_hash);
+ my $update= &get_update_statement($msg, $msg_hash);
+
+ # conditions
+ # no timestamp update if status eq waiting
+ my $res_hash = $main::job_db->select_dbentry("SELECT * FROM $table $where AND status='processing' ");
+ if( (0 != keys(%$res_hash)) && ($update =~ /timestamp/i) ) {
+ $error ++;
+ $out_xml = "<answer1>1</answer1><error_string>there is no timestamp update allowed while status is 'processing'</error_string>";
+ }
+
+ if( $error == 0 ) {
+ my $sql_statement = "UPDATE $table $update $where";
+ # execute db query
+ my $db_res = $main::job_db->update_dbentry($sql_statement);
+
+ # check success of db update
+ if( not $db_res > 0 ) { $error++; };
+
+ }
+ }
+
+ if( $error == 0) {
+ $out_xml = "<answer1>0</answer1>";
+ }
+
+ my $out_msg = sprintf("<xml><header>answer</header><source>%s</source><target>GOSA</target>%s</xml>", $server_address, $out_xml);
+ my @out_msg_l = ( $out_msg );
+ return @out_msg_l;
}
1;
+
+
+
+
+
+
+
+
+
+