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