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 Socket;
  11 use XML::Simple;
  12 use File::Spec;
  13 use Data::Dumper;
  14 use GOSA::DBsqlite;
  15 use MIME::Base64;
  16
  17 my $event_dir = "/usr/lib/gosa-si/server/events";
  18 use lib "/usr/lib/gosa-si/server/events";
  19
  20 BEGIN{}
  21 END{}
  22
  23 my ($server_ip, $server_mac_address, $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);
  26
  27 my $gosa_server;
  28 my $event_hash;
  29
  30 my %cfg_defaults = (
  31 "server" => {
  32     "ip" => [\$server_ip, "0.0.0.0"],
  33     "port" => [\$server_port, "20081"],
  34     "key" => [\$server_passwd, ""],
  35     "max-clients" => [\$max_clients, 100],
  36     },
  37 "GOsaPackages" => {
  38     "ip" => [\$gosa_ip, "0.0.0.0"],
  39     "port" => [\$gosa_port, "20082"],
  40     "key" => [\$gosa_passwd, "none"],
  41     "job-queue" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
  42     },
  43 );
  44
  45
  46 ## START ##########################
  47
  48 # read configfile and import variables
  49 &read_configfile();
  50 $network_interface= &get_interface_for_ip($server_ip);
  51 $gosa_mac_address= &get_mac($network_interface);
  52
  53 # complete addresses
  54 if( inet_aton($server_ip) ){ $server_ip = inet_ntoa(inet_aton($server_ip)); }
  55 our $server_address = "$server_ip:$server_port";
  56 if( inet_aton($gosa_ip) ){ $gosa_ip = inet_ntoa(inet_aton($gosa_ip)); }
  57 my $gosa_address = "$gosa_ip:$gosa_port";
  58
  59 # create general settings for this module
  60 #y $gosa_cipher = &create_ciphering($gosa_passwd);
  61 my $xml = new XML::Simple();
  62
  63
  64 # import events
  65 &import_events();
  66
  67 ## FUNCTIONS #################################################################
  68
  69 sub get_module_info {
  70     my @info = ($gosa_address,
  71                 $gosa_passwd,
  72                 );
  73     return \@info;
  74 }
  75
  76
  77 #===  FUNCTION  ================================================================
  78 #         NAME:  read_configfile
  79 #   PARAMETERS:  cfg_file - string -
  80 #      RETURNS:  nothing
  81 #  DESCRIPTION:  read cfg_file and set variables
  82 #===============================================================================
  83 sub read_configfile {
  84     my $cfg;
  85     if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
  86         if( -r $main::cfg_file ) {
  87             $cfg = Config::IniFiles->new( -file => $main::cfg_file );
  88         } else {
  89             print STDERR "Couldn't read config file!";
  90         }
  91     } else {
  92         $cfg = Config::IniFiles->new() ;
  93     }
  94     foreach my $section (keys %cfg_defaults) {
  95         foreach my $param (keys %{$cfg_defaults{ $section }}) {
  96             my $pinfo = $cfg_defaults{ $section }{ $param };
  97             ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
  98         }
  99     }
 100 }
 101
 102 #===  FUNCTION  ================================================================
 103 #         NAME:  get_interface_for_ip
 104 #   PARAMETERS:  ip address (i.e. 192.168.0.1)
 105 #      RETURNS:  array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
 106 #  DESCRIPTION:  Uses proc fs (/proc/net/dev) to get list of interfaces.
 107 #===============================================================================
 108 sub get_interface_for_ip {
 109         my $result;
 110         my $ip= shift;
 111         if ($ip && length($ip) > 0) {
 112                 my @ifs= &get_interfaces();
 113                 if($ip eq "0.0.0.0") {
 114                         $result = "all";
 115                 } else {
 116                         foreach (@ifs) {
 117                                 my $if=$_;
 118                                 if(get_ip($if) eq $ip) {
 119                                         $result = $if;
 120                                 }
 121                         }
 122                 }
 123         }
 124         return $result;
 125 }
 126
 127 #===  FUNCTION  ================================================================
 128 #         NAME:  get_interfaces
 129 #   PARAMETERS:  none
 130 #      RETURNS:  (list of interfaces)
 131 #  DESCRIPTION:  Uses proc fs (/proc/net/dev) to get list of interfaces.
 132 #===============================================================================
 133 sub get_interfaces {
 134         my @result;
 135         my $PROC_NET_DEV= ('/proc/net/dev');
 136
 137         open(PROC_NET_DEV, "<$PROC_NET_DEV")
 138                 or die "Could not open $PROC_NET_DEV";
 139
 140         my @ifs = <PROC_NET_DEV>;
 141
 142         close(PROC_NET_DEV);
 143
 144         # Eat first two line
 145         shift @ifs;
 146         shift @ifs;
 147
 148         chomp @ifs;
 149         foreach my $line(@ifs) {
 150                 my $if= (split /:/, $line)[0];
 151                 $if =~ s/^\s+//;
 152                 push @result, $if;
 153         }
 154
 155         return @result;
 156 }
 157
 158 #===  FUNCTION  ================================================================
 159 #         NAME:  get_mac
 160 #   PARAMETERS:  interface name (i.e. eth0)
 161 #      RETURNS:  (mac address)
 162 #  DESCRIPTION:  Uses ioctl to get mac address directly from system.
 163 #===============================================================================
 164 sub get_mac {
 165         my $ifreq= shift;
 166         my $result;
 167         if ($ifreq && length($ifreq) > 0) {
 168                 if($ifreq eq "all") {
 169                         $result = "00:00:00:00:00:00";
 170                 } else {
 171                         my $SIOCGIFHWADDR= 0x8927;     # man 2 ioctl_list
 172
 173                         # A configured MAC Address should always override a guessed value
 174                         if ($gosa_mac_address and length($gosa_mac_address) > 0) {
 175                                 $result= $gosa_mac_address;
 176                         }
 177
 178                         socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
 179                                 or die "socket: $!";
 180
 181                         if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
 182                                 my ($if, $mac)= unpack 'h36 H12', $ifreq;
 183
 184                                 if (length($mac) > 0) {
 185                                         $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])$/;
 186                                         $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
 187                                         $result = $mac;
 188                                 }
 189                         }
 190                 }
 191         }
 192         return $result;
 193 }
 194
 195 #===  FUNCTION  ================================================================
 196 #         NAME:  get_ip
 197 #   PARAMETERS:  interface name (i.e. eth0)
 198 #      RETURNS:  (ip address)
 199 #  DESCRIPTION:  Uses ioctl to get ip address directly from system.
 200 #===============================================================================
 201 sub get_ip {
 202         my $ifreq= shift;
 203         my $result= "";
 204         my $SIOCGIFADDR= 0x8915;       # man 2 ioctl_list
 205         my $proto= getprotobyname('ip');
 206
 207         socket SOCKET, PF_INET, SOCK_DGRAM, $proto
 208                 or die "socket: $!";
 209
 210         if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
 211                 my ($if, $sin)    = unpack 'a16 a16', $ifreq;
 212                 my ($port, $addr) = sockaddr_in $sin;
 213                 my $ip            = inet_ntoa $addr;
 214
 215                 if ($ip && length($ip) > 0) {
 216                         $result = $ip;
 217                 }
 218         }
 219
 220         return $result;
 221 }
 222
 223
 224 sub import_events {
 225     if (not -e $event_dir) {
 226         &main::daemon_log("ERROR: cannot find directory or directory is not readable: $event_dir", 1);
 227     }
 228     opendir (DIR, $event_dir) or die "ERROR while loading gosa-si-events from directory $event_dir : $!\n";
 229
 230     while (defined (my $event = readdir (DIR))) {
 231         if( $event eq "." || $event eq ".." ) { next; }
 232         if( $event eq "siTriggered.pm" ) { next; }      # SI specific events not needed in GosaPackages.pm
 233         if( $event eq "clMessages.pm" ) { next; }                    # SI specific events not needed in GosaPackages.pm
 234
 235         eval{ require $event; };
 236         if( $@ ) {
 237             &main::daemon_log("ERROR: import of event module '$event' failed", 1);
 238             &main::daemon_log("$@", 1);
 239             next;
 240         }
 241
 242         $event =~ /(\S*?).pm$/;
 243         my $event_module = $1;
 244         my $events_l = eval( $1."::get_events()") ;
 245         foreach my $event_name (@{$events_l}) {
 246             $event_hash->{$event_name} = $event_module;
 247         }
 248         my $events_string = join( ", ", @{$events_l});
 249         &main::daemon_log("INFO: GosaPackages imported events $events_string", 5);
 250     }
 251 }
 252
 253
 254 #===  FUNCTION  ================================================================
 255 #         NAME:  process_incoming_msg
 256 #   PARAMETERS:  crypted_msg - string - incoming crypted message
 257 #      RETURNS:  nothing
 258 #  DESCRIPTION:  handels the proceeded distribution to the appropriated functions
 259 #===============================================================================
 260 sub process_incoming_msg {
 261     my ($msg, $msg_hash, $session_id) = @_ ;
 262     my $header = @{$msg_hash->{header}}[0];
 263     my @msg_l;
 264     my @out_msg_l;
 265
 266     &main::daemon_log("GosaPackages: receive '$header'", 1);
 267
 268     if ($header =~ /^job_/) {
 269         @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
 270     }
 271     elsif ($header =~ /^gosa_/) {
 272         @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
 273     }
 274     else {
 275         &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
 276     }
 277
 278     foreach my $out_msg ( @msg_l ) {
 279
 280         # keep job queue up-to-date and save result and status
 281         if (defined ($out_msg) && $out_msg =~ /<jobdb_id>(\d+)<\/jobdb_id>/) {
 282             my $job_id = $1;
 283             my $sql = "UPDATE '".$main::job_queue_table_name."'".
 284                 " SET status='processing'".
 285                 " WHERE id='$job_id'";
 286             my $res = $main::job_db->exec_statement($sql);
 287         }
 288
 289         # substitute in all outgoing msg <source>GOSA</source> of <source>$server_address</source>
 290         $out_msg =~ s/<source>GOSA<\/source>/<source>$server_address<\/source>/g;
 291
 292         if (defined $out_msg){
 293             push(@out_msg_l, $out_msg);
 294         }
 295
 296     }
 297
 298     return \@out_msg_l;
 299 }
 300
 301
 302 sub process_gosa_msg {
 303     my ($msg, $msg_hash, $session_id) = @_ ;
 304     my $out_msg;
 305     my @out_msg_l;
 306
 307     my $header = @{$msg_hash->{'header'}}[0];
 308     $header =~ s/gosa_//;
 309
 310     # decide wether msg is a core function or a event handler
 311     if ( $header eq 'query_jobdb') {
 312         @out_msg_l = &query_jobdb
 313     } elsif ($header eq 'delete_jobdb_entry') {
 314         @out_msg_l = &delete_jobdb_entry
 315     } elsif ($header eq 'clear_jobdb') {
 316         @out_msg_l = &clear_jobdb
 317     } elsif ($header eq 'update_status_jobdb_entry' ) {
 318         @out_msg_l = &update_status_jobdb_entry
 319     } elsif ($header eq 'count_jobdb' ) {
 320         @out_msg_l = &count_jobdb
 321     } else {
 322         # msg could not be assigned to core function
 323         # maybe it is an eventa
 324         if( exists $event_hash->{$header} ) {
 325             # a event exists with the header as name
 326             &main::daemon_log("found event '$header' at event-module '".$event_hash->{$header}."'", 5);
 327             no strict 'refs';
 328             @out_msg_l = &{$event_hash->{$header}."::$header"}($msg, $msg_hash, $session_id);
 329          }
 330     }
 331
 332     # if delivery not possible raise error and return
 333     if( not @out_msg_l ) {
 334         &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
 335     } elsif( 0 == @out_msg_l) {
 336         &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
 337     }
 338
 339     return @out_msg_l;
 340 }
 341
 342
 343 sub process_job_msg {
 344     my ($msg, $msg_hash, $session_id)= @_ ;
 345     my $out_msg;
 346     my $error = 0;
 347
 348     my $header = @{$msg_hash->{'header'}}[0];
 349     $header =~ s/job_//;
 350
 351     # if no timestamp is specified, use 19700101000000
 352     my $timestamp = "19700101000000";
 353     if( exists $msg_hash->{'timestamp'} ) {
 354         $timestamp = @{$msg_hash->{'timestamp'}}[0];
 355     }
 356
 357     #if no macaddress is specified, raise error
 358     my $macaddress;
 359     if( exists $msg_hash->{'macaddress'} ) {
 360         $macaddress = @{$msg_hash->{'macaddress'}}[0];
 361     } else {
 362         $error ++;
 363         $out_msg = "<xml>".
 364             "<header>answer</header>".
 365             "<source>$server_address</source>".
 366             "<target>GOSA</target>".
 367             "<answer1>1</answer1>".
 368             "<error_string>no mac address specified</error_string>".
 369             "</xml>";
 370     }
 371
 372     # check wether mac address is already known in known_daemons or known_clients
 373     my $target = 'none';
 374
 375     if( $error == 0 ) {
 376         # add job to job queue
 377         my $func_dic = {table=>$main::job_queue_table_name,
 378             primkey=>'id',
 379             timestamp=>$timestamp,
 380             status=>'waiting',
 381             result=>'none',
 382             progress=>'none',
 383             headertag=>$header,
 384             targettag=>$target,
 385             xmlmessage=>$msg,
 386             macaddress=>$macaddress,
 387         };
 388
 389         my $res = $main::job_db->add_dbentry($func_dic);
 390         if (not $res == 0) {
 391             &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
 392         } else {
 393             &main::daemon_log("INFO: GosaPackages: $header job successfully added to job queue", 5);
 394         }
 395         $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
 396     }
 397
 398     my @out_msg_l = ( $out_msg );
 399     return @out_msg_l;
 400 }
 401
 402
 403 sub db_res_2_xml {
 404     my ($db_res) = @_ ;
 405     my $xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target>";
 406
 407     my $len_db_res= keys %{$db_res};
 408     for( my $i= 1; $i<= $len_db_res; $i++ ) {
 409         $xml .= "\n<answer$i>";
 410         my $hash= $db_res->{$i};
 411         while ( my ($column_name, $column_value) = each %{$hash} ) {
 412             $xml .= "<$column_name>";
 413             my $xml_content;
 414             if( $column_name eq "xmlmessage" ) {
 415                 $xml_content = &encode_base64($column_value);
 416             } else {
 417                 $xml_content = $column_value;
 418             }
 419             $xml .= $xml_content;
 420             $xml .= "</$column_name>";
 421         }
 422         $xml .= "</answer$i>";
 423
 424     }
 425
 426     $xml .= "</xml>";
 427     return $xml;
 428 }
 429
 430
 431 ## CORE FUNCTIONS ############################################################
 432
 433 sub query_jobdb {
 434     my ($msg) = @_;
 435     my $msg_hash = &transform_msg2hash($msg);
 436
 437     # prepare query sql statement
 438     my $select= &get_select_statement($msg, $msg_hash);
 439     my $table= $main::job_queue_table_name;
 440     my $where= &get_where_statement($msg, $msg_hash);
 441     my $limit= &get_limit_statement($msg, $msg_hash);
 442     my $orderby= &get_orderby_statement($msg, $msg_hash);
 443     my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
 444
 445     # execute db query
 446     my $res_hash = $main::job_db->select_dbentry($sql_statement);
 447     my $out_xml = &db_res_2_xml($res_hash);
 448     my @out_msg_l = ( $out_xml );
 449     return @out_msg_l;
 450 }
 451
 452
 453 sub count_jobdb {
 454     my ($msg)= @_;
 455     my $out_xml= "<xml><count>error</count></xml>";
 456
 457     # prepare query sql statement
 458     my $table= $main::job_queue_table_name;
 459     my $sql_statement= "SELECT * FROM $table ";
 460
 461     # execute db query
 462     my $res_hash = $main::job_db->select_dbentry($sql_statement);
 463
 464     my $count = keys(%{$res_hash});
 465     $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><count>$count</count></xml>";
 466     my @out_msg_l = ( $out_xml );
 467     return @out_msg_l;
 468 }
 469
 470
 471 sub delete_jobdb_entry {
 472     my ($msg) = @_ ;
 473     my $msg_hash = &transform_msg2hash($msg);
 474
 475     # prepare query sql statement
 476     my $table= $main::job_queue_table_name;
 477     my $where= &get_where_statement($msg, $msg_hash);
 478     my $sql_statement = "DELETE FROM $table $where";
 479
 480     # execute db query
 481     my $db_res = $main::job_db->del_dbentry($sql_statement);
 482
 483     my $res;
 484     if( $db_res > 0 ) {
 485         $res = 0 ;
 486     } else {
 487         $res = 1;
 488     }
 489
 490     # prepare xml answer
 491     my $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
 492     my @out_msg_l = ( $out_xml );
 493     return @out_msg_l;
 494
 495 }
 496
 497
 498 sub clear_jobdb {
 499     my ($msg) = @_ ;
 500     my $msg_hash = &transform_msg2hash($msg);
 501     my $error= 0;
 502     my $out_xml= "<xml><answer1>1</answer1></xml>";
 503
 504     my $table= $main::job_queue_table_name;
 505
 506     my $sql_statement = "DELETE FROM $table";
 507     my $db_res = $main::job_db->del_dbentry($sql_statement);
 508     if( not $db_res > 0 ) { $error++; };
 509
 510     if( $error == 0 ) {
 511         $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
 512     }
 513     my @out_msg_l = ( $out_xml );
 514     return @out_msg_l;
 515 }
 516
 517
 518 sub update_status_jobdb_entry {
 519     my ($msg) = @_ ;
 520     my $msg_hash = &transform_msg2hash($msg);
 521     my $error= 0;
 522     my $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>1</answer1></xml>";
 523
 524     my @len_hash = keys %{$msg_hash};
 525     if( 0 == @len_hash) {  $error++; };
 526
 527     # prepare query sql statement
 528     if( $error == 0) {
 529         my $table= $main::job_queue_table_name;
 530         my $where= &get_where_statement($msg, $msg_hash);
 531         my $update= &get_update_statement($msg, $msg_hash);
 532
 533         # conditions
 534         # no timestamp update if status eq waiting
 535         my $res_hash = $main::job_db->select_dbentry("SELECT * FROM $table $where AND status='processing' ");
 536         if( (0 != keys(%$res_hash)) && ($update =~ /timestamp/i) ) {
 537             $error ++;
 538             $out_xml = "<answer1>1</answer1><error_string>there is no timestamp update allowed while status is 'processing'</error_string>";
 539         }
 540
 541         if( $error == 0 ) {
 542             my $sql_statement = "UPDATE $table $update $where";
 543             # execute db query
 544             my $db_res = $main::job_db->update_dbentry($sql_statement);
 545
 546             # check success of db update
 547             if( not $db_res > 0 ) { $error++; };
 548
 549         }
 550     }
 551
 552     if( $error == 0) {
 553         $out_xml = "<answer1>0</answer1>";
 554     }
 555
 556     my $out_msg = sprintf("<xml><header>answer</header><source>%s</source><target>GOSA</target>%s</xml>", $server_address, $out_xml);
 557     my @out_msg_l = ( $out_msg );
 558     return @out_msg_l;
 559 }
 560
 561
 562 1;
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572