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