2.4.1.9 - Screenshots that fail to upload to an SFTP server will try to upload to the same SFTP server in the next capture cycle until the upload is successful.

Author: gavinkendall

ScreenCapture.cs

@@ -720,10 +720,14 @@ public Bitmap GetActiveWindowBitmap(int resolutionRatio, bool mouse)
                 int width = rect.Width - rect.X;
                 int height = rect.Height - rect.Y;
 
-                _log.WriteDebugMessage($"Attempting to capture active window image using width={width}, height={height}, resolutionRatio={resolutionRatio}, mouse={mouse}");
-
                 if (width > 0 && height > 0)
                 {
+                    // We don't need to log this message if the resolution ratio is 0 since if it is 0 then it's most likely a test of the screen capture method.
+                    if (resolutionRatio > 0)
+                    {
+                        _log.WriteDebugMessage($"Attempting to capture active window image using width={width}, height={height}, resolutionRatio={resolutionRatio}, mouse={mouse}");
+                    }
+
                     if (resolutionRatio < IMAGE_RESOLUTION_RATIO_MIN || resolutionRatio > IMAGE_RESOLUTION_RATIO_MAX)
                     {
                         resolutionRatio = 100;

changelog.txt

@@ -1,7 +1,7 @@
 Auto Screen Capture by Gavin Kendall
 
 
-2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle. New command "-restart". New macro tag "%capturenow%".
+2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle. New command "-restart". New macro tag "%capturenow%". Screenshots that fail to upload to an SFTP server will try to upload to the same SFTP server in the next capture cycle until the upload is successful.
 2.4.1.8    Delete Screenshots trigger uses ScreenshotsFolder instead of DefaultScreenshotsFolder. Sending a test email from Email Settings logs any exception error and the Send Test Email button is enabled again after an exception has been caught. Email Settings form accepts multiple email addresses in TO, CC, and BCC fields using either ; or , as a separator.
 2.4.1.7    Hash included in Screenshot Metadata. Additional debug logging has been included in the screen capture methods.
 2.4.1.6    $AppDataLocal$ and $AppDataRoaming$ introduced for autoscreen.conf and autoscreen.conf included as part of installation so that an installation of the application can run under normal user privileges without needing to run autoscreen.exe as Administrator from "C:\Program Files" or "C:\Program Files (x86)" since the data files are being written to the user's local or roaming app data folder (AppData\Local by default).

help/help-2.rtf

@@ -7699,7 +7699,7 @@ ad7bbdad7bbda57bbda57bbda57b000000040000002701ffff030000000000
 I love the Blade movies and I don't care what anyone says but the music in the "Bloodbath" nightclub scene of the first movie is still cool.\par
 The biggest feature implemented in 2.4 was the ability to encrypt and decrypt screenshots. The interface was cleaned up and more user-friendly notes were included. This version introduces the "Auto Adapt" feature for screens so that the position and size of each screen is automatically adjusted based on changes made to the display setup.\par
 Here's every change in the 2.4 "Blade" series (starting with the most recent change):\par
-\cf1\f1\fs19\lang1033 2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, \f2 Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle\f1 . New command "-restart". \f2 New macro tag "%capturenow%".\f1\par
+\cf1\f1\fs19\lang1033 2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, \f2 Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle\f1 . New command "-restart". \f2 New macro tag "%capturenow%".\f1  \f2 Screenshots that fail to upload to an SFTP server will try to upload to the same SFTP server \f1 in the next capture cycle\f2  \f1 until\f2  \f1 the upload is successful.\par
 2.4.1.8    \f2 Delete Screenshots trigger uses ScreenshotsFolder instead of DefaultScreenshotsFolder. Sending a test email from Email Settings logs any exception error and the Send Test Email button is enabled again after an exception has been caught. Email Settings form accepts multiple email addresses in TO, CC, and BCC fields using either ; or , as a separator.\f1\par
 2.4.1.7    \f2 Hash included in Screenshot Metadata. Additional debug logging has been included in the screen capture methods.\f1\lang9\par
 2.4.1.6    $AppDataLocal$ and $AppDataRoaming$ introduced for autoscreen.conf and autoscreen.conf included as part \lang1033 of \f2\lang9 installation so that an installation of the application can run under normal user privileges without needing to run autoscreen.exe as Administrator from "C:\\Program Files" or "C:\\Program Files (x86)" since the data files are being written to the user's local or roaming app data folder\f1\lang1033  (AppData\\Local by default)\f2\lang9 .\par

interface/main/FormMain-ScreenCapture.cs

@@ -425,7 +425,7 @@ private bool SaveScreenshot(Bitmap bitmap, object screenOrRegion)
         /// </summary>
         private void ScreenshotTakenWithSuccess()
         {
-            _log.WriteDebugMessage("Running triggers of condition type ScreenshotTaken");
+            _log.WriteDebugMessage("Running triggers of condition type AfterScreenshotTaken");
 
             RunTriggersOfConditionType(TriggerConditionType.AfterScreenshotTaken);
         }

interface/main/FormMain-Screenshots.cs

@@ -19,15 +19,20 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 //-----------------------------------------------------------------------
 using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.Diagnostics;
 using System.Drawing;
+using System.IO;
 using System.Windows.Forms;
 
 namespace AutoScreenCapture
 {
     public partial class FormMain : Form
     {
+        // A dictionary of failed uploads containing filepaths and hosts.
+        private Dictionary<string, string> _failedUploads = new Dictionary<string, string>();
+
         /// <summary>
         /// Saves screenshot references every five minutes (300000 milliseconds).
         /// </summary>
@@ -908,7 +913,7 @@ private bool EmailScreenshot(Screenshot screenshot, bool prompt)
                 }
                 else
                 {
-                    _log.WriteDebugMessage("Password = [I'm not going to log this so check the application settings file]");
+                    _log.WriteDebugMessage("Password = [I'm not revealing this here]");
                 }
 
                 string from = Settings.SMTP.GetByKey("EmailMessageFrom", _config.Settings.DefaultSettings.EmailMessageFrom).Value.ToString();
@@ -1090,7 +1095,7 @@ private bool FileTransferScreenshot(Screenshot screenshot)
                 }
                 else
                 {
-                    _log.WriteDebugMessage("Password = [I'm not going to log this so check the user settings file]");
+                    _log.WriteDebugMessage("Password = [I'm not revealing this here]");
                 }
 
                 if (string.IsNullOrEmpty(host) ||
@@ -1119,43 +1124,121 @@ private bool FileTransferScreenshot(Screenshot screenshot)
                     {
                         _log.WriteDebugMessage("Could not establish a connection with the file server");
 
+                        // Add the screenshot filepath and host to a dictionary of failed uploads so we'll attempt to upload the screenshot for that host later.
+                        if (!_failedUploads.ContainsKey(screenshot.Path))
+                        {
+                            _log.WriteDebugMessage($"Screenshot ({screenshot.Path}) has been added to the dictionary of failed uploads because a connection to the file server could not be established at this time so an attempt to retry the upload will occur in the next capture cycle");
+
+                            _failedUploads.Add(screenshot.Path, host);
+                        }
+
                         return false;
                     }
                 }
 
                 // Make sure we are connected to the file server. If we were not connected earlier then a connection request would have been sent prior to this check.
                 if (_sftpClient.IsConnected)
                 {
-                    string destinationPath = System.IO.Path.GetFileName(screenshot.Path);
-                    
-                    _log.WriteDebugMessage("Attempting to upload screenshot to file server");
-                    _log.WriteDebugMessage("Source: " + screenshot.Path);
-                    _log.WriteDebugMessage("Destination: " + destinationPath);
+                    // This is necessary since we are going to be removing entries from the _failedUploads dictionary while enumerating the collection
+                    // so instead of modifying the collection that we're enumerating it's better to simply enumerate over a copy of the filepaths.
+                    string[] pathsOfFailedUploads = new string[_failedUploads.Count];
+                    _failedUploads.Keys.CopyTo(pathsOfFailedUploads, 0);
 
-                    if (_sftpClient.UploadFile(screenshot.Path, destinationPath))
-                    {
-                        _log.WriteDebugMessage("Successfully uploaded screenshot");
-                    }
-                    else
+                    foreach (string path in pathsOfFailedUploads)
                     {
-                        _log.WriteDebugMessage("Failed to upload screenshot");
+                        if (_failedUploads.ContainsKey(path))
+                        {
+                            if (_failedUploads.TryGetValue(path, out string hostAssociatedWithPath))
+                            {
+                                _log.WriteDebugMessage($"Screenshot ({path}) was found in dictionary of failed uploads");
 
-                        return false;
+                                // Make sure that the host associated with the path is equal to the host we're currently handling
+                                // so we don't accidentally upload the screenshot to the wrong SFTP server just in case the user changes hosts.
+                                if (hostAssociatedWithPath.Equals(host))
+                                {
+                                    if (UploadScreenshot(host, path))
+                                    {
+                                        _log.WriteDebugMessage($"This screenshot previously failed to upload. It has now been successfully uploaded to {host}");
+                                    }
+                                }
+                                else
+                                {
+                                    _log.WriteDebugMessage($"This screenshot previously failed to upload. It could not be uploaded to {host} at the moment because the screenshot is intended for {hostAssociatedWithPath}");
+                                }
+                            }
+                        }
                     }
+
+                    // Upload the screenshot we're currently handling.
+                    return UploadScreenshot(host, screenshot.Path);
                 }
 
-                return true;
+                return false;
             }
             catch (Exception ex)
             {
                 _screenCapture.ApplicationError = true;
 
                 _log.WriteExceptionMessage("FormMain-Screenshots::FileTransferScreenshot", ex);
 
+                // We can't simply say that the SFTP client is now disconnected so we just need to nullify the SFTP client.
+                _sftpClient = null;
+
+                return false;
+            }
+        }
+
+        /// <summary>
+        /// Uploads a screenshot image file to the SFTP server given the provided local path of the screenshot.
+        /// </summary>
+        /// <param name="host">The hostname for the SFTP server.</param>
+        /// <param name="path">The filepath of the screenshot.</param>
+        /// <returns>True if the upload was successful. False if the upload failed.</returns>
+        private bool UploadScreenshot(string host, string path)
+        {
+            string destinationPath = Path.GetFileName(path);
+
+            _log.WriteDebugMessage("Attempting to upload screenshot to file server");
+            _log.WriteDebugMessage("Source: " + path);
+            _log.WriteDebugMessage("Destination: " + destinationPath);
+
+            if (_sftpClient.UploadFile(path, destinationPath))
+            {
+                _log.WriteDebugMessage("Successfully uploaded screenshot");
+
+                // Remove the path from the dictionary of failed uploads if we were successful in uploading the file to the SFTP server.
+                if (_failedUploads.ContainsKey(path))
+                {
+                    _log.WriteDebugMessage($"Screenshot ({path}) has been removed from the dictionary of failed uploads because the upload was successful");
+
+                    _failedUploads.Remove(path);
+                }
+            }
+            else
+            {
+                _log.WriteDebugMessage("Failed to upload screenshot");
+
+                // Add the screenshot filepath and host to a dictionary of failed uploads so we'll attempt to upload the screenshot later.
+                if (!_failedUploads.ContainsKey(path))
+                {
+                    _log.WriteDebugMessage($"Screenshot ({path}) has been added to the dictionary of failed uploads because the upload failed at this time so an attempt to retry the upload will occur in the next capture cycle");
+
+                    _failedUploads.Add(path, host);
+                }
+
+                // We can't simply say that the SFTP client is now disconnected so we just need to nullify the SFTP client.
+                _sftpClient = null;
+
                 return false;
             }
+
+            return true;
         }
 
