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