Fixed markdown character escaping

iComputerfreak · iComputerfreak · commit de65d97a3f5d · 2021-05-04T16:10:26.000+02:00
diff --git a/NotifierBot/Sources/Notifier/Commands/AddCommand.swift b/NotifierBot/Sources/Notifier/Commands/AddCommand.swift
@@ -12,7 +12,7 @@ struct AddCommand: Command {
     
     let name = "Add"
     let commands = ["/add"]
-    let syntax = "/add <name> <URL> \\[x y width height]"
+    let syntax = "/add <name> <URL> [x y width height]"
     let description = "Adds a new website with an optional screenshot area to the list"
     let permission = BotPermission.mod
     
diff --git a/NotifierBot/Sources/Notifier/Commands/Command.swift b/NotifierBot/Sources/Notifier/Commands/Command.swift
@@ -13,6 +13,7 @@ protocol Command {
     var name: String { get }
     var commands: [String] { get }
     var permission: BotPermission { get }
+    /// Syntax of the command, used when showing the the usage. Contents of this string will be escaped so they can be used in markdownV2 format.
     var syntax: String { get }
     var usage: String { get }
     var description: String { get }
diff --git a/NotifierBot/Sources/Notifier/Commands/FetchURLCommand.swift b/NotifierBot/Sources/Notifier/Commands/FetchURLCommand.swift
@@ -12,7 +12,7 @@ struct FetchURLCommand: Command {
     
     let name = "Fetch URL"
     let commands = ["/fetchurl"]
-    let syntax = "/fetchurl <URL> \\[x y width height]"
+    let syntax = "/fetchurl <URL> [x y width height]"
     let description = "Takes a screenshot of the given website and settings and sends it into this chat"
     let permission = BotPermission.mod
     
diff --git a/NotifierBot/Sources/Notifier/Commands/GetPermissionsCommand.swift b/NotifierBot/Sources/Notifier/Commands/GetPermissionsCommand.swift
@@ -12,7 +12,7 @@ struct GetPermissionsCommand: Command {
     
     let name = "Get Permissions"
     let commands = ["/getpermissions"]
-    let syntax = "/getpermissions \\[id]"
+    let syntax = "/getpermissions [id]"
     let description = "Returns the permission level of the author of the message, replied to or the user id provided"
     let permission = BotPermission.admin
     
@@ -47,6 +47,6 @@ struct GetPermissionsCommand: Command {
             username = "\(id)"
         }
         let level = ConfigParser.shared.permissionGroup(user: userID)
-        try bot.sendMessage("The permission level of \(username!) is *\(level.rawValue)*.", to: chatID)
+        try bot.sendMessage("The permission level of \(username!.escaped()) is *\(level.rawValue)*\\.", to: chatID, parseMode: .markdownV2)
     }
 }
diff --git a/NotifierBot/Sources/Notifier/Commands/HelpCommand.swift b/NotifierBot/Sources/Notifier/Commands/HelpCommand.swift
@@ -28,17 +28,17 @@ struct HelpCommand: Command {
         for permission in BotPermission.allCases {
             let commands = allCommands.filter({ $0.permission == permission })
             // Print the commands for this group
-            usage += "*\(permission.rawValue.capitalized)*\n"
+            usage += "*\(permission.rawValue.capitalized.escaped())*\n"
             for command in commands {
-                usage += "\(command.syntax)\n\(command.description)\n"
+                usage += "\(command.syntax.escaped())\n\(command.description.escaped())\n"
             }
             // Extra space between permission groups
             usage += "\n"
         }
         if usage.hasSuffix("\n") {
             usage.removeLast()
         }
-        try bot.sendMessage(usage, to: chatID)
+        try bot.sendMessage(usage, to: chatID, parseMode: .markdownV2)
     }
     
 }
diff --git a/NotifierBot/Sources/Notifier/Commands/ListAllCommand.swift b/NotifierBot/Sources/Notifier/Commands/ListAllCommand.swift
@@ -31,23 +31,23 @@ struct ListAllCommand: Command {
             list += "*\(chatID):*\n"
             for entry in entries.filter({ $0.chatID == chatID }) {
                 // For each entry in this group
-                list += "- \(entry.name): \(entry.url)"
+                list += "- \(entry.name): \(entry.url)".escaped()
                 if entry.area.width != 0 && entry.area.height != 0 {
-                    list += " (\(entry.area.width)x\(entry.area.height)+\(entry.area.x)+\(entry.area.y))"
+                    list += " (\(entry.area.width)x\(entry.area.height)+\(entry.area.x)+\(entry.area.y))".escaped()
                 }
                 list += "\n"
             }
             // Extra empty line between groups
             list += "\n"
         }
-        if list.hasSuffix("\n") {
+        while list.hasSuffix("\n") {
             list.removeLast()
         }
         // In case the file was empty
         if entries.isEmpty {
             list += "\n_None_"
         }
-        try bot.sendMessage(list, to: chatID)
+        try bot.sendMessage(list, to: chatID, parseMode: .markdownV2)
     }
     
 }
