Merge branch 'master' of https://github.com/iComputerfreak/NotifierBot

Author: iComputerfreak

.gitignore

@@ -7,7 +7,7 @@ tools/telegram.sh
 deploy.sh
 
 **/geckodriver.log
-Notifier
+./Notifier
 permissions.txt
 urlwatcher/urls.list
 urlwatcher/images/*

NotifierBot/Package.swift

@@ -14,14 +14,14 @@ let package = Package(
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         // .package(url: /* package url */, from: "1.0.0"),
-        .package(url: "https://github.com/rapierorg/telegram-bot-swift.git", .exact("1.1.0"))
+        .package(url: "https://github.com/givip/Telegrammer", from: "0.5.4")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages which this package depends on.
         .target(
             name: "Notifier",
-            dependencies: ["TelegramBotSDK"]),
+            dependencies: ["Telegrammer"]),
         .testTarget(
             name: "NotifierTests",
             dependencies: ["Notifier"]),

NotifierBot/Sources/Notifier/BotPermission.swift

@@ -0,0 +1,28 @@
+//
+//  BotPermission.swift
+//  
+//
+//  Created by Jonas Frey on 14.06.20.
+//
+
+import Foundation
+
+enum BotPermission: String, Comparable, CaseIterable {
+    case user = "user"
+    case mod = "mod"
+    case admin = "admin"
+    
+    static private let levels: [BotPermission: Int] = [
+        .user: 0,
+        .mod: 1,
+        .admin: 2
+    ]
+    
+    static func <(lhs: BotPermission, rhs: BotPermission) -> Bool {
+        return levels[lhs]! < levels[rhs]!
+    }
+    
+    static func >(lhs: BotPermission, rhs: BotPermission) -> Bool {
+        return levels[lhs]! > levels[rhs]!
+    }
+}

NotifierBot/Sources/Notifier/Commands/AddCommand.swift

@@ -0,0 +1,76 @@
+//
+//  AddCommand.swift
+//  
+//
+//  Created by Jonas Frey on 01.05.21.
+//
+
+import Foundation
+import Telegrammer
+
+struct AddCommand: Command {
+    
+    let name = "Add"
+    let commands = ["/add"]
+    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
+    
+    func run(update: Update, context: BotContext?) throws {
+        let chatID = try update.chatID()
+        let args = try update.args()
+        guard args.count > 0 else {
+            try showUsage(chatID)
+            return
+        }
+        
+        // Check if there is a valid URL
+        guard let urlIndex = args.lastIndex(where: { $0.starts(with: "http") }) else {
+            // No valid URL found
+            try bot.sendMessage("Please enter a valid URL, starting with 'http://' or 'https://'", to: chatID)
+            return
+        }
+        // The first argument should be the name, not the URL
+        if urlIndex == 0 {
+            try showUsage(chatID)
+            return
+        }
+        // Parse the arguments
+        let name = args[0..<urlIndex].joined(separator: " ")
+        let url = args[urlIndex]
+        
+        let area: Rectangle!
+        if args.count == urlIndex + 5 {
+            // If a cropping area was supplied
+            let x = Int(args[urlIndex + 1])
+            let y = Int(args[urlIndex + 2])
+            let width = Int(args[urlIndex + 3])
+            let height = Int(args[urlIndex + 4])
+            guard x != nil && y != nil && width != nil && height != nil else {
+                try bot.sendMessage("Please enter a valid Offset and Size", to: chatID)
+                return
+            }
+            area = Rectangle(x: x!, y: y!, width: width!, height: height!)
+        } else if args.count == urlIndex + 1 {
+            // No cropping area
+            area = .zero
+        } else {
+            try showUsage(chatID)
+            return
+        }
+        
+        // Create the new entry
+        let entry = URLEntry(name: name, url: url, area: area, chatID: chatID)
+        var config = try ConfigParser.getConfig()
+        // Only check for matching names in the same chat
+        guard !config.contains(where: { $0.name.lowercased() == name.lowercased() && $0.chatID == chatID }) else {
+            try bot.sendMessage("There is an entry with that name already", to: chatID)
+            return
+        }
+        config.append(entry)
+        try ConfigParser.saveConfig(config)
+        
+        try bot.sendMessage("Added '\(name)'", to: chatID)
+    }
+    
+}

NotifierBot/Sources/Notifier/Commands/CheckCommand.swift

@@ -0,0 +1,31 @@
+//
+//  CheckCommand.swift
+//  
+//
+//  Created by Jonas Frey on 03.05.21.
+//
+
+import Foundation
+import Telegrammer
+
+struct CheckCommand: Command {
+    
+    let name = "Check"
+    let commands = ["/check"]
+    let syntax = "/check"
+    let description = "Performs a manual check if any monitored website changed"
+    let permission = BotPermission.admin
+    
+    func run(update: Update, context: BotContext?) throws {
+        let chatID = try update.chatID()
+        let args = try update.args()
+        guard args.count == 0 else {
+            try showUsage(chatID)
+            return
+        }
+        try bot.sendMessage("Starting check...", to: chatID)
+        // TODO: Do async?
+        JFUtils.shell("\(kUrlwatchTool)")
+        try bot.sendMessage("Check complete", to: chatID)
+    }
+}

NotifierBot/Sources/Notifier/Commands/Command.swift

