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