Implemented simple update progress

Author: bitbeans

src/CleanBrowsingClient/CleanBrowsingClient.csproj

@@ -53,6 +53,7 @@
     <PackageReference Include="System.ServiceProcess.ServiceController" Version="4.6.0" />
     <PackageReference Include="System.Text.Encoding.Extensions" Version="4.3.0" />
     <PackageReference Include="System.Threading" Version="4.3.0" />
+    <PackageReference Include="YamlDotNet" Version="8.0.0" />
   </ItemGroup>
   <ItemGroup>
     <None Update="dnscrypt-proxy\LICENSE">

src/CleanBrowsingClient/Config/Global.cs

@@ -9,10 +9,21 @@ public static class Global
         /// </summary>
         public const string ApplicationName = "Clean Browsing Client";
 
+        /// <summary>
+	    ///     Name of the company.
+	    /// </summary>
         public const string CompanyName = "cleanbrowsing.org";
 
+        /// <summary>
+        ///     First year of copyright.
+        /// </summary>
         public const int CopyrightYear = 2019;
 
+        /// <summary>
+	    ///     Remote URI where the application will find the update informations.
+	    /// </summary>
+        public const string RemoteUpdateCheckUrl = "https://raw.githubusercontent.com/bitbeans/CleanBrowsingClient/master/update.yml";
+
         /// <summary>
         ///     The name of the application configuration file.
         /// </summary>
@@ -33,13 +44,39 @@ public static class Global
         /// </summary>
         public const string DnsCryptConfigurationFile = "dnscrypt-proxy.toml";
 
+        /// <summary>
+        ///     Name of the family filter key.
+        /// </summary>
         public const string DefaultFamilyFilterKey = "cleanbrowsing-family";
+
+        /// <summary>
+        ///     Default family filter stamp.
+        /// </summary>
         public const string DefaultFamilyFilterStamp = "sdns://AQMAAAAAAAAAFDE4NS4yMjguMTY4LjE2ODo4NDQzILysMvrVQ2kXHwgy1gdQJ8MgjO7w6OmflBjcd2Bl1I8pEWNsZWFuYnJvd3Npbmcub3Jn";
+
+        /// <summary>
+        ///     Name of the adult filter key.
+        /// </summary>
         public const string DefaultAdultFilterKey = "cleanbrowsing-adult";
+
+        /// <summary>
+        ///     Default adult filter stamp.
+        /// </summary>
         public const string DefaultAdultFilterStamp = "sdns://AQMAAAAAAAAAEzE4NS4yMjguMTY4LjEwOjg0NDMgvKwy-tVDaRcfCDLWB1AnwyCM7vDo6Z-UGNx3YGXUjykRY2xlYW5icm93c2luZy5vcmc";
+
+        /// <summary>
+        ///     Name of the custom filter key.
+        /// </summary>
         public const string DefaultCustomFilterKey = "cleanbrowsing-custom";
 
+        /// <summary>
+        ///     String to validate DoH stamps.
+        /// </summary>
         public const string ValidCleanBrowsingDohStamp = "doh.cleanbrowsing.org";
+
+        /// <summary>
+        ///     String to validate DnsCrypt stamps.
+        /// </summary>
         public const string ValidCleanBrowsingDnsCryptStamp = "cleanbrowsing.org";
 
         /// <summary>
@@ -67,11 +104,11 @@ public static class Global
         /// </summary>
         public const int ServiceInstallTime = 3000;
 
+        /// <summary>
+        ///     Default log level.
+        /// </summary>
         public const LogEventLevel DefaultLogEventLevel = LogEventLevel.Information;
 
-        public const string DefaultResolverIpv4 = "127.0.0.1:53";
-        public const string DefaultResolverIpv6 = "[::1]:53";
-
         /// <summary>
         ///     List of files must exist.
         /// </summary>

src/CleanBrowsingClient/Helper/HttpClientDownloadWithProgress.cs

