properly communicate a fwe failure reasons in the fax list

pschichtel · Oct 25, 2020 · 5977d04 · 5977d04
1 parent 5d3b459
commit 5977d04
Show file tree

Hide file tree

Showing 6 changed files with 132 additions and 6 deletions.
diff --git a/Core/Core/Sipgate/FaxScheduler.cs b/Core/Core/Sipgate/FaxScheduler.cs
@@ -116,6 +116,7 @@ private async void _pollFaxStatus(TrackedFax fax)
                         fax.ChangeStatus(FaxStatus.SuccessfullySent);
                         break;
                     case FaxEntryStatus.Failed:
+                        fax.FailureCause = new FaxSendException(historyEntry.Status);
                         fax.ChangeStatus(FaxStatus.Failed);
                         break;
                     case FaxEntryStatus.Sending:
@@ -204,4 +205,14 @@ public static bool CanResend(this FaxStatus status)
             }
         }
     }
+
+    public class FaxSendException : Exception
+    {
+        public EntryStatus Status { get; }
+
+        public FaxSendException(EntryStatus status) : base($"Final status of fax: {status}")
+        {
+            Status = status;
+        }
+    }
 }
diff --git a/GUI/FaxListItem.xaml.cs b/GUI/FaxListItem.xaml.cs
@@ -1,8 +1,10 @@
 using System;
+using System.Net;
 using System.Windows;
 using NLog;
 using SipgateVirtualFax.Core;
 using SipgateVirtualFax.Core.Sipgate;
+using static SipGateVirtualFaxGui.Properties.Resources;
 using MessageBox = System.Windows.MessageBox;
 
 namespace SipGateVirtualFaxGui
@@ -32,7 +34,7 @@ private void OpenPdf_OnClick(object sender, RoutedEventArgs ev)
             catch (Exception e)
             {
                 _logger.Error(e, "Failed to open a fax document!");
-                MessageBox.Show(Properties.Resources.Err_FailedToOpenDocument);
+                MessageBox.Show(Err_FailedToOpenDocument);
             }
         }
     }
@@ -53,16 +55,33 @@ public string Status
             {
                 return Fax.Status switch
                 {
-                    FaxStatus.Pending => Properties.Resources.Status_Pending,
-                    FaxStatus.Sending => Properties.Resources.Status_Sending,
-                    FaxStatus.SuccessfullySent => Properties.Resources.Status_SuccessfullySent,
-                    FaxStatus.Failed => Properties.Resources.Status_Failed,
-                    FaxStatus.Unknown => Properties.Resources.Status_Unknown,
+                    FaxStatus.Pending => Status_Pending,
+                    FaxStatus.Sending => Status_Sending,
+                    FaxStatus.SuccessfullySent => Status_SuccessfullySent,
+                    FaxStatus.Failed => FailedStatusText(Fax.FailureCause),
+                    FaxStatus.Unknown => Status_Unknown,
                     _ => "???"
                 };
             }
         }
 
+        private static string FailedStatusText(Exception? cause)
+        {
+            if (cause != null)
+            {
+                switch (cause)
+                {
+                    case FaxSendException e when e.Status == HistoryEntry.EntryStatus.NoPickup:
+                        return string.Format(Status_FailedWithReason, Status_FailedNoPickup);
+                    case FaxSendException e when e.Status == HistoryEntry.EntryStatus.Busy:
+                        return string.Format(Status_FailedWithReason, Status_FailedBusy);
+                    case SipgateApiHttpException e when e.Status == HttpStatusCode.ProxyAuthenticationRequired:
+                        return string.Format(Status_FailedWithReason, Status_FailedInvalidDestination);
+                }
+            }
+            return Status_Failed;
+        }
+
         private TrackedFax ConfigureFax(TrackedFax fax)
         {
             fax.StatusChanged += (sender, status) =>

diff --git a/GUI/Properties/Resources.Designer.cs b/GUI/Properties/Resources.Designer.cs
diff --git a/GUI/Properties/Resources.de.Designer.cs b/GUI/Properties/Resources.de.Designer.cs
diff --git a/GUI/Properties/Resources.de.resx b/GUI/Properties/Resources.de.resx
@@ -121,4 +121,16 @@
     <data name="Err_TwainFailedToCloseSession" xml:space="preserve">
         <value>Die Verbindung zum Scanner-Subsystem konnte nicht geschlossen werden! Möglicherweise war der Scan trotzdem erfolgreich.</value>
     </data>
+    <data name="Status_FailedWithReason" xml:space="preserve">
+        <value>Senden fehlgeschlagen: {0}</value>
+    </data>
+    <data name="Status_FailedNoPickup" xml:space="preserve">
+        <value>Empfänger hat nicht abgehoben.</value>
+    </data>
+    <data name="Status_FailedBusy" xml:space="preserve">
+        <value>Empfänger ist besetzt.</value>
+    </data>
+    <data name="Status_FailedInvalidDestination" xml:space="preserve">
+        <value>Empfänger ist ungültig.</value>
+    </data>
 </root>
diff --git a/GUI/Properties/Resources.resx b/GUI/Properties/Resources.resx
@@ -121,4 +121,16 @@
     <data name="Err_TwainUnknown" xml:space="preserve">
         <value>An unknown scanning related error occurred. Please report this to the developer!</value>
     </data>
+    <data name="Status_FailedWithReason" xml:space="preserve">
+        <value>Sending failed: {0}</value>
+    </data>
+    <data name="Status_FailedNoPickup" xml:space="preserve">
+        <value>Recipient did not pick up.</value>
+    </data>
+    <data name="Status_FailedBusy" xml:space="preserve">
+        <value>Recipient is busy.</value>
+    </data>
+    <data name="Status_FailedInvalidDestination" xml:space="preserve">
+        <value>Recipient is invalid.</value>
+    </data>
 </root>