FirefoxProfileManager.cs

// =============================================================================
// GPAL - Generally Positive Automation Library
// Copyright © 2026 Software Decisions, Inc. All rights reserved.
//
// This file is part of GPAL.
// Licensed under the Business Source License 1.1
//
// Primary development, architecture, and vision by Michael B. Vederman,
// CEO of Software Decisions, Inc., Texas.
//
// Internal development maintained privately.
// Public releases appear on GitHub: https://github.com/SoftwareDecisionsInc/GPAL.
//
// See LICENSE for full terms, including Additional Use Grant.
// =============================================================================
 
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using static GenerallyPositive.Enums;
 
namespace GenerallyPositive.Browser
{
    internal class FirefoxProfileManager
    {
        // generated by grok
        // to replace these geckodriver options
        /*
              // PDF handling
              if (browserSettings.OpenPDFExternally)
                  firefoxArguments.Add("--pdfjs.disabled");
 
              // Download settings
              if (!browserSettings.PromptForDownload)
                  firefoxArguments.Add($"--browser.helperApps.neverAsk.saveToDisk={GPAL.GPALSettings.FirefoxDirectDownloadMimeTypes}");
 
              if (!browserSettings.LoadImages)
                  firefoxArguments.Add("--permissions.default.image=0");
              else
                  firefoxArguments.Add("--permissions.default.image=1");
 
              if (!browserSettings.BlockPopUps)
                  firefoxArguments.Add("--dom.popup_maximum=0");
              else
                  firefoxArguments.Add("--dom.popup_maximum=20");
 
              firefoxArguments.Add("--safebrowsing.enabled=false");
 
              if (!string.IsNullOrEmpty(browserSettings.DownloadLocation))
              {
                  firefoxArguments.Add($"--browser.download.dir={browserSettings.DownloadLocation}");
                  firefoxArguments.Add("--browser.download.folderList=2");
              }
        */
        // the preferences GPAL sets from the workflow, so apply and restore cannot drift apart. firefox has no
        // json preferences file and no CDP, so these are the only way to say anything to it about downloads
        private static readonly string[] userJsPreferenceKeys =
        {
            "pdfjs.disabled",
            "browser.download.useDownloadDir",
            "browser.helperApps.neverAsk.saveToDisk",
            "browser.download.dir",
            "browser.download.folderList",
            "permissions.default.image",
            "dom.popup_maximum",
            "browser.safebrowsing.enabled",
            "extensions.enabled",
            "xpinstall.signatures.required",
            "dom.webdriver.enabled",
            "browser.startup.page",
            "browser.sessionstore.resume_from_crash",
        };

        private static Dictionary<string, string> ReadUserJs(string userJsPath)
        {
            Dictionary<string, string> retVal = new Dictionary<string, string>();
 
            if (true == File.Exists(userJsPath))
                foreach (string line in File.ReadAllLines(userJsPath))
                {
                    Match match = Regex.Match(line, @"user_pref\‍(""([^""]+)"",\s*(.+)\‍);");
 
                    if (true == match.Success)
                        retVal[match.Groups[1].Value] = match.Groups[2].Value.Trim();
                }
 
            return retVal;
        }

        private static void WriteUserJs(string userJsPath, Dictionary<string, string> preferences)
        {
            StringBuilder builder = new StringBuilder();
 
            foreach (KeyValuePair<string, string> preference in preferences.OrderBy(p => p.Key, StringComparer.Ordinal))
                builder.AppendLine($"user_pref(\"{preference.Key}\", {preference.Value});");
 
            File.WriteAllText(userJsPath, builder.ToString());
        }

        private static string AsJsString(string value)
        {
            string retVal = $"\"{value?.Replace("\\", "\\\\").Replace("\"", "\\\"")}\"";
 