@@ -0,0 +1,94 @@
+using System;
+using System.IO;
+using System.Net.Http;
+using System.Threading.Tasks;
+
+namespace CleanBrowsingClient.Helper
+{
+    public class HttpClientDownloadWithProgress : IDisposable
+    {
+        private readonly string _downloadUrl;
+        private readonly string _destinationFilePath;
+
+        private HttpClient _httpClient;
+
+        public delegate void ProgressChangedHandler(long? totalFileSize, long totalBytesDownloaded, double? progressPercentage);
+
+        public event ProgressChangedHandler ProgressChanged;
+
+        public HttpClientDownloadWithProgress(string downloadUrl, string destinationFilePath)
+        {
+            _downloadUrl = downloadUrl;
+            _destinationFilePath = destinationFilePath;
+        }
+
+        public HttpClientDownloadWithProgress(Uri downloadUrl, string destinationFilePath)
+        {
+            _downloadUrl = downloadUrl.ToString();
+            _destinationFilePath = destinationFilePath;
+        }
+
+        public async Task StartDownload()
+        {
+            _httpClient = new HttpClient { Timeout = TimeSpan.FromDays(1), DefaultRequestVersion = new Version(2, 0) };
+            using var response = await _httpClient.GetAsync(_downloadUrl, HttpCompletionOption.ResponseHeadersRead);
+            await DownloadFileFromHttpResponseMessage(response);
+        }
+
+        private async Task DownloadFileFromHttpResponseMessage(HttpResponseMessage response)
+        {
+            response.EnsureSuccessStatusCode();
+
+            var totalBytes = response.Content.Headers.ContentLength;
+
+            using var contentStream = await response.Content.ReadAsStreamAsync();
+            await ProcessContentStream(totalBytes, contentStream);
+        }
+
+        private async Task ProcessContentStream(long? totalDownloadSize, Stream contentStream)
+        {
+            var totalBytesRead = 0L;
+            var readCount = 0L;
+            var buffer = new byte[8192];
+            var isMoreToRead = true;
+
+            using var fileStream = new FileStream(_destinationFilePath, FileMode.Create, FileAccess.Write, FileShare.None, 8192, true);
+            do
+            {
+                var bytesRead = await contentStream.ReadAsync(buffer, 0, buffer.Length);
+                if (bytesRead == 0)
+                {
+                    isMoreToRead = false;
+                    TriggerProgressChanged(totalDownloadSize, totalBytesRead);
+                    continue;
+                }
+
+                await fileStream.WriteAsync(buffer, 0, bytesRead);
+
+                totalBytesRead += bytesRead;
+                readCount += 1;
+
+                if (readCount % 100 == 0)
+                    TriggerProgressChanged(totalDownloadSize, totalBytesRead);
+            }
+            while (isMoreToRead);
+        }
+
+        private void TriggerProgressChanged(long? totalDownloadSize, long totalBytesRead)
+        {
+            if (ProgressChanged == null)
+                return;
+
+            double? progressPercentage = null;
+            if (totalDownloadSize.HasValue)
+                progressPercentage = Math.Round((double)totalBytesRead / totalDownloadSize.Value * 100, 2);
+
+            ProgressChanged(totalDownloadSize, totalBytesRead, progressPercentage);
+        }
+
+        public void Dispose()
+        {
+            _httpClient?.Dispose();
+        }
+    }
+}

src/CleanBrowsingClient/Models/Update.cs

@@ -0,0 +1,57 @@
+using System;
+
+namespace CleanBrowsingClient.Models
+{
+    /// <summary>
+	///     Outer remote update class.
+	/// </summary>
+	public class RemoteUpdate
+    {
+        /// <summary>
+        ///     Indicates if the requested update can be done.
+        /// </summary>
+        public bool CanUpdate { get; set; }
+
+        /// <summary>
+        ///     The update data.
+        /// </summary>
+        public Update Update { get; set; }
+    }
+
+    /// <summary>
+	///     The update data.
+	/// </summary>
+	public class Update
+    {
+        /// <summary>
+        ///     The available version.
+        /// </summary>
+        public Version Version { get; set; }
+
+        /// <summary>
+        ///     The date of this release.
+        /// </summary>
+        public DateTime Release { get; set; }
+
+        /// <summary>
+        ///     The installer object.
+        /// </summary>
+        public Installer Installer { get; set; }
+    }
+
+    /// <summary>
+	///     The installer information.
+	/// </summary>
+	public class Installer
+    {
+        /// <summary>
+        ///     Name of the installer file.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        ///     Uri to download the installer file.
+        /// </summary>
+        public Uri Uri { get; set; }
+    }
+}