FirefoxProfileManager.cs

// <copyright file="FirefoxProfileManager.cs" company="Selenium Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
// </copyright>

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.IO;
using OpenQA.Selenium.Firefox.Internal;

namespace OpenQA.Selenium.Firefox;

/// <summary>
/// Allows the user to enumerate and access existing named Firefox profiles.
/// </summary>
public class FirefoxProfileManager
{
    private readonly Dictionary<string, string> profiles = new Dictionary<string, string>();

    /// <summary>
    /// Initializes a new instance of the <see cref="FirefoxProfileManager"/> class.
    /// </summary>
    public FirefoxProfileManager()
    {
        string appDataDirectory = GetApplicationDataDirectory();
        this.ReadProfiles(appDataDirectory);
    }

    /// <summary>
    /// Gets a <see cref="ReadOnlyCollection{T}"/> containing <see cref="FirefoxProfile">FirefoxProfiles</see>
    /// representing the existing named profiles for Firefox.
    /// </summary>
    public ReadOnlyCollection<string> ExistingProfiles => new List<string>(this.profiles.Keys).AsReadOnly();

    /// <summary>
    /// Gets a <see cref="FirefoxProfile"/> with a given name.
    /// </summary>
    /// <param name="profileName">The name of the profile to get.</param>
    /// <returns>A <see cref="FirefoxProfile"/> with a given name.
    /// Returns <see langword="null"/> if no profile with the given name exists.</returns>
    public FirefoxProfile? GetProfile(string? profileName)
    {
        if (profileName is not null && this.profiles.TryGetValue(profileName, out string? profile))
        {
            return new FirefoxProfile(profile);
        }

        return null;
    }

    private static string GetApplicationDataDirectory()
    {
        string appDataDirectory = Environment.OSVersion.Platform switch
        {
            PlatformID.Unix => Path.Combine(".mozilla", "firefox"),
            PlatformID.MacOSX => Path.Combine("Library", Path.Combine("Application Support", "Firefox")),
            _ => Path.Combine("Mozilla", "Firefox"),
        };

        return Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), appDataDirectory);
    }

    private void ReadProfiles(string appDataDirectory)
    {
        string profilesIniFile = Path.Combine(appDataDirectory, "profiles.ini");
        if (File.Exists(profilesIniFile))
        {
            IniFileReader reader = new IniFileReader(profilesIniFile);
            ReadOnlyCollection<string> sectionNames = reader.SectionNames;
            foreach (string sectionName in sectionNames)
            {
                if (sectionName.StartsWith("profile", StringComparison.OrdinalIgnoreCase))
                {
                    string name = reader.GetValue(sectionName, "name");
                    bool isRelative = reader.GetValue(sectionName, "isrelative") == "1";
                    string profilePath = reader.GetValue(sectionName, "path");
                    string fullPath;
                    if (isRelative)
                    {
                        fullPath = Path.Combine(appDataDirectory, profilePath);
                    }
                    else
                    {
                        fullPath = profilePath;
                    }

                    this.profiles.Add(name, fullPath);
                }
            }
        }
    }
}