Fixed fetch command not working with spaces in paths

Added unmute duration to /info
Added option to specify the mute duration as a floating point value
Added debug environment variable
Changed error report minutes to TimeInterval and used DateComponentsFormatter to print the duration

Author: iComputerfreak

NotifierBot/Sources/Notifier/Commands/InfoCommand.swift

@@ -56,7 +56,11 @@ struct InfoCommand: Command {
         if !e.waitElement.isEmpty {
             lines.append("- Wait Element: ".escaped() + "`\(e.waitElement.escaped())`")
         }
-        lines.append("- Muted: \(e.isMuted ? "Yes" : "No")".escaped())
+        var durationString = ""
+        if let restDuration = e.unmuteDate?.timeIntervalSince(Date()) {
+            durationString = JFUtils.muteDurationFormatter.string(from: restDuration) ?? ""
+        }
+        lines.append("- Muted: \(e.isMuted ? "Yes (\(durationString) hours remaining)" : "No")".escaped())
         return lines.joined(separator: "\n")
     }
 

NotifierBot/Sources/Notifier/Commands/MuteCommand.swift

@@ -29,10 +29,10 @@ struct MuteCommand: Command {
         let name = args[0].trimmingCharacters(in: .whitespaces)
         let hoursStr = args[1].trimmingCharacters(in: .whitespaces)
 
-        let hours = Int(hoursStr) ?? 0
+        let hours = Double(hoursStr) ?? 0.0
         guard (hours > 0) else {
             // No valid int found
-            try bot.sendMessage("\(hoursStr) is not a valid integer. Please enter a valid amount of hours > 0.", to: chatID)
+            try bot.sendMessage("\(hoursStr) is not a valid number. Please enter a valid amount of hours > 0.", to: chatID)
             return
         }
 

NotifierBot/Sources/Notifier/JFUtils.swift

@@ -32,10 +32,10 @@ struct JFUtils {
     }
 
     static func takeScreenshot(entry e: URLEntry, filename: String) {
-        shell("\(kScreenshotScript) \"\(e.url)\" \"\(filename)\" \"\(e.delay)\" \"\(e.captureElement)\" \"\(e.clickElement)\" \"\(e.waitElement)\"")
+        shell("\"\(kScreenshotScript)\" \"\(e.url)\" \"\(filename)\" \"\(e.delay)\" \"\(e.captureElement)\" \"\(e.clickElement)\" \"\(e.waitElement)\"")
         if e.area.width != 0 && e.area.height != 0 {
             // Crop the screenshot
-            shell("\(kConvertPath) \(filename) -crop \(e.area.width)x\(e.area.height)+\(e.area.x)+\(e.area.y) \(filename)")
+            shell("\"\(kConvertPath)\" \(filename) -crop \(e.area.width)x\(e.area.height)+\(e.area.x)+\(e.area.y) \(filename)")
         }
     }
 
@@ -48,7 +48,7 @@ struct JFUtils {
     }
 
     static private func sendImageOrFile(path: String, chatID: Int64, isFile: Bool, text: String? = nil) {
-        var command = "\(kTelegramScript) -t \(token!) -c \(chatID) -\(isFile ? "f" : "i") \"\(path)\""
+        var command = "\"\(kTelegramScript)\" -t \(token!) -c \(chatID) -\(isFile ? "f" : "i") \"\(path)\""
         if let text = text {
             // Encase the lines in parantheses
             let lines = text.components(separatedBy: .newlines).map({ "\"\($0)\"" })
@@ -74,6 +74,13 @@ struct JFUtils {
         return list.joined(separator: "\n")
     }
 
+    static var muteDurationFormatter: DateComponentsFormatter {
+        let f = DateComponentsFormatter()
+        f.unitsStyle = .abbreviated
+        f.allowedUnits = [.year, .day, .hour, .minute]
+        return f
+    }
+    
 }
 
 extension Dispatcher {

README.md

@@ -115,7 +115,7 @@ For the scripts and the bot to work, you have to put your bot token in a file ca
 1. Start the bot
 2. Run the command `/myid` to retrieve your ID
 3. Stop the bot
-4. Add your ID to the permissions file: `echo "YOUR_ID: admin" > /path/to/your/install/directory/permissions.txt`
+4. Add your ID to the permissions file: `echo "YOUR_ID: admin" > /path/to/your/install/directory/NotifierBot/permissions.txt`
 5. Start the bot again and make sure, it worked by checking your permissions with the bot: `/getpermissions YOUR_ID`
 6. If the bot returned your permission level as **admin**, everything worked and you now have admin permissions
 

Shared/Sources/Shared/JFLiterals.swift

@@ -23,8 +23,14 @@ public let mainDirectory: String = {
     if components?.last == "urlwatcher" {
         components?.removeLast()
     }
-    let mainDirectory = components?
+    var mainDirectory = components?
         .joined(separator: "/")
+    if !(ProcessInfo.processInfo.environment["NOTIFIER_BOT_DEBUG"]?.isEmpty ?? true) {
+        // If the debug variable is set, we use the working directory as mainDirectory
+        // (e.g. when debugging in Xcode)
+        mainDirectory = FileManager.default.currentDirectoryPath
+        print("Using debug directory as main: \(mainDirectory ?? "nil")")
+    }
     print("Installation Directory: \(mainDirectory ?? "nil")")
 
     // If no install directory could be constructed:
@@ -67,4 +73,4 @@ public let kDiffFile = "diff.png"
 /// The threshold value the bot uses. If the NCC value is below this, a notification is triggered
 public let kNccThreshold = 0.999
 /// The duration for which a screenshot capture error has to persist for the user to be notified. Set to 0 to immediately notify on errors
-public let kErrorReportMinutes = 120
+public let kErrorReportDuration: TimeInterval = 1

urlwatcher/.swiftpm/xcode/xcshareddata/xcschemes/urlwatcher.xcscheme

@@ -36,7 +36,7 @@
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       launchStyle = "0"
       useCustomWorkingDirectory = "YES"
-      customWorkingDirectory = "/Users/jonasfrey/Documents/_Developing/Xcode Projects/Bots/NotifierBot/urlwatcher"
+      customWorkingDirectory = "/Users/jonasfrey/Documents/_Developing/Xcode Projects/Bots/NotifierBot"
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
@@ -53,8 +53,13 @@
       </BuildableProductRunnable>
       <EnvironmentVariables>
          <EnvironmentVariable
-            key = "PATH"
-            value = "/Users/jonasfrey/tools:/usr/local/opt/gnu-getopt/bin:/Library/Frameworks/Python.framework/Versions/3.9/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/TeX/texbin:/opt/X11/bin:/Library/Apple/usr/bin:/opt/local/bin:/Users/jonasfrey/scripts:/Users/jonasfrey/flutter/bin"
+            key = "NOTIFIER_BOT_DEBUG"
+            value = "true"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "TELEGRAM_BOT_TOKEN"
+            value = "5221316043:AAF-_gfAxbHVrW2HDfplfSYz3psPtseLVKM"
             isEnabled = "YES">
          </EnvironmentVariable>
       </EnvironmentVariables>

urlwatcher/Sources/urlwatcher/Functions.swift

@@ -8,7 +8,8 @@
 import Foundation
 import Shared
 
-func takeScreenshot(ofURL url: String, outputPath: String, delay: Int? = nil, captureElement: String? = nil, clickElement: String? = nil, waitElement: String? = nil) throws -> BashResult {
+func takeScreenshot(ofURL url: String, outputPath: String, delay: Int? = nil, captureElement: String? = nil,
+                    clickElement: String? = nil, waitElement: String? = nil) throws -> BashResult {
     let screenshotCommand = "capture-website"
     var arguments = [
         url,
@@ -144,12 +145,13 @@ func sendTelegramMessage(_ message: String, to chatID: Int, image: String? = nil
 func handleScreenshotError(entry: URLEntry) throws {
     let errorFile = "\(directory(for: entry))/error"
     // If the errorReportMinutes are not set, we immediately notify the user
-    guard kErrorReportMinutes > 0 else {
+    guard kErrorReportDuration > 0 else {
         try notifyError(entry: entry)
         return
     }
 
-    // Before we notify the user, we check if the error hast persisted for the last few minutes to avoid notifying the user at single screenshot errors
+    // Before we notify the user, we check if the error hast persisted for the last few minutes to avoid notifying the
+    // user at single screenshot errors
     // We do this, by checking for a file 'error' and its creation date to see when the error first appeared.
     // This file should be deleted on the next successful capture
     if !fileManager.fileExists(atPath: errorFile) {
@@ -162,7 +164,7 @@ func handleScreenshotError(entry: URLEntry) throws {
     // If an error file already exists, get the attributes and check the creation date
     if fileManager.fileExists(atPath: errorFile),
        let creationDate = try fileManager.attributesOfItem(atPath: errorFile)[.creationDate] as? Date,
-       creationDate.distance(to: Date()) >= Double(kErrorReportMinutes * 60) {
+       creationDate.distance(to: Date()) >= kErrorReportDuration {
         // Notify the user that an error persisted for the last `errorReportTime` seconds
         try notifyError(entry: entry)
     }
@@ -174,7 +176,12 @@ func notifyError(entry: URLEntry) throws {
         return
     }
     print("Error taking screenshot. Notifying user...")
-    try sendTelegramMessage("The entry '\(entry.name)' failed to capture a screenshot for the last \(kErrorReportMinutes) minutes.", to: Int(entry.chatID))
+    let f = DateComponentsFormatter()
+    f.allowedUnits = [.year, .day, .hour, .minute, .second]
+    f.unitsStyle = .full
+    let durationString = f.string(from: kErrorReportDuration) ?? "some time"
+    try sendTelegramMessage("The entry '\(entry.name)' failed to capture a screenshot for at least \(durationString).",
+                            to: Int(entry.chatID))
 }
 
 func notifyUnmuted(entry: URLEntry) throws {

urlwatcher/Sources/urlwatcher/main.swift

@@ -6,12 +6,26 @@ import Shared
 let silentMode: Bool = false
 
 let fileManager = FileManager.default
+
 /// The telegram bot token is read from a file
-let telegramBotToken = try String(contentsOfFile: "\(mainDirectory)/BOT_TOKEN", encoding: .utf8).components(separatedBy: .newlines).first
-guard telegramBotToken != nil else {
-    print("Unable to read bot token. Please place it into the file \(mainDirectory.components(separatedBy: "/").dropLast().joined(separator: "/"))/BOT_TOKEN")
+var telegramBotToken: String! = nil
+if let t = try? String(contentsOfFile: "\(mainDirectory)/BOT_TOKEN", encoding: .utf8)
+    .components(separatedBy: .newlines)
+    .first {
+    // Read the token from a the file
+    print("Reading token from file.")
+    telegramBotToken = t
+} else if let t = ProcessInfo.processInfo.environment["TELEGRAM_BOT_TOKEN"] {
+    // Read the token from the environment, if it exists
+    print("Reading token from environment.")
+    telegramBotToken = t
+} else {
+    print("Unable to read bot token. Please place it into the file " +
+          "\(mainDirectory.components(separatedBy: "/").dropLast().joined(separator: "/"))/BOT_TOKEN " +
+          "or provide the environment variable TELEGRAM_BOT_TOKEN")
     exit(1)
 }
+
 /// The script used to send the telegram messages
 let telegramScript = "\(mainDirectory)/tools/telegram.sh"