Skip to content

Commit 2302c21

Browse files
ivandroflyivandrofly
committed
Add analytics and reporting functionality
Introduced `AnalyticsService` for sending OS and activity data and `ReportService` for user feedback submissions. Added `ReportForm` UI to capture and send user reports. Updated necessary components and configurations to integrate these features.
1 parent e3e84ea commit 2302c21

File tree

9 files changed

+508
-6
lines changed

9 files changed

+508
-6
lines changed

‎source/HI2UC/EntryPoint.cs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
using System.IO;
55
using System.Reflection;
66
using System.Windows.Forms;
7+
using Nikse.SubtitleEdit.PluginLogic.Services;
78

89
namespace Nikse.SubtitleEdit.PluginLogic;
910

@@ -58,6 +59,15 @@ public string DoAction(Form parentForm, string srtText, double frame, string uiL
5859
// Load raws subtitle lines into Subtitle object
5960
srt.LoadSubtitle(sub, list, file);
6061

62+
// analytics
63+
64+
var analyticsService = new AnalyticsService();
65+
_ = analyticsService.SendAsync(new Data()
66+
{
67+
OsVersion = Environment.OSVersion.ToString(),
68+
LastActive = DateTimeOffset.Now
69+
}).ConfigureAwait(false);
70+
6171
IPlugin hi2Uc = this;
6272
using (var form = new PluginForm(sub, hi2Uc.Name, hi2Uc.Description))
6373
{

‎source/HI2UC/HI2UC.csproj‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,17 @@
1515
<AutoGen>True</AutoGen>
1616
<DependentUpon>Resources.resx</DependentUpon>
1717
</Compile>
18+
<Compile Update="ReportForm.cs">
19+
<SubType>Form</SubType>
20+
</Compile>
1821
</ItemGroup>
1922
<ItemGroup>
2023
<EmbeddedResource Update="Properties\Resources.resx">
2124
<Generator>ResXFileCodeGenerator</Generator>
2225
<LastGenOutput>Resources.Designer.cs</LastGenOutput>
2326
</EmbeddedResource>
2427
</ItemGroup>
28+
<ItemGroup>
29+
<Reference Include="System.Net.Http" />
30+
</ItemGroup>
2531
</Project>

‎source/HI2UC/PluginForm.cs‎

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
using Nikse.SubtitleEdit.PluginLogic.Converters.Strategies;
1010
using Nikse.SubtitleEdit.PluginLogic.Extensions;
1111
using Nikse.SubtitleEdit.PluginLogic.Models;
12+
using Nikse.SubtitleEdit.PluginLogic.Services;
1213

1314
namespace Nikse.SubtitleEdit.PluginLogic;
1415

@@ -55,7 +56,7 @@ public PluginForm(Subtitle subtitle, string name, string description)
5556
uncheckAllToolStripMenuItem.Click += (_, _) => listViewFixes.UncheckAll();
5657
invertCheckToolStripMenuItem.Click += (_, _) => listViewFixes.InvertCheck();
5758

58-
linkLabel1.DoubleClick += LinkLabel1_DoubleClick;
59+
linkLabel1.Click += LaunchReportWindow;
5960

6061
// force layout
6162
// ReSharper disable once VirtualMemberCallInConstructor
@@ -71,9 +72,29 @@ public PluginForm(Subtitle subtitle, string name, string description)
7172
pictureBoxDonate.Click += (_, _) => { Process.Start(StringUtils.DonateUrl); };
7273
}
7374

74-
private void LinkLabel1_DoubleClick(object sender, EventArgs e)
75+
private readonly ReportService _reportService = new();
76+
77+
private async void LaunchReportWindow(object sender, EventArgs e)
7578
{
76-
Process.Start("https://github.com/SubtitleEdit/plugins/issues/new");
79+
using (var reportForm = new ReportForm(_reportService))
80+
{
81+
if (reportForm.ShowDialog() == DialogResult.OK)
82+
{
83+
try
84+
{
85+
var report = new Report(reportForm.ReportMessage, _subtitle.ToText());
86+
if (await _reportService.ReportAsync(report).ConfigureAwait(false))
87+
{
88+
MessageBox.Show("Thank you for your report!");
89+
}
90+
}
91+
catch (Exception exception)
92+
{
93+
MessageBox.Show(exception.Message);
94+
}
95+
}
96+
}
97+
// Process.Start("https://github.com/SubtitleEdit/plugins/issues/new");
7798
}
7899

79100
private void UpdateUiFromConfigs(HiConfigs configs)
@@ -123,7 +144,7 @@ private void ApplyChanges()
123144
listViewFixes.BeginUpdate();
124145
foreach (var listViewItem in listViewFixes.Items.CheckItems())
125146
{
126-
var record = (Record) listViewItem.Tag;
147+
var record = (Record)listViewItem.Tag;
127148
record.Paragraph.Text = record.After;
128149
}
129150

@@ -208,7 +229,7 @@ private ICollection<ICasingConverter> GetConverters()
208229
return commands;
209230
}
210231

211-
private IConverterStrategy GetStrategy() => (IConverterStrategy) comboBoxStyle.SelectedItem;
232+
private IConverterStrategy GetStrategy() => (IConverterStrategy)comboBoxStyle.SelectedItem;
212233

213234
public void LoadConfigurations()
214235
{
@@ -232,7 +253,7 @@ public void LoadConfigurations()
232253

233254
private void copyToolStripMenuItem_Click(object sender, EventArgs e)
234255
{
235-
var text = ((Paragraph) listViewFixes.FocusedItem.Tag).ToString();
256+
var text = ((Paragraph)listViewFixes.FocusedItem.Tag).ToString();
236257
Clipboard.SetText(text, TextDataFormat.UnicodeText);
237258
}
238259

@@ -249,6 +270,7 @@ private void deleteLineToolStripMenuItem_Click(object sender, EventArgs e)
249270

250271
listViewFixes.Items.RemoveAt(index);
251272
}
273+
252274
listViewFixes.EndUpdate();
253275

254276
_subtitle.Renumber();

‎source/HI2UC/ReportForm.Designer.cs‎

Lines changed: 73 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎source/HI2UC/ReportForm.cs‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
using System.Windows.Forms;
2+
using Nikse.SubtitleEdit.PluginLogic.Services;
3+
4+
namespace Nikse.SubtitleEdit.PluginLogic;
5+
6+
public partial class ReportForm : Form
7+
{
8+
private readonly ReportService _reportService;
9+
10+
public string ReportMessage { get; set; }
11+
12+
public ReportForm(ReportService reportService)
13+
{
14+
InitializeComponent();
15+
StartPosition = FormStartPosition.CenterParent;
16+
17+
_reportService = reportService;
18+
buttonSubmit.DialogResult = DialogResult.OK;
19+
20+
Closing += (sender, args) => ReportMessage = textBox1.Text;
21+
}
22+
}

‎source/HI2UC/ReportForm.resx‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
</root>

0 commit comments

Comments
 (0)