fix: Fix issues on proxy-server-plugin due to wrong support of long IPC messages

Author: g-bougard

Changes

@@ -6,6 +6,8 @@ core:
 * Parallel::ForkManager must not use more than 60 workers on MSWin32 due to a
   perl limitation on this operating system
 * Refacto events management to permit a task to trigger another one
+* IPC long messages only have size limitation on windows
+* Add new IPC message type to handle too long IPC_EVENT messages on windows
 
 inventory:
 * Fix network default route discovery on linux
@@ -51,6 +53,9 @@ deploy:
 * Force agent to run a partial software inventory after the deploy task is done
   if this has been set as a requirement in any job sent by the server
 
+proxy-server-plugin:
+* Fix issues due to wrong support of long IPC messages
+
 toolbox:
 * fix #532: Make libssh2 use the right place when looking for known_hosts file
   on windows

lib/GLPI/Agent/Daemon.pm

@@ -12,10 +12,13 @@ use Time::HiRes qw(usleep);
 # By convention, we just use 5 chars string as possible internal IPC messages.
 # IPC_LEAVE from children is supported and is only really useful while debugging.
 # IPC_EVENT can be used to handle events recognized in parent
+# IPC_EFILE can be used to handle events recognized in parent and is used on MSWin32
+#           when transmitted event is too big for IPC
 # IPC_ABORT can be used to abort a forked process
 use constant IPC_LEAVE  => 'LEAVE';
 use constant IPC_EVENT  => 'EVENT';
 use constant IPC_ABORT  => 'ABORT';
+use constant IPC_EFILE  => 'EFILE';
 
 use parent 'GLPI::Agent';
 
@@ -467,6 +470,27 @@ sub handleChildren {
                         push @messages, $event
                             if $child->{in}->sysread($event, $len);
                     }
+                } elsif ($msg eq IPC_EFILE) {
+                    my $len;
+                    $len = unpack("S", $len)
+                        if $child->{in}->sysread($len, 2);
+                    if ($len>2) {
+                        my ($event, $size, $file);
+                        $size = unpack("S", $size)
+                            if $child->{in}->sysread($size, 2);
+                        if ($child->{in}->sysread($file, $len-2)) {
+                            $event = GLPI::Agent::Tools::Win32::readEventFile($file, $size);
+                            if (!defined($event) || length($event) != $size) {
+                                # Limit log rate of IPC_EVENT event read failure from IPC_EFILE
+                                if (!$self->{_efile_logger_failure_timeout} || time > $self->{_efile_logger_failure_timeout}) {
+                                    $self->{logger}->debug2($child->{name} . "[$pid] failed to read IPC_EVENT from $file file");
+                                    $self->{_efile_logger_failure_timeout} = time + 5;
+                                }
+                            } else {
+                                push @messages, $event;
+                            }
+                        }
+                    }
                 }
             }
             $count++;
@@ -641,13 +665,18 @@ sub forked_process_event {
 
     return unless length($event);
     # On MSWin32, syswrite can block if header+size+event is greater than 512 bytes
-    if (length($event) > 505) {
+    if (length($event) > 505 && $OSNAME eq 'MSWin32') {
         my ($type) = split(",", $event)
             or return;
         $type = substr($event, 0, 64) if length($type) > 64;
         # Just ignore too big logger event like full inventory content logged at debug2 level
         return if $type eq 'LOGGER';
-        $self->{logger}->error("Skipping $type too long forked process event");
+
+        # Convert event to efile: event content in a file
+        my $file = GLPI::Agent::Tools::Win32::getEventFile($self->{vardir}, $event);
+        my $efile = pack("S", length($event)).$file;
+        $self->{_ipc_out}->syswrite(IPC_EFILE.pack("S", length($efile)).$efile);
+        GLPI::Agent::Tools::Win32::setPoller($self->{_ipc_pollin});
         return;
     }
 

lib/GLPI/Agent/Tools/Win32.pm

@@ -565,7 +565,7 @@ sub runPowerShell {
         SUFFIX      => '.ps1'
     );
     print $fh $script;
-    close( $fh);
+    close $fh;
     my $file = $fh->filename;
     return unless $file && -f $file;
 
@@ -1115,6 +1115,35 @@ sub getPoller {
     return $poller->down_nb();
 }
 
+sub getEventFile {
+    my ($folder, $event) = @_;
+
+    my $template = "efile-XXXXXXXXXXX";
+    my ($fh, $filename) = File::Temp::tempfile($template, DIR => $folder, SUFFIX => '.evt');
+    binmode($fh);
+    print $fh $event;
+    close $fh;
+
+    return $filename;
+}
+
+sub readEventFile {
+    my ($file, $size) = @_;
+
+    return unless -e $file && $size > 0;
+
+    my $event;
+    if (open my $fh, "<", $file) {
+        binmode($fh);
+        read($fh, $event, $size);
+        close $fh;
+    }
+
+    unlink $file;
+
+    return $event;
+}
+
 sub getFormatedWMIDateTime {
     my ($datetime) = @_;