gosa-si/modules/GosaPackages.pm

   1 package GosaPackages;
   2
   3 use Exporter;
   4 @ISA = ("Exporter");
   5
   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;
  15
  16 my $event_dir = "/usr/lib/gosa-si/server/events";
  17 use lib "/usr/lib/gosa-si/server/events";
  18
  19 BEGIN{}
  20 END{}
  21
  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);
  25
  26 my $gosa_server;
  27 my $event_hash;
  28
  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 );
  43
  44
  45 ## START ##########################
  46
  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);
  51
  52 # complete addresses
  53 our $server_address = "$server_ip:$server_port";
  54 my $gosa_address = "$gosa_ip:$gosa_port";
  55
  56 # create general settings for this module
  57 #y $gosa_cipher = &create_ciphering($gosa_passwd);
  58 my $xml = new XML::Simple();
  59
  60
  61 # import events
  62 &import_events();
  63
  64 ## FUNCTIONS #################################################################
  65
  66 sub get_module_info {
  67     my @info = ($gosa_address,
  68                 $gosa_passwd,
  69                 );
  70     return \@info;
  71 }
  72
  73
  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 }
  98
  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 }
 123
 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');
 133
 134         open(PROC_NET_DEV, "<$PROC_NET_DEV")
 135                 or die "Could not open $PROC_NET_DEV";
 136
 137         my @ifs = <PROC_NET_DEV>;
 138
 139         close(PROC_NET_DEV);
 140
 141         # Eat first two line
 142         shift @ifs;
 143         shift @ifs;
 144
 145         chomp @ifs;
 146         foreach my $line(@ifs) {
 147                 my $if= (split /:/, $line)[0];
 148                 $if =~ s/^\s+//;
 149                 push @result, $if;
 150         }
 151
 152         return @result;
 153 }
 154
 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
 169
 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                         }
 174
 175                         socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
 176                                 or die "socket: $!";
 177
 178                         if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
 179                                 my ($if, $mac)= unpack 'h36 H12', $ifreq;
 180
 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 }
 191
 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');
 203
 204         socket SOCKET, PF_INET, SOCK_DGRAM, $proto
 205                 or die "socket: $!";
 206
 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;
 211
 212                 if ($ip && length($ip) > 0) {
 213                         $result = $ip;
 214                 }
 215         }
 216
 217         return $result;
 218 }
 219
 220
 221 sub import_events {
 222     if (not -e $event_dir) {
 223         &main::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";
 226
 227     while (defined (my $event = readdir (DIR))) {
 228         if( $event eq "." || $event eq ".." ) { next; }
 229         if( $event eq "siTriggered.pm" ) { next; }      # only SI specific events
 230
 231         eval{ require $event; };
 232         if( $@ ) {
 233             &main::daemon_log("import of event module '$event' failed", 1);
 234             &main::daemon_log("$@", 8);
 235             next;
 236         }
 237
 238         $event =~ /(\S*?).pm$/;
 239         my $event_module = $1;
 240         my $events_l = eval( $1."::get_events()") ;
 241         foreach my $event_name (@{$events_l}) {
 242             $event_hash->{$event_name} = $event_module;
 243         }
 244         my $events_string = join( ", ", @{$events_l});
 245         &main::daemon_log("INFO: GosaPackages imported events $events_string", 5);
 246     }
 247 }
 248
 249
 250 #===  FUNCTION  ================================================================
 251 #         NAME:  process_incoming_msg
 252 #   PARAMETERS:  crypted_msg - string - incoming crypted message
 253 #      RETURNS:  nothing
 254 #  DESCRIPTION:  handels the proceeded distribution to the appropriated functions
 255 #===============================================================================
 256 sub process_incoming_msg {
 257     my ($msg, $msg_hash, $session_id) = @_ ;
 258     my $header = @{$msg_hash->{header}}[0];
 259     my @msg_l;
 260     my @out_msg_l;
 261
 262     &main::daemon_log("GosaPackages: receive '$header'", 1);
 263
 264     if ($header =~ /^job_/) {
 265         @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
 266     }
 267     elsif ($header =~ /^gosa_/) {
 268         @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
 269     }
 270     else {
 271         &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
 272     }
 273
 274     foreach my $out_msg ( @msg_l ) {
 275
 276         # keep job queue up-to-date and save result and status
 277         if (defined ($out_msg) && $out_msg =~ /<jobdb_id>(\d+)<\/jobdb_id>/) {
 278             my $job_id = $1;
 279             my $sql = "UPDATE '".$main::job_queue_table_name."'".
 280                 " SET status='done'".
 281                 " WHERE id='$job_id'";
 282             my $res = $main::job_db->exec_statement($sql);
 283         }
 284
 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
 288         if (defined $out_msg){
 289             push(@out_msg_l, $out_msg);
 290         }
 291
 292     }
 293
 294     return \@out_msg_l;
 295 }
 296
 297
 298 sub process_gosa_msg {
 299     my ($msg, $msg_hash, $session_id) = @_ ;
 300     my $out_msg;
 301     my @out_msg_l;
 302
 303     my $header = @{$msg_hash->{'header'}}[0];
 304     $header =~ s/gosa_//;
 305
 306     # decide wether msg is a core function or a event handler
 307     if ( $header eq 'query_jobdb') {
 308         @out_msg_l = &query_jobdb
 309     } elsif ($header eq 'delete_jobdb_entry') {
 310         @out_msg_l = &delete_jobdb_entry
 311     } elsif ($header eq 'clear_jobdb') {
 312         @out_msg_l = &clear_jobdb
 313     } elsif ($header eq 'update_status_jobdb_entry' ) {
 314         @out_msg_l = &update_status_jobdb_entry
 315     } elsif ($header eq 'count_jobdb' ) {
 316         @out_msg_l = &count_jobdb
 317     } else {
 318         # msg could not be assigned to core function
 319         # maybe it is an eventa
 320         if( exists $event_hash->{$header} ) {
 321             # a event exists with the header as name
 322             &main::daemon_log("found event '$header' at event-module '".$event_hash->{$header}."'", 5);
 323             no strict 'refs';
 324             @out_msg_l = &{$event_hash->{$header}."::$header"}($msg, $msg_hash, $session_id);
 325          }
 326     }
 327
 328     # if delivery not possible raise error and return
 329     if( not @out_msg_l ) {
 330         &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
 331     } elsif( 0 == @out_msg_l) {
 332         &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
 333     }
 334
 335     return @out_msg_l;
 336 }
 337
 338
 339 sub process_job_msg {
 340     my ($msg, $msg_hash, $session_id)= @_ ;
 341     my $out_msg;
 342     my $error = 0;
 343
 344     my $header = @{$msg_hash->{'header'}}[0];
 345     $header =~ s/job_//;
 346
 347     # if no timestamp is specified, use 19700101000000
 348     my $timestamp = "19700101000000";
 349     if( exists $msg_hash->{'timestamp'} ) {
 350         $timestamp = @{$msg_hash->{'timestamp'}}[0];
 351     }
 352
 353     #if no macaddress is specified, raise error
 354     my $macaddress;
 355     if( exists $msg_hash->{'macaddress'} ) {
 356         $macaddress = @{$msg_hash->{'macaddress'}}[0];
 357     } else {
 358         $error ++;
 359         $out_msg = "<xml>".
 360             "<header>answer</header>".
 361             "<source>$server_address</source>".
 362             "<target>GOSA</target>".
 363             "<answer1>1</answer1>".
 364             "<error_string>no mac address specified</error_string>".
 365             "</xml>";
 366     }
 367
 368     # check wether mac address is already known in known_daemons or known_clients
 369     my $target = 'none';
 370
 371     if( $error == 0 ) {
 372         # add job to job queue
 373         my $func_dic = {table=>$main::job_queue_table_name,
 374             primkey=>'id',
 375             timestamp=>$timestamp,
 376             status=>'waiting',
 377             result=>'none',
 378             headertag=>$header,
 379             targettag=>$target,
 380             xmlmessage=>$msg,
 381             macaddress=>$macaddress,
 382         };
 383
 384         my $res = $main::job_db->add_dbentry($func_dic);
 385         if (not $res == 0) {
 386             &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
 387         } else {
 388             &main::daemon_log("INFO: GosaPackages: $header job successfully added to job queue", 5);
 389         }
 390         $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
 391     }
 392
 393     my @out_msg_l = ( $out_msg );
 394     return @out_msg_l;
 395 }
 396
 397
 398 sub db_res_2_xml {
 399     my ($db_res) = @_ ;
 400     my $xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target>";
 401
 402     my $len_db_res= keys %{$db_res};
 403     for( my $i= 1; $i<= $len_db_res; $i++ ) {
 404         $xml .= "\n<answer$i>";
 405         my $hash= $db_res->{$i};
 406         while ( my ($column_name, $column_value) = each %{$hash} ) {
 407             $xml .= "<$column_name>";
 408             my $xml_content;
 409             if( $column_name eq "xmlmessage" ) {
 410                 $xml_content = &encode_base64($column_value);
 411             } else {
 412                 $xml_content = $column_value;
 413             }
 414             $xml .= $xml_content;
 415             $xml .= "</$column_name>";
 416         }
 417         $xml .= "</answer$i>";
 418
 419     }
 420
 421     $xml .= "</xml>";
 422     return $xml;
 423 }
 424
 425
 426 ## CORE FUNCTIONS ############################################################
 427
 428 sub query_jobdb {
 429     my ($msg) = @_;
 430     my $msg_hash = &transform_msg2hash($msg);
 431
 432     # prepare query sql statement
 433     my $select= &get_select_statement($msg, $msg_hash);
 434     my $table= $main::job_queue_table_name;
 435     my $where= &get_where_statement($msg, $msg_hash);
 436     my $limit= &get_limit_statement($msg, $msg_hash);
 437     my $orderby= &get_orderby_statement($msg, $msg_hash);
 438     my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
 439
 440     # execute db query
 441     my $res_hash = $main::job_db->select_dbentry($sql_statement);
 442     my $out_xml = &db_res_2_xml($res_hash);
 443     my @out_msg_l = ( $out_xml );
 444     return @out_msg_l;
 445 }
 446
 447
 448 sub count_jobdb {
 449     my ($msg)= @_;
 450     my $out_xml= "<xml><count>error</count></xml>";
 451
 452     # prepare query sql statement
 453     my $table= $main::job_queue_table_name;
 454     my $sql_statement= "SELECT * FROM $table ";
 455
 456     # execute db query
 457     my $res_hash = $main::job_db->select_dbentry($sql_statement);
 458
 459     my $count = keys(%{$res_hash});
 460     $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><count>$count</count></xml>";
 461     my @out_msg_l = ( $out_xml );
 462     return @out_msg_l;
 463 }
 464
 465
 466 sub delete_jobdb_entry {
 467     my ($msg) = @_ ;
 468     my $msg_hash = &transform_msg2hash($msg);
 469
 470     # prepare query sql statement
 471     my $table= $main::job_queue_table_name;
 472     my $where= &get_where_statement($msg, $msg_hash);
 473     my $sql_statement = "DELETE FROM $table $where";
 474
 475     # execute db query
 476     my $db_res = $main::job_db->del_dbentry($sql_statement);
 477
 478     my $res;
 479     if( $db_res > 0 ) {
 480         $res = 0 ;
 481     } else {
 482         $res = 1;
 483     }
 484
 485     # prepare xml answer
 486     my $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
 487     my @out_msg_l = ( $out_xml );
 488     return @out_msg_l;
 489
 490 }
 491
 492
 493 sub clear_jobdb {
 494     my ($msg) = @_ ;
 495     my $msg_hash = &transform_msg2hash($msg);
 496     my $error= 0;
 497     my $out_xml= "<xml><answer1>1</answer1></xml>";
 498
 499     my $table= $main::job_queue_table_name;
 500
 501     my $sql_statement = "DELETE FROM $table";
 502     my $db_res = $main::job_db->del_dbentry($sql_statement);
 503     if( not $db_res > 0 ) { $error++; };
 504
 505     if( $error == 0 ) {
 506         $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
 507     }
 508     my @out_msg_l = ( $out_xml );
 509     return @out_msg_l;
 510 }
 511
 512
 513 sub update_status_jobdb_entry {
 514     my ($msg) = @_ ;
 515     my $msg_hash = &transform_msg2hash($msg);
 516     my $error= 0;
 517     my $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>1</answer1></xml>";
 518
 519     my @len_hash = keys %{$msg_hash};
 520     if( 0 == @len_hash) {  $error++; };
 521
 522     # prepare query sql statement
 523     if( $error == 0) {
 524         my $table= $main::job_queue_table_name;
 525         my $where= &get_where_statement($msg, $msg_hash);
 526         my $update= &get_update_statement($msg, $msg_hash);
 527
 528         my $sql_statement = "UPDATE $table $update $where";
 529
 530         # execute db query
 531         my $db_res = $main::job_db->update_dbentry($sql_statement);
 532
 533         # check success of db update
 534         if( not $db_res > 0 ) { $error++; };
 535     }
 536
 537     if( $error == 0) {
 538         $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
 539     }
 540     my @out_msg_l = ( $out_xml );
 541
 542 print STDERR $out_xml."\n";
 543
 544     return @out_msg_l;
 545 }
 546
 547
 548 1;
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558