diff --git a/NotifierBot/Sources/Notifier/Commands/ListCommand.swift b/NotifierBot/Sources/Notifier/Commands/ListCommand.swift
@@ -20,7 +20,7 @@ struct ListCommand: Command {
         let chatID = try update.chatID()
         let entries = try ConfigParser.getConfig().filter({ $0.chatID == chatID })
         let list = JFUtils.entryList(entries, listArea: true, listURLs: false)
-        try bot.sendMessage(list, to: chatID)
+        try bot.sendMessage(list, to: chatID, parseMode: .markdownV2)
     }
     
 }
diff --git a/NotifierBot/Sources/Notifier/Commands/ListURLsCommand.swift b/NotifierBot/Sources/Notifier/Commands/ListURLsCommand.swift
@@ -20,7 +20,7 @@ struct ListURLsCommand: Command {
         let chatID = try update.chatID()
         let entries = try ConfigParser.getConfig().filter({ $0.chatID == chatID })
         let list = JFUtils.entryList(entries, listArea: false, listURLs: true)
-        try bot.sendMessage(list, to: chatID)
+        try bot.sendMessage(list, to: chatID, parseMode: .markdownV2)
     }
     
 }
diff --git a/NotifierBot/Sources/Notifier/Commands/MyIDCommand.swift b/NotifierBot/Sources/Notifier/Commands/MyIDCommand.swift
@@ -22,6 +22,6 @@ struct MyIDCommand: Command {
             try bot.sendMessage("Unable to determine user.", to: chatID)
             return
         }
-        try bot.sendMessage("The user ID of \(user.username ?? "<Unknown>") is `\(user.id)`", to: chatID)
+        try bot.sendMessage("The user ID of \(user.username?.escaped() ?? "<Unknown>") is `\(user.id)`", to: chatID, parseMode: .markdownV2)
     }
 }
diff --git a/NotifierBot/Sources/Notifier/Commands/SetPermissionsCommand.swift b/NotifierBot/Sources/Notifier/Commands/SetPermissionsCommand.swift
@@ -12,7 +12,7 @@ struct SetPermissionsCommand: Command {
     
     let name = "Set Permissions"
     let commands = ["/setpermissions"]
-    let syntax = "/setpermissions <level> \\[id]"
+    let syntax = "/setpermissions <level> [id]"
     let description = "Sets the permission level of the author of the message, replied to or the user id provided"
     let permission = BotPermission.admin
     
@@ -43,10 +43,10 @@ struct SetPermissionsCommand: Command {
             username = "\(id)"
         }
         guard let level = BotPermission(rawValue: args[0].trimmingCharacters(in: .whitespaces)) else {
-            try bot.sendMessage("Error: Please specify a valid bot permission. (\(BotPermission.allCases.map({ $0.rawValue }).joined(separator: ", ")))", to: chatID)
+            try bot.sendMessage("Error: Please specify a valid bot permission: \(BotPermission.allCases.map({ $0.rawValue }).joined(separator: ", "))", to: chatID)
             return
         }
         try ConfigParser.shared.setPermissionGroup(user: userID, level: level)
-        try bot.sendMessage("Successfully set the permission level of \(username!) to *\(level.rawValue)*.", to: chatID)
+        try bot.sendMessage("Successfully set the permission level of \(username!.escaped()) to *\(level.rawValue)*.", to: chatID, parseMode: .markdownV2)
     }
 }
