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; }      # only SI specific events
 233
 234         eval{ require $event; };
 235         if( $@ ) {
 236             &main::daemon_log("import of event module '$event' failed", 1);
 237             &main::daemon_log("$@", 8);
 238             next;
 239         }
 240
 241         $event =~ /(\S*?).pm$/;
 242         my $event_module = $1;
 243         my $events_l = eval( $1."::get_events()") ;
 244         foreach my $event_name (@{$events_l}) {
 245             $event_hash->{$event_name} = $event_module;
 246         }
 247         my $events_string = join( ", ", @{$events_l});
 248         &main::daemon_log("INFO: GosaPackages imported events $events_string", 5);
 249     }
 250 }
 251
 252
 253 #===  FUNCTION  ================================================================
 254 #         NAME:  process_incoming_msg
 255 #   PARAMETERS:  crypted_msg - string - incoming crypted message
 256 #      RETURNS:  nothing
 257 #  DESCRIPTION:  handels the proceeded distribution to the appropriated functions
 258 #===============================================================================
 259 sub process_incoming_msg {
 260     my ($msg, $msg_hash, $session_id) = @_ ;
 261     my $header = @{$msg_hash->{header}}[0];
 262     my @msg_l;
 263     my @out_msg_l;
 264
 265     &main::daemon_log("GosaPackages: receive '$header'", 1);
 266
 267     if ($header =~ /^job_/) {
 268         @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
 269     }
 270     elsif ($header =~ /^gosa_/) {
 271         @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
 272     }
 273     else {
 274         &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
 275     }
 276
 277     foreach my $out_msg ( @msg_l ) {
 278
 279         # keep job queue up-to-date and save result and status
 280         if (defined ($out_msg) && $out_msg =~ /<jobdb_id>(\d+)<\/jobdb_id>/) {
 281             my $job_id = $1;
 282             my $sql = "UPDATE '".$main::job_queue_table_name."'".
 283                 " SET status='processing'".
 284                 " WHERE id='$job_id'";
 285             my $res = $main::job_db->exec_statement($sql);
 286         }
 287
 288         # substitute in all outgoing msg <source>GOSA</source> of <source>$server_address</source>
 289         $out_msg =~ s/<source>GOSA<\/source>/<source>$server_address<\/source>/g;
 290
 291         if (defined $out_msg){
 292             push(@out_msg_l, $out_msg);
 293         }
 294
 295     }
 296
 297     return \@out_msg_l;
 298 }
 299
 300
 301 sub process_gosa_msg {
 302     my ($msg, $msg_hash, $session_id) = @_ ;
 303     my $out_msg;
 304     my @out_msg_l;
 305
 306     my $header = @{$msg_hash->{'header'}}[0];
 307     $header =~ s/gosa_//;
 308
 309     # decide wether msg is a core function or a event handler
 310     if ( $header eq 'query_jobdb') {
 311         @out_msg_l = &query_jobdb
 312     } elsif ($header eq 'delete_jobdb_entry') {
 313         @out_msg_l = &delete_jobdb_entry
 314     } elsif ($header eq 'clear_jobdb') {
 315         @out_msg_l = &clear_jobdb
 316     } elsif ($header eq 'update_status_jobdb_entry' ) {
 317         @out_msg_l = &update_status_jobdb_entry
 318     } elsif ($header eq 'count_jobdb' ) {
 319         @out_msg_l = &count_jobdb
 320     } else {
 321         # msg could not be assigned to core function
 322         # maybe it is an eventa
 323         if( exists $event_hash->{$header} ) {
 324             # a event exists with the header as name
 325             &main::daemon_log("found event '$header' at event-module '".$event_hash->{$header}."'", 5);
 326             no strict 'refs';
 327             @out_msg_l = &{$event_hash->{$header}."::$header"}($msg, $msg_hash, $session_id);
 328          }
 329     }
 330
 331     # if delivery not possible raise error and return
 332     if( not @out_msg_l ) {
 333         &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
 334     } elsif( 0 == @out_msg_l) {
 335         &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
 336     }
 337
 338     return @out_msg_l;
 339 }
 340
 341
 342 sub process_job_msg {
 343     my ($msg, $msg_hash, $session_id)= @_ ;
 344     my $out_msg;
 345     my $error = 0;
 346
 347     my $header = @{$msg_hash->{'header'}}[0];
 348     $header =~ s/job_//;
 349
 350     # if no timestamp is specified, use 19700101000000
 351     my $timestamp = "19700101000000";
 352     if( exists $msg_hash->{'timestamp'} ) {
 353         $timestamp = @{$msg_hash->{'timestamp'}}[0];
 354     }
 355
 356     #if no macaddress is specified, raise error
 357     my $macaddress;
 358     if( exists $msg_hash->{'macaddress'} ) {
 359         $macaddress = @{$msg_hash->{'macaddress'}}[0];
 360     } else {
 361         $error ++;
 362         $out_msg = "<xml>".
 363             "<header>answer</header>".
 364             "<source>$server_address</source>".
 365             "<target>GOSA</target>".
 366             "<answer1>1</answer1>".
 367             "<error_string>no mac address specified</error_string>".
 368             "</xml>";
 369     }
 370
 371     # check wether mac address is already known in known_daemons or known_clients
 372     my $target = 'none';
 373
 374     if( $error == 0 ) {
 375         # add job to job queue
 376         my $func_dic = {table=>$main::job_queue_table_name,
 377             primkey=>'id',
 378             timestamp=>$timestamp,
 379             status=>'waiting',
 380             result=>'none',
 381             headertag=>$header,
 382             targettag=>$target,
 383             xmlmessage=>$msg,
 384             macaddress=>$macaddress,
 385         };
 386
 387         my $res = $main::job_db->add_dbentry($func_dic);
 388         if (not $res == 0) {
 389             &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
 390         } else {
 391             &main::daemon_log("INFO: GosaPackages: $header job successfully added to job queue", 5);
 392         }
 393         $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
 394     }
 395
 396     my @out_msg_l = ( $out_msg );
 397     return @out_msg_l;
 398 }
 399
 400
 401 sub db_res_2_xml {
 402     my ($db_res) = @_ ;
 403     my $xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target>";
 404
 405     my $len_db_res= keys %{$db_res};
 406     for( my $i= 1; $i<= $len_db_res; $i++ ) {
 407         $xml .= "\n<answer$i>";
 408         my $hash= $db_res->{$i};
 409         while ( my ($column_name, $column_value) = each %{$hash} ) {
 410             $xml .= "<$column_name>";
 411             my $xml_content;
 412             if( $column_name eq "xmlmessage" ) {
 413                 $xml_content = &encode_base64($column_value);
 414             } else {
 415                 $xml_content = $column_value;
 416             }
 417             $xml .= $xml_content;
 418             $xml .= "</$column_name>";
 419         }
 420         $xml .= "</answer$i>";
 421
 422     }
 423
 424     $xml .= "</xml>";
 425     return $xml;
 426 }
 427
 428
 429 ## CORE FUNCTIONS ############################################################
 430
 431 sub query_jobdb {
 432     my ($msg) = @_;
 433     my $msg_hash = &transform_msg2hash($msg);
 434
 435     # prepare query sql statement
 436     my $select= &get_select_statement($msg, $msg_hash);
 437     my $table= $main::job_queue_table_name;
 438     my $where= &get_where_statement($msg, $msg_hash);
 439     my $limit= &get_limit_statement($msg, $msg_hash);
 440     my $orderby= &get_orderby_statement($msg, $msg_hash);
 441     my $sql_statement= "SELECT $select FROM $table $where $orderby $limit";
 442
 443     # execute db query
 444     my $res_hash = $main::job_db->select_dbentry($sql_statement);
 445     my $out_xml = &db_res_2_xml($res_hash);
 446     my @out_msg_l = ( $out_xml );
 447     return @out_msg_l;
 448 }
 449
 450
 451 sub count_jobdb {
 452     my ($msg)= @_;
 453     my $out_xml= "<xml><count>error</count></xml>";
 454
 455     # prepare query sql statement
 456     my $table= $main::job_queue_table_name;
 457     my $sql_statement= "SELECT * FROM $table ";
 458
 459     # execute db query
 460     my $res_hash = $main::job_db->select_dbentry($sql_statement);
 461
 462     my $count = keys(%{$res_hash});
 463     $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><count>$count</count></xml>";
 464     my @out_msg_l = ( $out_xml );
 465     return @out_msg_l;
 466 }
 467
 468
 469 sub delete_jobdb_entry {
 470     my ($msg) = @_ ;
 471     my $msg_hash = &transform_msg2hash($msg);
 472
 473     # prepare query sql statement
 474     my $table= $main::job_queue_table_name;
 475     my $where= &get_where_statement($msg, $msg_hash);
 476     my $sql_statement = "DELETE FROM $table $where";
 477
 478     # execute db query
 479     my $db_res = $main::job_db->del_dbentry($sql_statement);
 480
 481     my $res;
 482     if( $db_res > 0 ) {
 483         $res = 0 ;
 484     } else {
 485         $res = 1;
 486     }
 487
 488     # prepare xml answer
 489     my $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
 490     my @out_msg_l = ( $out_xml );
 491     return @out_msg_l;
 492
 493 }
 494
 495
 496 sub clear_jobdb {
 497     my ($msg) = @_ ;
 498     my $msg_hash = &transform_msg2hash($msg);
 499     my $error= 0;
 500     my $out_xml= "<xml><answer1>1</answer1></xml>";
 501
 502     my $table= $main::job_queue_table_name;
 503
 504     my $sql_statement = "DELETE FROM $table";
 505     my $db_res = $main::job_db->del_dbentry($sql_statement);
 506     if( not $db_res > 0 ) { $error++; };
 507
 508     if( $error == 0 ) {
 509         $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
 510     }
 511     my @out_msg_l = ( $out_xml );
 512     return @out_msg_l;
 513 }
 514
 515
 516 sub update_status_jobdb_entry {
 517     my ($msg) = @_ ;
 518     my $msg_hash = &transform_msg2hash($msg);
 519     my $error= 0;
 520     my $out_xml= "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>1</answer1></xml>";
 521
 522     my @len_hash = keys %{$msg_hash};
 523     if( 0 == @len_hash) {  $error++; };
 524
 525     # prepare query sql statement
 526     if( $error == 0) {
 527         my $table= $main::job_queue_table_name;
 528         my $where= &get_where_statement($msg, $msg_hash);
 529         my $update= &get_update_statement($msg, $msg_hash);
 530
 531         # conditions
 532         # no timestamp update if status eq waiting
 533
 534
 535         my $sql_statement = "UPDATE $table $update $where";
 536         # execute db query
 537         my $db_res = $main::job_db->update_dbentry($sql_statement);
 538
 539         # check success of db update
 540         if( not $db_res > 0 ) { $error++; };
 541     }
 542
 543     if( $error == 0) {
 544         $out_xml = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>0</answer1></xml>";
 545     }
 546     my @out_msg_l = ( $out_xml );
 547
 548 print STDERR $out_xml."\n";
 549
 550     return @out_msg_l;
 551 }
 552
 553
 554 1;
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564