Added a "Give Feedback" dialog box

DistFiles/ReleaseNotes.md

@@ -39,6 +39,7 @@ the recorded files to that format, if necessary.
 ## _VERSION_ (_DATE_)
 - Improvements related to opening a clip for editing in an external program.
 - Updated localizations.
+- Added Give Feedback capability
 
 ## 3.5.3 (March 2025)
 - Fixed bug affecting Glyssenscript projects when extra clips are present.

HearThis.sln.DotSettings

@@ -2,6 +2,7 @@
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=LCS/@EntryIndexedValue">LCS</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=MVP/@EntryIndexedValue">MVP</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=OT/@EntryIndexedValue">OT</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=RTF/@EntryIndexedValue">RTF</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=TOC/@EntryIndexedValue">TOC</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UDP/@EntryIndexedValue">UDP</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UI/@EntryIndexedValue">UI</s:String>

src/HearThis/GiveFeedbackViewModel.cs

@@ -0,0 +1,188 @@
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+using System.Windows.Forms;
+using System.Diagnostics;
+
+namespace HearThis
+{
+	public enum TypeOfFeedback
+	{
+		Problem = 0,
+		Suggestion = 1,
+		Appreciation = 2,
+		Donate = 3
+	}
+
+	public enum ProblemSeverity
+	{
+		LostData,
+		Blocker,
+		Major,
+		Minor
+	}
+
+	public enum Area
+	{
+		NotApplicable,
+		DataSharing,
+		Exporting,
+		Android,
+		Installation,
+		Localization,
+		Multiple,
+		Navigation,
+		Other,
+		Playback,
+		ProjectAdministration,
+		ProjectSelection,
+		Recording,
+		Settings,
+		Website,
+		Unknown
+	}
+
+	public class GiveFeedbackViewModel
+	{
+		public string Title { get; set; }
+		public TypeOfFeedback Type { get; set; }
+		public ProblemSeverity Severity { get; set; }
+		public string DescriptionAsRTF { get; set; }
+		public Area AffectedArea { get; set; }
+		public string AffectedProject { get; set; }
+		public string WebsiteUrl { get; set; }
+		public Form MainForm { get; }
+		public string PathToLastClip { get; }
+		public string MainFormWindowTitle => MainForm.Text;
+		public bool IncludeScreenShot { get; set; }
+		public bool IncludeLastClip { get; set; }
+		public bool IncludeLogFile { get; set; }
+
+		public GiveFeedbackViewModel(Form mainForm, string pathToLastClip)
+		{
+			MainForm = mainForm;
+			PathToLastClip = pathToLastClip;
+		}
+
+		public void GoToCommunitySite()
+		{
+			Process.Start($"https://{Program.kSupportUrlSansHttps}");
+		}
+
+		public void IssueFeedback()
+		{
+			switch (Type)
+			{
+				case TypeOfFeedback.Problem:
+					if (ReportProblemViaRestApi())
+						return;
+					break;
+
+				case TypeOfFeedback.Donate:
+					Process.Start("https://donate.givedirect.org/?cid=13536&n=289");
+					break;
+			}
+		}
+
+		private byte[] Screenshot()
+		{
+			return null;
+		}
+
+		private bool ReportProblemViaRestApi()
+		{
+			// https://www.educative.io/answers/how-to-create-a-json-string-in-c-sharp
+			// https://docs.atlassian.com/software/jira/docs/api/REST/8.22.6/#issue-getEditIssueMeta
+			// https://jira.sil.org/rest/api/latest/issue/createmeta/HT/issuetypes
+			return false;
+		}
+	}
+
+	// Root myDeserializedClass = JsonConvert.DeserializeObject<Root>(myJsonResponse);
+
+    public class Component
+    {
+        public string id { get; set; }
+    }
+
+    public class Content
+    {
+        public string type { get; set; }
+        public List<Content> content { get; set; }
+        public string text { get; set; }
+    }
+
+    public class Description
+    {
+        public string type { get; set; }
+        public int version { get; set; }
+        public List<Content> content { get; set; }
+    }
+
+    public class SystemEnvironment
+    {
+        public string type { get; set; }
+        public int version { get; set; }
+        public List<Content> content { get; set; }
+    }
+
+    public class Fields
+    {
+        public string summary { get; set; }
+        public Issuetype issuetype { get; set; }
+        public List<Component> components { get; set; }
+        public JiraProject project { get; set; }
+        public Description description { get; set; }
+        public Reporter reporter { get; set; }
+        public Priority priority { get; set; }
+        public List<string> labels { get; set; }
+        public Security security { get; set; }
+        public SystemEnvironment environment { get; set; }
+        public List<HtVersion> versions { get; set; }
+    }
+
+    public class Issuetype
+    {
+		[JsonPropertyName("id")]
+        public string Id { get; set; }
+    }
+
+    public class Priority
+    {
+		[JsonPropertyName("id")]
+        public string Id { get; set; }
+    }
+
+    public class JiraProject
+    {
+	    [JsonPropertyName("id")]
+	    public string Id => "HT";
+    }
+
+    public class Reporter
+    {
+		[JsonPropertyName("id")]
+        public string Id { get; set; }
+    }
+
+    public class Root
+    {
+        public Update update { get; set; }
+        public Fields fields { get; set; }
+    }
+
+    public class Security
+    {
+		[JsonPropertyName("id")]
+        public string Id { get; set; }
+    }
+
+    public class Update
+    {
+    }
+
+    public class HtVersion
+    {
+		[JsonPropertyName("id")]
+        public string Id { get; set; }
+    }
+}