            return retVal;
        }

        public static Dictionary<string, string> CreateUserJs(string profilePath, BrowserSettings browserSettings)
        {
            Dictionary<string, string> retVal = null;
            string userJsPath = Path.Combine(profilePath, "user.js");
 
            try
            {
                Dictionary<string, string> preferences = ReadUserJs(userJsPath);
 
                retVal = new Dictionary<string, string>();
                foreach (string key in userJsPreferenceKeys)
                    retVal[key] = preferences.ContainsKey(key) ? preferences[key] : null;
 
                // pdfjs is firefox's built in viewer. left on, a pdf is rendered and no download ever starts, so
                // there is nothing for the download watcher to see.
                // headless turns it off whatever the workflow asked, because there is nobody to render it for and
                // Get() sets OpenPDFExternally false for headless, which would otherwise switch the viewer back
                // on and leave every pdf displayed to no one instead of downloaded. chrome does not need saying
                // because a headless chrome cannot display a pdf and downloads it; firefox's viewer works headless
                preferences["pdfjs.disabled"] = browserSettings.OpenPDFExternally || browserSettings.UseHeadless ? "true" : "false";
 
                // false is firefox for "ask where to save every file", which is the save dialog
                preferences["browser.download.useDownloadDir"] = browserSettings.PromptForDownload ? "false" : "true";
                preferences["browser.helperApps.neverAsk.saveToDisk"] = true == browserSettings.PromptForDownload
                                                                      ? AsJsString("")
                                                                      : AsJsString(GPAL.GPALSettings.FirefoxDirectDownloadMimeTypes);
 
                preferences["permissions.default.image"] = browserSettings.LoadImages ? "1" : "0";
                // how many popups one event may open. zero is none, and twenty is what firefox ships with,
                // so blocking is the low number and the sense of this reads backwards
                preferences["dom.popup_maximum"] = browserSettings.BlockPopUps ? "0" : "20";
                preferences["browser.safebrowsing.enabled"] = "false";
 
                // 0 is a blank start. a workflow starts against the page it navigates to, not against whatever
                // was on screen when the browser last closed, and not against a crash restore prompt either.
                // geckodriver happens to leave these behind on a profile it has driven, which is not the same as
                // them being set
                preferences["browser.startup.page"] = "0";
                preferences["browser.sessionstore.resume_from_crash"] = "false";
 
                // enable and allow unsigned extensions - we will load magic off disk
                preferences["extensions.enabled"] = "true";
                preferences["xpinstall.signatures.required"] = "false";
                preferences["dom.webdriver.enabled"] = "false";
 
                if (false == string.IsNullOrEmpty(browserSettings.DownloadLocation))
                {
                    preferences["browser.download.dir"] = AsJsString(browserSettings.DownloadLocation);
                    preferences["browser.download.folderList"] = "2";   // 2: use the custom download directory
                }
                else
                {
                    // nothing was asked for, so the profile's own download directory is the right one and a
                    // directory left behind by an earlier run is not
                    preferences.Remove("browser.download.dir");
                    preferences.Remove("browser.download.folderList");
                }
 
                WriteUserJs(userJsPath, preferences);
            }
            catch (Exception ex)
            {
                retVal = null;
                GPAL.PublishSimpleEvent(GPALEventType.EXCEPTION, $"Could not write preferences into [{userJsPath}]", null, GPALObjectType.None, ex);
            }
 
            return retVal;
        }

        public static void RestoreUserJs(string profilePath, Dictionary<string, string> previous)
        {
            string userJsPath = null == previous ? null : Path.Combine(profilePath, "user.js");
 
            if (null == userJsPath || false == File.Exists(userJsPath))
                return;
 
            try
            {
                Dictionary<string, string> preferences = ReadUserJs(userJsPath);
 
                foreach (KeyValuePair<string, string> was in previous)
                    if (null == was.Value)
                        preferences.Remove(was.Key);      // it was not there before, so it goes back to not being there
                    else
                        preferences[was.Key] = was.Value;
 
                WriteUserJs(userJsPath, preferences);
            }
            catch (Exception ex)
            {
                GPAL.PublishSimpleEvent(GPALEventType.EXCEPTION, $"Could not restore preferences in [{userJsPath}]", null, GPALObjectType.None, ex);
            }
        }

        public static string CreateTempProfileDirectory()
        {
            // Get the system's %TEMP% directory
            string tempPath = Path.GetTempPath();
 
            // Generate a random string (e.g., 8 characters)
            string randomString = Guid.NewGuid().ToString("N").Substring(0, 8);
 
            // Create the directory name (e.g., rust_mozprofileXYZ123)
            string profileDirName = $"rust_mozprofile{randomString}";
 
            // Combine with %TEMP% to get the full path
            string profilePath = Path.Combine(tempPath, profileDirName);
 
            // Create the directory if it doesn't exist
            Directory.CreateDirectory(profilePath);
 
            return profilePath;
        }
    }
}