@@ -0,0 +1,55 @@
+//
+//  Command.swift
+//  
+//
+//  Created by Jonas Frey on 30.04.21.
+//
+
+import Foundation
+import Telegrammer
+
+protocol Command {
+    
+    var name: String { get }
+    var commands: [String] { get }
+    var permission: BotPermission { get }
+    var syntax: String { get }
+    var usage: String { get }
+    var description: String { get }
+    
+    var handler: Handler { get }
+    
+    func run(update: Update, context: BotContext?) throws
+    
+    func showUsage(_ chatID: Int64) throws
+}
+
+extension Command {
+    
+    var usage: String {
+        return "Usage: " + syntax
+    }
+    
+    var handler: Handler {
+        CommandHandler(name: name, commands: commands, callback: { (update, context) in
+            do {
+                // Check if the sender is a user
+                guard let userID = update.message?.from?.id else {
+                    throw JFBotError.noUserID
+                }
+                // Check if the user has the required permissions
+                guard PermissionHandler.shared.hasPermission(userID: userID, permission: self.permission) else {
+                    throw JFBotError.noPermissions(self)
+                }
+                // Run the command
+                try self.run(update: update, context: context)
+            } catch let error as JFBotError {
+                JFErrorHandler.shared.handle(error, update: update)
+            }
+        })
+    }
+    
+    func showUsage(_ chatID: Int64) throws {
+        try bot.sendMessage(usage, to: chatID)
+    }
+}

NotifierBot/Sources/Notifier/Commands/FetchCommand.swift

@@ -0,0 +1,42 @@
+//
+//  FetchCommand.swift
+//  
+//
+//  Created by Jonas Frey on 03.05.21.
+//
+
+import Foundation
+import Telegrammer
+
+struct FetchCommand: Command {
+    
+    let name = "Fetch"
+    let commands = ["/fetch"]
+    let syntax = "/fetch <name>"
+    let description = "Takes a screenshot with the stored settings and sends it into this chat"
+    let permission = BotPermission.mod
+    
+    func run(update: Update, context: BotContext?) throws {
+        let chatID = try update.chatID()
+        let args = try update.args()
+        guard args.count > 0 else {
+            try showUsage(chatID)
+            return
+        }
+        let name = args.joined(separator: " ")
+        // Get the settings
+        let config = try ConfigParser.getConfig()
+        let entry = config.first(where: { $0.name.lowercased() == name.lowercased() && $0.chatID == chatID })
+        guard entry != nil else {
+            try bot.sendMessage("There is no entry with the name '\(name)'", to: chatID)
+            return
+        }
+        DispatchQueue.main.async {
+            // Take the screenshot
+            JFUtils.takeScreenshot(url: entry!.url, filename: "/tmp/screenshot.png", area: entry!.area)
+            // Send the screenshot as file
+            // Use the script, because its easier than sending the file in swift
+            JFUtils.sendFile(path: "/tmp/screenshot.png", chatID: chatID)
+        }
+    }
+}

NotifierBot/Sources/Notifier/Commands/FetchURLCommand.swift

@@ -0,0 +1,48 @@
+//
+//  File.swift
+//  
+//
+//  Created by Jonas Frey on 03.05.21.
+//
+
+import Foundation
+import Telegrammer
+
+struct FetchURLCommand: Command {
+    
+    let name = "Fetch URL"
+    let commands = ["/fetchurl"]
+    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
+    
+    func run(update: Update, context: BotContext?) throws {
+        let chatID = try update.chatID()
+        let args = try update.args()
+        guard args.count == 1 || args.count == 5 else {
+            try showUsage(chatID)
+            return
+        }
+        let url = args[0]
+        var area: Rectangle = .zero
+        if args.count == 5 {
+            let x = Int(args[1])
+            let y = Int(args[2])
+            let width = Int(args[3])
+            let height = Int(args[4])
+            guard x != nil && y != nil && width != nil && height != nil else {
+                try bot.sendMessage("Please enter a valid Offset and Size", to: chatID)
+                return
+            }
+            area = Rectangle(x: x!, y: y!, width: width!, height: height!)
+        }
+        guard url.hasPrefix("http") else {
+            try bot.sendMessage("Please enter a valid URL, starting with 'http://' or 'https://'", to: chatID)
+            return
+        }
+        DispatchQueue.main.async {
+            JFUtils.takeScreenshot(url: url, filename: "/tmp/screenshot.png", area: area)
+            JFUtils.sendFile(path: "/tmp/screenshot.png", chatID: chatID)
+        }
+    }
+}

NotifierBot/Sources/Notifier/Commands/GetPermissionsCommand.swift

@@ -0,0 +1,52 @@
+//
+//  GetPermissionsCommand.swift
+//  
+//
+//  Created by Jonas Frey on 03.05.21.
+//
+
+import Foundation
+import Telegrammer
+
+struct GetPermissionsCommand: Command {
+    
+    let name = "Get Permissions"
+    let commands = ["/getpermissions"]
+    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
+    
+    func run(update: Update, context: BotContext?) throws {
+        let chatID = try update.chatID()
+        let args = try update.args()
+        guard args.count <= 1 else {
+            try showUsage(chatID)
+            return
+        }
+        
+        // TODO: Check if it works with mentions
+        let _ = update.message?.entities
+        
+        let userID: Int64!
+        let username: String!
+        if args.count == 0 {
+            // Use the reply message
+            guard let user = update.message?.replyToMessage?.from, !user.isBot else {
+                try bot.sendMessage("Error: Please respond to a message of a user.", to: chatID)
+                return
+            }
+            userID = user.id
+            username = user.username ?? "<Unknown>"
+        } else {
+            // Use the ID provided
+            guard let id = Int64(args[0].trimmingCharacters(in: .whitespaces)) else {
+                try bot.sendMessage("Error: Please provide the user ID as an integer.", to: chatID)
+                return
+            }
+            userID = id
+            username = "\(id)"
+        }
+        let level = ConfigParser.shared.permissionGroup(user: userID)
+        try bot.sendMessage("The permission level of \(username!) is *\(level.rawValue)*.", to: chatID)
+    }
+}