♻️ Rework various common classes

phpmon-common/Core/Actions.swift

@@ -0,0 +1,202 @@
+//
+//  Services.swift
+//  PHP Monitor
+//
+//  Copyright © 2021 Nico Verbruggen. All rights reserved.
+//
+
+import Foundation
+import AppKit
+
+class Actions {
+    
+    // MARK: - Services
+    
+    public static func restartPhpFpm()
+    {
+        brew("services restart \(PhpSwitcher.phpInstall.formula)", sudo: true)
+    }
+    
+    public static func restartNginx()
+    {
+        brew("services restart nginx", sudo: true)
+    }
+    
+    public static func restartDnsMasq()
+    {
+        brew("services restart dnsmasq", sudo: true)
+    }
+    
+    public static func stopAllServices()
+    {
+        brew("services stop \(PhpSwitcher.phpInstall.formula)", sudo: true)
+        brew("services stop nginx", sudo: true)
+        brew("services stop dnsmasq", sudo: true)
+    }
+    
+    /**
+     Kindly asks Valet to switch to a specific PHP version.
+     */
+    public static func switchToPhpVersionUsingValet(
+        version: String,
+        availableVersions: [String],
+        completed: @escaping () -> Void
+    ) {
+        print("Switching to \(version) using Valet")
+        print(valet("use php@\(version)"))
+        completed()
+    }
+    
+    /**
+     Switching to a new PHP version involves:
+     - unlinking the current version
+     - stopping the active services
+     - linking the new desired version
+     
+     Please note that depending on which version is installed,
+     the version that is switched to may or may not be identical to `php` (without @version).
+     */
+    public static func switchToPhpVersion(
+        version: String,
+        availableVersions: [String],
+        completed: @escaping () -> Void
+    ) {
+        print("Switching to \(version), unlinking all versions...")
+
+        let group = DispatchGroup()
+        
+        availableVersions.forEach { (available) in
+            group.enter()
+            
+            DispatchQueue.global(qos: .userInitiated).async {
+                let formula = (available == PhpSwitcher.brewPhpVersion)
+                    ? "php" : "php@\(available)"
+                
+                brew("unlink \(formula)")
+                brew("services stop \(formula)", sudo: true)
+                
+                group.leave()
+            }
+        }
+        
+        group.notify(queue: .global(qos: .userInitiated)) {
+            print("All versions have been unlinked!")
+            print("Linking the new version!")
+            
+            let formula = (version == PhpSwitcher.brewPhpVersion) ? "php" : "php@\(version)"
+            brew("link \(formula) --overwrite --force")
+            brew("services start \(formula)", sudo: true)
+            
+            print("The new version has been linked!")
+            completed()
+        }
+    }
+    
+    // MARK: - Finding Config Files
+    
+    public static func openGenericPhpConfigFolder()
+    {
+        let files = [NSURL(fileURLWithPath: "\(Paths.etcPath)/php")];
+        NSWorkspace.shared.activateFileViewerSelecting(files as [URL])
+    }
+    
+    public static func openGlobalComposerFolder()
+    {
+        let file = FileManager.default.homeDirectoryForCurrentUser
+            .appendingPathComponent(".composer/composer.json")
+        NSWorkspace.shared.activateFileViewerSelecting([file] as [URL])
+    }
+    
+    public static func openPhpConfigFolder(version: String)
+    {
+        let files = [NSURL(fileURLWithPath: "\(Paths.etcPath)/php/\(version)/php.ini")];
+        NSWorkspace.shared.activateFileViewerSelecting(files as [URL])
+    }
+    
+    public static func openValetConfigFolder()
+    {
+        let file = FileManager.default.homeDirectoryForCurrentUser
+            .appendingPathComponent(".config/valet")
+        NSWorkspace.shared.activateFileViewerSelecting([file] as [URL])
+    }
+    
+    // MARK: - Quick Fix
+    
+    /**
+     Detects all currently available PHP versions,
+     and unlinks each and every one of them.
+     
+     After this, the brew services are also stopped,
+     the latest PHP version is linked, and php + nginx are restarted.
+     
+     If this does not solve the issue, the user may need to install additional
+     extensions and/or run `composer global update`.
+     */
+    public static func fixMyPhp()
+    {
+        brew("services restart dnsmasq", sudo: true)
+        
+        PhpSwitcher.shared.detectPhpVersions().forEach { (version) in
+            let formula = (version == PhpSwitcher.brewPhpVersion) ? "php" : "php@\(version)"
+            brew("unlink php@\(version)")
+            brew("services stop \(formula)")
+            brew("services stop \(formula)", sudo: true)
+        }
+        
+        brew("services stop php")
+        brew("services stop nginx")
+        brew("link php")
+        brew("services restart dnsmasq", sudo: true)
+        brew("services stop php", sudo: true)
+        brew("services stop nginx", sudo: true)
+    }
+    
+    // MARK: Common Shell Commands
+    
+    /**
+     Runs a `valet` command.
+     */
+    public static func valet(_ command: String) -> String
+    {
+        return Shell.pipe("sudo \(Paths.valet) \(command)", requiresPath: true)
+    }
+    
+    /**
+     Runs a `brew` command. Can run as superuser.
+     */
+    public static func brew(_ command: String, sudo: Bool = false)
+    {
+        Shell.run("\(sudo ? "sudo " : "")" + "\(Paths.brew) \(command)")
+    }
+    
+    /**
+     Runs `sed` in order to replace all occurrences of a string in a specific file with another.
+     */
+    public static func sed(file: String, original: String, replacement: String)
+    {
+        // Escape slashes (or `sed` won't work)
+        let e_original = original.replacingOccurrences(of: "/", with: "\\/")
+        let e_replacement = replacement.replacingOccurrences(of: "/", with: "\\/")
+        
+        // Check if gsed exists; it is able to follow symlinks,
+        // which we want to do to toggle the extension
+        if Shell.fileExists("\(Paths.binPath)/gsed") {
+            Shell.run("\(Paths.binPath)/gsed -i --follow-symlinks 's/\(e_original)/\(e_replacement)/g' \(file)")
+        } else {
+            Shell.run("sed -i '' 's/\(e_original)/\(e_replacement)/g' \(file)")
+        }
+    }
+    
+    /**
+     Uses `grep` to determine whether a particular query string can be found in a particular file.
+     */
+    public static func grepContains(file: String, query: String) -> Bool
+    {
+        return Shell.pipe("""
+            grep -q '\(query)' \(file); [ $? -eq 0 ] && echo "YES" || echo "NO"
+            """)
+            .trimmingCharacters(in: .whitespacesAndNewlines)
+            .contains("YES")
+    }
+    
+}