Extract parent class from {FFmpeg,RAIntegration}DownloaderForm

Author: YoshiRulz

src/BizHawk.Client.EmuHawk/AVOut/FFmpegDownloaderForm.cs

@@ -1,164 +1,34 @@
-using System.Diagnostics;
 using System.IO;
-using System.Linq;
-using System.Net;
-using System.Threading;
-using System.Windows.Forms;
 
 using BizHawk.Common;
 
 namespace BizHawk.Client.EmuHawk
 {
-	/// <summary>
-	/// Downloads FFmpeg
-	/// </summary>
-	public partial class FFmpegDownloaderForm : Form
+	public sealed class FFmpegDownloaderForm : DownloaderForm
 	{
-		public FFmpegDownloaderForm()
-		{
-			_path = FFmpegService.FFmpegPath;
-			_url = FFmpegService.Url;
-
-			InitializeComponent();
-
-			txtLocation.Text = _path;
-			txtUrl.Text = _url;
-
-			if (OSTailoredCode.IsUnixHost) textBox1.Text = string.Join("\n", textBox1.Text.Split('\n').Take(3)) + "\n\n(Linux user: If installing manually, you can use a symlink.)";
-		}
-
-		private readonly string _path;
-		private readonly string _url;
-
-		private int _pct = 0;
-		private bool _exiting = false;
-		private bool _succeeded = false;
-		private bool _failed = false;
-
-		private void ThreadProc()
-		{
-			Download();
-		}
-
-		private void Download()
-		{
-			//the temp file is owned by this thread
-			var fn = TempFileManager.GetTempFilename("ffmpeg_download", ".7z", false);
-
-			try
-			{
-				DirectoryInfo parentDir = new(Path.GetDirectoryName(_path)!);
-				if (!parentDir.Exists) parentDir.Create();
-				// check writable before bothering with the download
-				if (File.Exists(_path)) File.Delete(_path);
-				using var fs = File.Create(_path);
-				using (var evt = new ManualResetEvent(false))
-				{
-					using var client = new WebClient();
-					ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
-					client.DownloadFileAsync(new Uri(_url), fn);
-					client.DownloadProgressChanged += (_, progressArgs) => _pct = progressArgs.ProgressPercentage;
-					client.DownloadFileCompleted += (_, _) => evt.Set(); // we don't really need a status, we'll just try to unzip it when it's done
-
-					while (true)
-					{
-						if (evt.WaitOne(10)) break;
-
-						//if the gui thread ordered an exit, cancel the download and wait for it to acknowledge
-						if (_exiting)
-						{
-							client.CancelAsync();
-							evt.WaitOne();
-							break;
-						}
-					}
-				}
+		protected override string ComponentName
+			=> "FFmpeg";
 
-//				throw new Exception("test of download failure");
+		protected override string DownloadTemp { get; }
+			= TempFileManager.GetTempFilename("ffmpeg_download", ".7z", delete: false);
 
-				//if we were ordered to exit, bail without wasting any more time
-				if (_exiting) return;
-
-				//try acquiring file
-				using (var hf = new HawkFile(fn))
-				{
-					using (var exe = OSTailoredCode.IsUnixHost ? hf.BindArchiveMember("ffmpeg") : hf.BindFirstOf(".exe"))
-					{
-						//last chance. exiting, don't dump the new ffmpeg file
-						if (_exiting) return;
-						exe!.GetStream().CopyTo(fs);
-						fs.Dispose();
-						if (OSTailoredCode.IsUnixHost)
-						{
-							OSTailoredCode.ConstructSubshell("chmod", $"+x {_path}", checkStdout: false).Start();
-							Thread.Sleep(50); // Linux I/O flush idk
-						}
-					}
-				}
-
-				//make sure it worked
-				if (!FFmpegService.QueryServiceAvailable()) throw new Exception("download failed");
-
-				_succeeded = true;
-			}
-			catch (Exception e)
-			{
-				_failed = true;
-				Util.DebugWriteLine($"FFmpeg download failed with:\n{e}");
-			}
-			finally
-			{
-				try
-				{
-					File.Delete(fn);
-				}
-				catch
-				{
-					// ignore
-				}
-			}
-		}
-
-		private void btnDownload_Click(object sender, EventArgs e)
-		{
-			btnDownload.Text = "Downloading...";
-			btnDownload.Enabled = false;
-			_failed = false;
-			_succeeded = false;
-			_pct = 0;
-			var t = new Thread(ThreadProc);
-			t.Start();
-		}
-
-		private void btnCancel_Click(object sender, EventArgs e)
-		{
-			Close();
-		}
-
-		protected override void OnClosed(EventArgs e)
+		public FFmpegDownloaderForm()
 		{
-			//inform the worker thread that it needs to try terminating without doing anything else
-			//(it will linger on in background for a bit til it can service this)
-			_exiting = true;
+			Description = "BizHawk relies on a specific version of FFmpeg. No other version will do. The wrong version will be ignored. There is no way to override this behavior."
+				+ "\n\nThe required version could not be found."
+				+ (OSTailoredCode.IsUnixHost
+					? "\n\n(Linux user: If installing manually, you can use a symlink.)"
+					: "\n\nUse this dialog to download it automatically, or download it yourself from the URL below and place it in the specified location.");
+			DownloadFrom = FFmpegService.Url;
+			DownloadTo = FFmpegService.FFmpegPath;
 		}
 
-		private void timer1_Tick(object sender, EventArgs e)
-		{
-			//if it's done, close the window. the user will be smart enough to reopen it
-			if (_succeeded) Close();
-			if (_failed)
-			{
-				_failed = false;
-				_pct = 0;
-				btnDownload.Text = "FAILED - Download Again";
-				btnDownload.Enabled = true;
-			}
-			progressBar1.Value = _pct;
-		}
+		protected override Stream GetExtractionStream(HawkFile downloaded)
+			=> (OSTailoredCode.IsUnixHost
+				? downloaded.BindArchiveMember("ffmpeg")!
+				: downloaded.BindFirstOf(".exe")).GetStream();
 
-		private void linkLabel1_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
-		{
-			Process.Start(_url);
-		}
+		protected override bool PostChmodCheck()
+			=> FFmpegService.QueryServiceAvailable();
 	}
 }