+        /// <summary>
+        /// Uploads a screenshot to an SFTP server based on a trigger action type.
+        /// </summary>
+        /// <param name="triggerActionType">The trigger action type to use.</param>
         private void FileTransferScreenshot(TriggerActionType triggerActionType)
         {
             if (triggerActionType == TriggerActionType.FileTransferScreenshot && _screenCapture.Running)
@@ -1164,7 +1247,14 @@ private void FileTransferScreenshot(TriggerActionType triggerActionType)
 
                 if (lastScreenshotOfThisView != null && lastScreenshotOfThisView.Slide != null && !string.IsNullOrEmpty(lastScreenshotOfThisView.Path))
                 {
-                    FileTransferScreenshot(lastScreenshotOfThisView);
+                    if (FileTransferScreenshot(lastScreenshotOfThisView))
+                    {
+                        _log.WriteDebugMessage($"The screenshot ({lastScreenshotOfThisView.Path}) was successfully uploaded");
+                    }
+                    else
+                    {
+                        _log.WriteDebugMessage($"The screenshot ({lastScreenshotOfThisView.Path}) failed to upload");
+                    }
                 }
             }
         }

interface/trigger/FormTrigger.cs

@@ -999,7 +999,7 @@ private void ShowActionHelpText()
 
                 // DeleteScreenshotsFromOldestCaptureCycle
                 case 36:
-                    textBoxActionHelp.Text = "Delete screenshots from the oldest capture cycle. You can use this action to perform a rolling delete if you also set the Limit (in Setup) and use the Limit Reached condition. Run a screen capture session for a while first to define the required set of cycles and then trigger this action to start doing the rolling delete.";
+                    textBoxActionHelp.Text = "Delete screenshots from the oldest capture cycle. You can use this action to perform a rolling delete if you also use the After Screenshot Taken condition. Run a screen capture session for a while first to define the required set of cycles and then trigger this action to start doing the rolling delete.";
                     break;
             }
         }