src/HearThis/HearThis.csproj

@@ -10,7 +10,7 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>HearThis</RootNamespace>
     <AssemblyName>HearThis</AssemblyName>
-    <TargetFramework>NET472</TargetFramework>
+    <TargetFramework>net472</TargetFramework>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
     <FileAlignment>512</FileAlignment>
     <ApplicationIcon>UI\HearThis.ico</ApplicationIcon>
@@ -181,6 +181,9 @@
       <AutoGen>True</AutoGen>
       <DependentUpon>Settings.settings</DependentUpon>
     </Compile>
+    <Compile Update="UI\GiveFeedbackDlg.cs">
+      <SubType>Form</SubType>
+    </Compile>
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Update="Properties\Resources.resx">
@@ -193,13 +196,6 @@
       <_Parameter1>HearThisTests</_Parameter1>
     </AssemblyAttribute>
   </ItemGroup>
-  <ItemGroup>
-    <Compile Update="Properties\Resources.Designer.cs">
-      <DesignTime>True</DesignTime>
-      <AutoGen>True</AutoGen>
-      <DependentUpon>Resources.resx</DependentUpon>
-    </Compile>
-  </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Update="Properties\Resources.resx">
       <Generator>ResXFileCodeGenerator</Generator>

src/HearThis/Program.cs

@@ -150,6 +150,7 @@ private static void Main(string[] args)
 
 			SetUpErrorHandling();
 			Logger.Init();
+			LogProductInfo();
 			SettingsProtectionSingleton.ProductSupportUrl = kSupportUrlSansHttps;
 			SetupLocalization();
 
@@ -294,6 +295,15 @@ private static void Main(string[] args)
 			}
 		}
 
+		private static void LogProductInfo()
+		{
+			var asm = Assembly.GetExecutingAssembly();
+			var ver = asm.GetName().Version;
+			var file = asm.CodeBase.Replace("file:", string.Empty).TrimStart('/');
+			var date = new FileInfo(file).LastWriteTime.ToString("dd-MMM-yyyy");
+			Logger.WriteEvent($"{kProduct} version {ver}    Built on {date}");
+		}
+
 		public static bool RestartedToChangeColorScheme { get; private set; }
 
 		public static IEnumerable<ErrorMessageInfo> CompatibleParatextProjectLoadErrors => ScrTextCollection.ErrorMessages.Where(e => e.ProjecType != ProjectType.Resource && !e.ProjecType.IsNoteType());

src/HearThis/Script/Project.cs

@@ -416,6 +416,8 @@ public IScrProjectSettings ScrProjectSettings
 		public int TotalCountOfBlocksAndExtraClipsForChapter =>
 			LineCountForChapter + ExtraRecordings.Count;
 
+		public string PathToLastClipRecorded { get; private set; }
+
 		public bool HasRecordedClip(int line)
 		{
 			if (line >= LineCountForChapter)
@@ -713,6 +715,7 @@ private List<ScriptLine> GetRecordableBlocksUpThroughHole(IEnumerable<int> indic
 		public void HandleSoundFileCreated()
 		{
 			var clipPath = GetPathToRecordingForSelectedLine();
+			PathToLastClipRecorded = clipPath;
 			// Getting this into a local variable is not only more efficient, it also
 			// prevents an annoying problem when working with the sample project, whereby
 			// re-getting the current script line loses information that has not yet been saved.