gosa-si/client/events/gosaTriggered.pm

   1
   2 =head1 NAME
   3
   4 gosaTriggered.pm
   5
   6 =head1 SYNOPSIS
   7
   8 use GOSA::GosaSupportDaemon;
   9
  10 use MIME::Base64
  11
  12 =head1 DESCRIPTION
  13
  14 This module contains all GOsa-SI-client processing instructions concerning actions controllable from GOsa.
  15
  16 =head1 VERSION
  17
  18 Version 1.0
  19
  20 =head1 AUTHOR
  21
  22 Andreas Rettenberger <rettenberger at gonicus dot de>
  23
  24 =head1 FUNCTIONS
  25
  26 =cut
  27
  28
  29 package gosaTriggered;
  30 use Exporter;
  31 @ISA = qw(Exporter);
  32 my @events = (
  33     "get_events",
  34     "usr_msg",
  35     "trigger_action_localboot",
  36     "trigger_action_halt",
  37     "trigger_action_faireboot",
  38     "trigger_action_reboot",
  39     "trigger_action_reinstall",
  40     "trigger_action_update",
  41     "trigger_action_instant_update",
  42     "trigger_goto_settings_reload",
  43     );
  44 @EXPORT = @events;
  45
  46 use strict;
  47 use warnings;
  48 use GOSA::GosaSupportDaemon;
  49 use MIME::Base64;
  50 use File::Temp qw/ tempfile/;
  51
  52 BEGIN {}
  53
  54 END {}
  55
  56 ### Parameter declarations ###################################################
  57 my $userNotification;
  58 my %cfg_defaults = (
  59 "client" => {
  60         "user-notification-of-admin-activities" => [\$userNotification, 'true'],
  61         },
  62 );
  63
  64 # Read config file
  65 &read_configfile($main::cfg_file, %cfg_defaults);
  66
  67 ###############################################################################
  68 =over
  69
  70 =item B<get_events ()>
  71
  72 =over
  73
  74 =item description
  75
  76     Reports all provided functions.
  77
  78 =item parameter
  79
  80     None.
  81
  82 =item return
  83
  84     \@events - ARRAYREF - array containing all functions
  85
  86 =back
  87
  88 =back
  89
  90 =cut
  91 ###############################################################################
  92 sub get_events { return \@events; }
  93
  94
  95 ###############################################################################
  96 =over
  97
  98 =item B<usr_msg ($$)>
  99
 100 =over
 101
 102 =item description
 103
 104     Executes '/usr/bin/goto-notify' wich displays the message, subject und receiver at screen
 105
 106 =item parameter
 107
 108     $msg - STRING - complete GOsa-si message
 109     $msg_hash - HASHREF - content of GOsa-si message in a hash
 110
 111 =item GOsa-si message xml content
 112
 113     <to> - STRING - username message should be deliverd to
 114     <subject> - STRING - subject of the message, base64 encoded
 115     <message> - STRING - message itself, base64 encoded
 116
 117 =item return
 118
 119     $out_msg - STRING - GOsa-si valid xml message, feedback that message was deliverd
 120
 121 =back
 122
 123 =back
 124
 125 =cut
 126 ###############################################################################
 127 sub usr_msg {
 128     my ($msg, $msg_hash) = @_;
 129     my $header = @{$msg_hash->{'header'}}[0];
 130     my $source = @{$msg_hash->{'source'}}[0];
 131     my $target = @{$msg_hash->{'target'}}[0];
 132
 133     my $to = @{$msg_hash->{'usr'}}[0];
 134     my $subject = &decode_base64(@{$msg_hash->{'subject'}}[0]);
 135     my $message = &decode_base64(@{$msg_hash->{'message'}}[0]);
 136
 137     my ($rand_fh, $rand_file) = tempfile( SUFFIX => '.goto_notify');
 138     print $rand_fh "source:$source\ntarget:$target\nusr:$to\nsubject:".@{$msg_hash->{'subject'}}[0]."\nmessage:".@{$msg_hash->{'message'}}[0]."\n";
 139     close $rand_fh;
 140
 141     my $feedback = system("/usr/bin/goto-notify user-message '$to' '$subject' '$message' '$rand_file' &" );
 142
 143     return
 144 }
 145
 146
 147 ###############################################################################
 148 =over
 149
 150 =item B<trigger_action_localboot ($$)>
 151
 152 =over
 153
 154 =item description
 155
 156     Executes '/sbin/shutdown -r' if  no user is logged in otherwise write
 157     'trigger_action_localboot' to '/etc/gosa-si/event'
 158
 159 =item parameter
 160
 161     $msg - STRING - complete GOsa-si message
 162     $msg_hash - HASHREF - content of GOsa-si message in a hash
 163
 164 =item GOsa-si message xml content
 165
 166     <timeout> - INTEGER - timeout to wait befor restart, default 0
 167
 168 =item return
 169
 170     Nothing.
 171
 172 =back
 173
 174 =back
 175
 176 =cut
 177 ###############################################################################
 178 sub trigger_action_localboot {
 179     my ($msg, $msg_hash) = @_;
 180     my $timeout;
 181
 182         # Invalid timeout parameter are set to 0
 183     if((not exists $msg_hash->{timeout} ) || (1 != @{$msg_hash->{timeout}} ) ) {
 184         $timeout = -1;
 185     } else {
 186         $timeout = @{$msg_hash->{timeout}}[0];
 187     }
 188
 189         # Check if user should be notificated or not
 190         if ($userNotification eq "true") {
 191                 # Check logged in user
 192                 my @user_list = &get_logged_in_users;
 193                 if( @user_list >= 1 ) {
 194                         open(FILE, "> /etc/gosa-si/event");
 195                         print FILE "trigger_action_localboot\n";
 196                         close(FILE);
 197                 }
 198         }
 199     else {
 200         system( "/sbin/shutdown -r +$timeout &" );
 201     }
 202
 203     return;
 204 }
 205
 206
 207 ###############################################################################
 208 =over
 209
 210 =item B<trigger_action_faireboot ($$)>
 211
 212 =over
 213
 214 =item description
 215
 216     Executes '/usr/sbin/faireboot'.
 217
 218 =item parameter
 219
 220     $msg - STRING - complete GOsa-si message
 221     $msg_hash - HASHREF - content of GOsa-si message in a hash
 222
 223 =item GOsa-si message xml content
 224
 225     None.
 226
 227 =item return
 228
 229     Nothing.
 230
 231 =back
 232
 233 =back
 234
 235 =cut
 236 ###############################################################################
 237 sub trigger_action_faireboot {
 238     my ($msg, $msg_hash) = @_;
 239         &main::daemon_log("DEBUG: run /usr/sbin/faireboot\n", 7);
 240     system("/usr/sbin/faireboot");
 241     return;
 242 }
 243
 244
 245 ###############################################################################
 246 =over
 247
 248 =item B<trigger_action_reboot ($$)>
 249
 250 =over
 251
 252 =item description
 253
 254     Executes '/usr/bin/goto-notify reboot' and '/sbin/shutdown -r'  if  no
 255     user is logged in otherwise write 'reboot' to '/etc/gosa-si/event'
 256
 257 =item parameter
 258
 259     $msg - STRING - complete GOsa-si message
 260     $msg_hash - HASHREF - content of GOsa-si message in a hash
 261
 262 =item GOsa-si message xml content
 263
 264     <timeout> - INTEGER - timeout to wait befor reboot, default 0
 265
 266 =item return
 267
 268     Nothing.
 269
 270 =back
 271
 272 =back
 273
 274 =cut
 275 ###############################################################################
 276 sub trigger_action_reboot {
 277     my ($msg, $msg_hash) = @_;
 278     my $timeout;
 279
 280         # Invalid timeout parameter are set to 0
 281     if((not exists $msg_hash->{timeout} ) || (1 != @{$msg_hash->{timeout}} ) ) {
 282         $timeout = 0;
 283     }
 284     else {
 285         $timeout = @{$msg_hash->{timeout}}[0];
 286     }
 287
 288         # Check if user should be notificated or not
 289         if ($userNotification eq "true") {
 290                 # Check logged in user
 291                 my @user_list = &get_logged_in_users;
 292                 if( @user_list >= 1 ) {
 293                         system( "/usr/bin/goto-notify reboot" );
 294                         open(FILE, "> /etc/gosa-si/event");
 295                         print FILE "reboot\n";
 296                         close(FILE);
 297                 }
 298         }
 299     else {
 300         system( "/sbin/shutdown -r +$timeout &" );
 301     }
 302
 303     return;
 304 }
 305
 306
 307 ###############################################################################
 308 =over
 309
 310 =item B<trigger_action_halt ($$)>
 311
 312 =over
 313
 314 =item description
 315
 316     Executes '/usr/bin/goto-notify halt' and '/sbin/shutdown -h' if  no
 317     user is logged in otherwise write 'halt' to '/etc/gosa-si/event'
 318
 319 =item parameter
 320
 321     $msg - STRING - complete GOsa-si message
 322     $msg_hash - HASHREF - content of GOsa-si message in a hash
 323
 324 =item GOsa-si message xml content
 325
 326     <timeout> - INTEGER - timeout to wait befor halt, default 0
 327
 328 =item return
 329
 330     Nothing.
 331
 332 =back
 333
 334 =back
 335
 336 =cut
 337 ###############################################################################
 338 sub trigger_action_halt {
 339     my ($msg, $msg_hash) = @_;
 340     my $timeout;
 341
 342         # Invalid timeout parameter are set to 0
 343     if((not exists $msg_hash->{timeout} ) || (1 != @{$msg_hash->{timeout}} ) ) {
 344         $timeout = 0;
 345     }
 346     else {
 347         $timeout = @{$msg_hash->{timeout}}[0];
 348     }
 349
 350         # Check if user should be notificated or not
 351         if ($userNotification eq "true") {
 352                 # Check logged in user
 353                 my @user_list = &get_logged_in_users;
 354                 if( @user_list >= 1 ) {
 355                         system( "/usr/bin/goto-notify halt" );
 356                         open(FILE, "> /etc/gosa-si/event");
 357                         print FILE "halt\n";
 358                         close(FILE);
 359                 }
 360     } else {
 361         system( "/sbin/shutdown -h +$timeout &" );
 362     }
 363
 364     return;
 365 }
 366
 367
 368 ###############################################################################
 369 =over
 370
 371 =item B<trigger_action_reinstall>
 372
 373 =over
 374
 375 =item description
 376
 377     Executes '/usr/bin/goto-notify install' and '/sbin/shutdown -r now' if no
 378     user is logged in otherwise write 'install' to '/etc/gosa-si/event'
 379
 380 =item parameter
 381
 382     $msg - STRING - complete GOsa-si message
 383     $msg_hash - HASHREF - content of GOsa-si message in a hash
 384
 385 =item GOsa-si message xml content
 386
 387     None.
 388
 389 =item return
 390
 391     Nothing.
 392
 393 =back
 394
 395 =back
 396
 397 =cut
 398 ###############################################################################
 399 sub trigger_action_reinstall {
 400     my ($msg, $msg_hash) = @_;
 401
 402         # Check if user should be notificated or not
 403         if ($userNotification eq "true") {
 404                 # Check logged in user
 405                 my @user_list = &get_logged_in_users;
 406                 if( @user_list >= 1 ) {
 407                         system( "/usr/bin/goto-notify install" );
 408                         open(FILE, "> /etc/gosa-si/event");
 409                         print FILE "install\n";
 410                         close(FILE);
 411                 }
 412         } else {
 413                 system( "/sbin/shutdown -r now &" );
 414         }
 415
 416     return;
 417 }
 418
 419
 420 ###############################################################################
 421 =over
 422
 423 =item B<trigger_action_updae>
 424
 425 =over
 426
 427 =item description
 428
 429     Executes 'DEBIAN_FRONTEND=noninteractive /usr/sbin/fai-softupdate &'
 430
 431 =item parameter
 432
 433     $msg - STRING - complete GOsa-si message
 434     $msg_hash - HASHREF - content of GOsa-si message in a hash
 435
 436 =item GOsa-si message xml content
 437
 438     None.
 439
 440 =item return
 441
 442     Nothing
 443
 444 =back
 445
 446 =back
 447
 448 =cut
 449 ###############################################################################
 450 # Backward compatibility
 451 sub trigger_action_update {
 452     my ($msg, $msg_hash) = @_;
 453
 454     # Execute update
 455     system( "DEBIAN_FRONTEND=noninteractive /usr/sbin/fai-softupdate &" );
 456
 457     return;
 458 }
 459
 460
 461 ###############################################################################
 462 =over
 463
 464 =item B<trigger_action_instant_update ($$)>
 465
 466 =over
 467
 468 =item description
 469
 470     Executes 'DEBIAN_FRONTEND=noninteractive /usr/sbin/fai-softupdate &'
 471
 472 =item parameter
 473
 474     $msg - STRING - complete GOsa-si message
 475     $msg_hash - HASHREF - content of GOsa-si message in a hash
 476
 477 =item GOsa-si message xml content
 478
 479     None.
 480
 481 =item return
 482
 483     Nothing.
 484
 485 =back
 486
 487 =back
 488
 489 =cut
 490 ###############################################################################
 491 # Backward compatibility
 492 sub trigger_action_instant_update {
 493     my ($msg, $msg_hash) = @_;
 494
 495     # Execute update
 496     system( "DEBIAN_FRONTEND=noninteractive /usr/sbin/fai-softupdate &" );
 497
 498     return;
 499 }
 500
 501 sub trigger_goto_settings_reload {
 502     my ($msg, $msg_hash) = @_;
 503
 504     # Execute goto settings reload
 505     my $cmd = "/etc/init.d/goto-agents";
 506     my $pram = "start";
 507     if (-f $cmd){
 508         my $feedback = system("$cmd $pram") or &main::daemon_log("ERROR: $@");
 509     } else {
 510         &main::daemon_log("ERROR: cannot exec $cmd, file not found!");
 511     }
 512
 513     return;
 514 }
 515
 516
 517 1;