♻️ WIP: Parsing logic for configuration file

phpmon/Common/PHP/ActivePhpInstallation.swift

@@ -20,7 +20,7 @@ class ActivePhpInstallation {
 
     var version: Version!
     var limits: Limits!
-    var iniFiles: [PhpInitializationFile] = []
+    var iniFiles: [PhpConfigurationFile] = []
 
     var extensions: [PhpExtension] {
         return iniFiles.flatMap { initFile in
@@ -53,7 +53,7 @@ class ActivePhpInstallation {
         let mainConfigurationFileUrl = URL(fileURLWithPath: "\(Paths.etcPath)/php/\(version.short)/php.ini")
 
         iniFiles.append(
-            PhpInitializationFile(fileUrl: mainConfigurationFileUrl)
+            PhpConfigurationFile(fileUrl: mainConfigurationFileUrl)
         )
 
         // extensions.append(contentsOf: PhpExtension.load(from: mainConfigurationFileUrl))
@@ -76,7 +76,7 @@ class ActivePhpInstallation {
             let fileUrl = URL(fileURLWithPath: iniFilePath)
 
             iniFiles.append(
-                PhpInitializationFile(fileUrl: fileUrl)
+                PhpConfigurationFile(fileUrl: fileUrl)
             )
         }
     }

phpmon/Common/PHP/PhpConfigurationFile.swift

@@ -0,0 +1,128 @@
+//
+//  PhpInitFile.swift
+//  PHP Monitor
+//
+//  Created by Nico Verbruggen on 04/05/2022.
+//  Copyright © 2022 Nico Verbruggen. All rights reserved.
+//
+
+import Foundation
+
+class PhpConfigurationFile {
+
+    typealias Section = [String: String]
+    typealias Config = [String: Section]
+
+    /// The file where this configuration file was located.
+    let file: String
+
+    /// The extensions found in this .ini file.
+    let extensions: [PhpExtension]
+
+    /// The actual content of the configuration file.
+    var content: Config
+
+    init(fileUrl: URL) {
+        self.file = fileUrl.path
+
+        let rawString = (try? String(contentsOf: fileUrl, encoding: .utf8)) ?? ""
+
+        self.extensions = PhpExtension.load(from: fileUrl)
+
+        self.content = Self.parseConfig(from: rawString.components(separatedBy: "\n"))
+
+        dump(self)
+    }
+
+    // MARK: Parsing Logic
+    // Slightly modified from: https://gist.github.com/jetmind/f776c0d223e4ac6aec1ff9389e874553
+
+    /**
+     Attempts to parse the configuration file, based on an array of strings.
+     Each string is a line from the configuration file.
+     */
+    private static func parseConfig(from lines: [String]) -> Config {
+        var config = Config()
+        var currentSectionName = "main"
+        for line in lines {
+            let line = trim(line)
+            if line.hasPrefix("[") && line.hasSuffix("]") {
+                currentSectionName = parseSectionHeader(line)
+            } else if let (key, value) = parseLine(line) {
+                var section = config[currentSectionName] ?? [:]
+                section[key] = value
+                config[currentSectionName] = section
+            }
+        }
+        return config
+    }
+
+    /**
+     Remove all whitespace and additional characters from individual lines.
+     */
+    private static func trim(_ s: String) -> String {
+        let whitespaces = CharacterSet(charactersIn: " \n\r\t")
+        return s.trimmingCharacters(in: whitespaces)
+    }
+
+    /**
+     It may prove beneficial to strip all comments, which can start with # or ;.
+     In this case, strip both.
+     */
+    private static func stripComment(_ line: String) -> String {
+        var line = line
+
+        let characters: [String.Element] = ["#", ";"]
+
+        for character in characters {
+            // Only keep checking for comments as long as the line isn't empty
+            if line.isEmpty {
+                return line
+            }
+
+            // Check for the next comment character
+            line = strip(character: character, line)
+        }
+
+        return line
+    }
+
+    /**
+     Empties a line if it happens to be commented out, causing it to be ignored.
+     */
+    private static func strip(character: String.Element, _ line: String) -> String {
+        let parts = line.split(
+            separator: character,
+            maxSplits: 1,
+            omittingEmptySubsequences: false
+        )
+        if !parts.isEmpty {
+            return String(parts[0])
+        }
+        return ""
+    }
+
+    /**
+     Attempts to parse a section header. Requires the line to start with [ and end with ].
+     */
+    private static func parseSectionHeader(_ line: String) -> String {
+        let from = line.index(after: line.startIndex)
+        let to = line.index(before: line.endIndex)
+        return line[from..<to]
+    }
+
+    /**
+     Attempts to parse a regular line, which may contain a configuration value that is being set.
+     */
+    private static func parseLine(_ line: String) -> (String, String)? {
+        let parts = stripComment(line)
+            .split(separator: "=", maxSplits: 1)
+        if parts.count == 2 {
+            let k = trim(String(parts[0]))
+            let v = trim(String(parts[1]))
+            return (k, v)
+        }
+        return nil
+    }
+
+}

phpmon/Common/PHP/PhpInitializationFile.swift

@@ -1,38 +0,0 @@
-//
-//  PhpInitFile.swift
-//  PHP Monitor
-//
-//  Created by Nico Verbruggen on 04/05/2022.
-//  Copyright © 2022 Nico Verbruggen. All rights reserved.
-//
-
-import Foundation
-
-class PhpInitializationFile {
-
-    /// The file where this extension was located.
-    let file: String
-
-    /// The original string contained within the file when scanned.
-    let raw: [String]
-
-    /// The extensions found in this .ini file.
-    let extensions: [PhpExtension]
-
-    init(fileUrl: URL) {
-        self.file = fileUrl.path
-
-        let rawString = (try? String(contentsOf: fileUrl, encoding: .utf8)) ?? ""
-
-        self.raw = rawString.components(separatedBy: "\n")
-
-        self.extensions = PhpExtension.load(from: fileUrl)
-
-        dump(self)
-
-        // TODO: Actually parse the .ini file
-        // Parsing the file could be done like this gist:
-        // https://gist.github.com/jetmind/f776c0d223e4ac6aec1ff9389e874553
-    }
-
-}