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