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