IniFileReader.cs

// <copyright file="IniFileReader.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;

namespace OpenQA.Selenium.Firefox.Internal;

/// <summary>
/// Parses and reads an INI file.
/// </summary>
internal sealed class IniFileReader
{
    private readonly Dictionary<string, Dictionary<string, string>> iniFileStore = new Dictionary<string, Dictionary<string, string>>();

    /// <summary>
    /// Initializes a new instance of the <see cref="IniFileReader"/> class.
    /// </summary>
    /// <param name="fileName">The full path to the .INI file to be read.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="fileName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</exception>
    /// <exception cref="FileNotFoundException">If no file exists at file path <paramref name="fileName"/>.</exception>
    public IniFileReader(string fileName)
    {
        if (string.IsNullOrEmpty(fileName))
        {
            throw new ArgumentNullException(nameof(fileName), "File name must not be null or empty");
        }

        if (!File.Exists(fileName))
        {
            throw new FileNotFoundException("INI file not found", fileName);
        }

        Dictionary<string, string> section = new Dictionary<string, string>();
        string sectionName = string.Empty;

        string[] iniFileContent = File.ReadAllLines(fileName);
        foreach (string iniFileLine in iniFileContent)
        {
            if (!string.IsNullOrWhiteSpace(iniFileLine) && !iniFileLine.StartsWith(";", StringComparison.OrdinalIgnoreCase))
            {
                if (iniFileLine.StartsWith("[", StringComparison.OrdinalIgnoreCase) && iniFileLine.EndsWith("]", StringComparison.OrdinalIgnoreCase))
                {
                    if (!string.IsNullOrEmpty(sectionName))
                    {
                        this.iniFileStore.Add(sectionName, section);
                    }

                    sectionName = iniFileLine.Substring(1, iniFileLine.Length - 2).ToUpperInvariant();
                    section = new Dictionary<string, string>();
                }
                else
                {
                    string[] entryParts = iniFileLine.Split(new char[] { '=' }, 2);
                    string name = entryParts[0].ToUpperInvariant();
                    string value = string.Empty;
                    if (entryParts.Length > 1)
                    {
                        value = entryParts[1];
                    }

                    section.Add(name, value);
                }
            }
        }

        this.iniFileStore.Add(sectionName, section);
    }

    /// <summary>
    /// Gets a <see cref="ReadOnlyCollection{T}"/> containing the names of the sections in the .INI file.
    /// </summary>
    public ReadOnlyCollection<string> SectionNames => new ReadOnlyCollection<string>(new List<string>(this.iniFileStore.Keys));

    /// <summary>
    /// Gets a value from the .INI file.
    /// </summary>
    /// <param name="sectionName">The section in which to find the key-value pair.</param>
    /// <param name="valueName">The key of the key-value pair.</param>
    /// <returns>The value associated with the given section and key.</returns>
    /// <exception cref="ArgumentNullException">
    /// <para>If <paramref name="sectionName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</para>
    /// <para>-or-</para>
    /// <para>If <paramref name="valueName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</para>
    /// </exception>
    /// <exception cref="ArgumentException">
    /// <para>If no section named <paramref name="sectionName"/> exists.</para>
    /// <para>-or-</para>
    ///<para>If the section does not contain a value named <paramref name="valueName"/>.</para>
    /// </exception>
    public string GetValue(string sectionName, string valueName)
    {
        if (string.IsNullOrEmpty(sectionName))
        {
            throw new ArgumentNullException(nameof(sectionName), "Section name cannot be null or empty");
        }

        string lowerCaseSectionName = sectionName.ToUpperInvariant();

        if (string.IsNullOrEmpty(valueName))
        {
            throw new ArgumentNullException(nameof(valueName), "Value name cannot be null or empty");
        }

        string lowerCaseValueName = valueName.ToUpperInvariant();

        if (!this.iniFileStore.TryGetValue(lowerCaseSectionName, out Dictionary<string, string>? section))
        {
            throw new ArgumentException("Section does not exist: " + sectionName, nameof(sectionName));
        }

        if (!section.TryGetValue(lowerCaseValueName, out string? value))
        {
            throw new ArgumentException("Value does not exist: " + valueName, nameof(valueName));
        }

        return value;
    }
}