diff --git a/NotifierBot/Sources/Notifier/JFErrorHandler.swift b/NotifierBot/Sources/Notifier/JFErrorHandler.swift
@@ -14,9 +14,9 @@ class JFErrorHandler {
     
     func handle(_ error: JFBotError, update: Update) {
         
-        func sendError(_ userMessage: String) {
+        func sendError(_ userMessage: String, parseMode: ParseMode? = nil) {
             if let chatID = update.message?.chat.id {
-                _ = try? bot.sendMessage(userMessage, to: chatID)
+                _ = try? bot.sendMessage(userMessage, to: chatID, parseMode: parseMode)
             }
         }
         
@@ -37,7 +37,7 @@ class JFErrorHandler {
             sendError("Error: Unable to retrieve message text.")
             print("Error: Unable to retrieve message text containing this command.")
         case .noPermissions(let command):
-            sendError("This action requires the permission level *\(command.permission.rawValue)*.")
+            sendError("This action requires the permission level *\(command.permission.rawValue)*\\.", parseMode: .markdownV2)
             var name = "\(update.message?.from?.username ?? "Unknown User")"
             if let firstName = update.message?.from?.firstName, let lastName = update.message?.from?.lastName {
                 name += " (\(firstName) \(lastName))"
diff --git a/NotifierBot/Sources/Notifier/JFUtils.swift b/NotifierBot/Sources/Notifier/JFUtils.swift
@@ -56,13 +56,13 @@ struct JFUtils {
         if entries.isEmpty {
             list += "_None_"
         } else if listArea && listURLs {
-            list += entries.map({ "- \($0.name) (Offset: \($0.area.x)/\($0.area.y), Size: \($0.area.width)x\($0.area.height))\n  \($0.url)" }).joined(separator: "\n")
+            list += entries.map({ "- \($0.name) (Offset: \($0.area.x)/\($0.area.y), Size: \($0.area.width)x\($0.area.height))\n  \($0.url)" }).joined(separator: "\n").escaped()
         } else if listURLs {
-            list += entries.map({ "- \($0.name): \($0.url)" }).joined(separator: "\n")
+            list += entries.map({ "- \($0.name): \($0.url)" }).joined(separator: "\n").escaped()
         } else if listArea {
-            list += entries.map({ "- \($0.name) (Offset: \($0.area.x)/\($0.area.y), Size: \($0.area.width)x\($0.area.height))" }).joined(separator: "\n")
+            list += entries.map({ "- \($0.name) (Offset: \($0.area.x)/\($0.area.y), Size: \($0.area.width)x\($0.area.height))" }).joined(separator: "\n").escaped()
         } else {
-            list += entries.map({ "- \($0.name)"}).joined(separator: "\n")
+            list += entries.map({ "- \($0.name)"}).joined(separator: "\n").escaped()
         }
         return list
     }
@@ -99,10 +99,21 @@ extension Bot {
     
     /// Sends a message with the default parameters for this bot
     @discardableResult
-    func sendMessage(_ text: String, to chatID: Int64, parseMode: ParseMode? = .markdownV2, disableWebPagePreview: Bool? = true,
+    func sendMessage(_ text: String, to chatID: Int64, parseMode: ParseMode? = nil, disableWebPagePreview: Bool? = true,
                      disableNotification: Bool? = true, replyToMessageId: Int? = nil, replyMarkup: ReplyMarkup? = nil) throws -> Future<Message> {
         return try self.sendMessage(params: .init(chatId: .chat(chatID), text: text, parseMode: parseMode, disableWebPagePreview: disableWebPagePreview,
                                                   disableNotification: disableNotification, replyToMessageId: replyToMessageId, replyMarkup: replyMarkup))
     }
     
 }
+
+extension String {
+    func escaped() -> String {
+        // Escape characters that are reserved in MarkdownV2 (https://core.telegram.org/bots/api#markdownv2-style)
+        var text = self
+        for character in ["_", "*", "[", "]", "(", ")", "~", "`", ">", "#", "+", "-", "=", "|", "{", "}", ".", "!"] {
+            text = text.replacingOccurrences(of: character, with: "\\" + character)
+        }
+        return text
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ struct GetPermissionsCommand: Command {`
`12`	`12`
`13`	`13`	`let name = "Get Permissions"`
`14`	`14`	`let commands = ["/getpermissions"]`
`15`		`- let syntax = "/getpermissions \\[id]"`
	`15`	`+ let syntax = "/getpermissions [id]"`
`16`	`16`	`let description = "Returns the permission level of the author of the message, replied to or the user id provided"`
`17`	`17`	`let permission = BotPermission.admin`
`18`	`18`
`@@ -47,6 +47,6 @@ struct GetPermissionsCommand: Command {`
`47`	`47`	`username = "\(id)"`
`48`	`48`	`}`
`49`	`49`	`let level = ConfigParser.shared.permissionGroup(user: userID)`
`50`		`- try bot.sendMessage("The permission level of \(username!) is \(level.rawValue).", to: chatID)`
	`50`	`+ try bot.sendMessage("The permission level of \(username!.escaped()) is \(level.rawValue)\\.", to: chatID, parseMode: .markdownV2)`
`51`	`51`	`}`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,17 +28,17 @@ struct HelpCommand: Command {`
`28`	`28`	`for permission in BotPermission.allCases {`
`29`	`29`	`let commands = allCommands.filter({ $0.permission == permission })`
`30`	`30`	`// Print the commands for this group`
`31`		`- usage += "\(permission.rawValue.capitalized)\n"`
	`31`	`+ usage += "\(permission.rawValue.capitalized.escaped())\n"`
`32`	`32`	`for command in commands {`
`33`		`- usage += "\(command.syntax)\n\(command.description)\n"`
	`33`	`+ usage += "\(command.syntax.escaped())\n\(command.description.escaped())\n"`
`34`	`34`	`}`
`35`	`35`	`// Extra space between permission groups`
`36`	`36`	`usage += "\n"`
`37`	`37`	`}`
`38`	`38`	`if usage.hasSuffix("\n") {`
`39`	`39`	`usage.removeLast()`
`40`	`40`	`}`
`41`		`- try bot.sendMessage(usage, to: chatID)`
	`41`	`+ try bot.sendMessage(usage, to: chatID, parseMode: .markdownV2)`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,23 +31,23 @@ struct ListAllCommand: Command {`
`31`	`31`	`list += "\(chatID):\n"`
`32`	`32`	`for entry in entries.filter({ $0.chatID == chatID }) {`
`33`	`33`	`// For each entry in this group`
`34`		`- list += "- \(entry.name): \(entry.url)"`
	`34`	`+ list += "- \(entry.name): \(entry.url)".escaped()`
`35`	`35`	`if entry.area.width != 0 && entry.area.height != 0 {`
`36`		`- list += " (\(entry.area.width)x\(entry.area.height)+\(entry.area.x)+\(entry.area.y))"`
	`36`	`+ list += " (\(entry.area.width)x\(entry.area.height)+\(entry.area.x)+\(entry.area.y))".escaped()`
`37`	`37`	`}`
`38`	`38`	`list += "\n"`
`39`	`39`	`}`
`40`	`40`	`// Extra empty line between groups`
`41`	`41`	`list += "\n"`
`42`	`42`	`}`
`43`		`- if list.hasSuffix("\n") {`
	`43`	`+ while list.hasSuffix("\n") {`
`44`	`44`	`list.removeLast()`
`45`	`45`	`}`
`46`	`46`	`// In case the file was empty`
`47`	`47`	`if entries.isEmpty {`
`48`	`48`	`list += "\n_None_"`
`49`	`49`	`}`
`50`		`- try bot.sendMessage(list, to: chatID)`
	`50`	`+ try bot.sendMessage(list, to: chatID, parseMode: .markdownV2)`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ struct ListCommand: Command {`
`20`	`20`	`let chatID = try update.chatID()`
`21`	`21`	`let entries = try ConfigParser.getConfig().filter({ $0.chatID == chatID })`
`22`	`22`	`let list = JFUtils.entryList(entries, listArea: true, listURLs: false)`
`23`		`- try bot.sendMessage(list, to: chatID)`
	`23`	`+ try bot.sendMessage(list, to: chatID, parseMode: .markdownV2)`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ struct ListURLsCommand: Command {`
`20`	`20`	`let chatID = try update.chatID()`
`21`	`21`	`let entries = try ConfigParser.getConfig().filter({ $0.chatID == chatID })`
`22`	`22`	`let list = JFUtils.entryList(entries, listArea: false, listURLs: true)`
`23`		`- try bot.sendMessage(list, to: chatID)`
	`23`	`+ try bot.sendMessage(list, to: chatID, parseMode: .markdownV2)`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,6 @@ struct MyIDCommand: Command {`
`22`	`22`	`try bot.sendMessage("Unable to determine user.", to: chatID)`
`23`	`23`	`return`
`24`	`24`	`}`
`25`		- try bot.sendMessage("The user ID of \(user.username ?? "<Unknown>") is `\(user.id)`", to: chatID)
	`25`	+ try bot.sendMessage("The user ID of \(user.username?.escaped() ?? "<Unknown>") is `\(user.id)`", to: chatID, parseMode: .markdownV2)
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ struct SetPermissionsCommand: Command {`
`12`	`12`
`13`	`13`	`let name = "Set Permissions"`
`14`	`14`	`let commands = ["/setpermissions"]`
`15`		`- let syntax = "/setpermissions <level> \\[id]"`
	`15`	`+ let syntax = "/setpermissions <level> [id]"`
`16`	`16`	`let description = "Sets the permission level of the author of the message, replied to or the user id provided"`
`17`	`17`	`let permission = BotPermission.admin`
`18`	`18`
`@@ -43,10 +43,10 @@ struct SetPermissionsCommand: Command {`
`43`	`43`	`username = "\(id)"`
`44`	`44`	`}`
`45`	`45`	`guard let level = BotPermission(rawValue: args[0].trimmingCharacters(in: .whitespaces)) else {`
`46`		`- try bot.sendMessage("Error: Please specify a valid bot permission. (\(BotPermission.allCases.map({ $0.rawValue }).joined(separator: ", ")))", to: chatID)`
	`46`	`+ try bot.sendMessage("Error: Please specify a valid bot permission: \(BotPermission.allCases.map({ $0.rawValue }).joined(separator: ", "))", to: chatID)`
`47`	`47`	`return`
`48`	`48`	`}`
`49`	`49`	`try ConfigParser.shared.setPermissionGroup(user: userID, level: level)`
`50`		`- try bot.sendMessage("Successfully set the permission level of \(username!) to \(level.rawValue).", to: chatID)`
	`50`	`+ try bot.sendMessage("Successfully set the permission level of \(username!.escaped()) to \(level.rawValue).", to: chatID, parseMode: .markdownV2)`
`51`	`51`	`}`
`52`	`52`	`}`