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