Add DeepL translation integration

Changelog-Added: DeepL translation integration
Closes: #522

damus/Models/DeepLPlan.swift

@@ -0,0 +1,35 @@
+//
+//  DeepLPlan.swift
+//  damus
+//
+//  Created by Terry Yiu on 2/3/23.
+//
+
+import Foundation
+
+enum DeepLPlan: String, CaseIterable, Identifiable {
+    var id: String { self.rawValue }
+
+    struct Model: Identifiable, Hashable {
+        var id: String { self.tag }
+        var tag: String
+        var displayName: String
+        var url: String
+    }
+
+    case free
+    case pro
+
+    var model: Model {
+        switch self {
+        case .free:
+            return .init(tag: self.rawValue, displayName: NSLocalizedString("Free", comment: "Dropdown option for selecting Free plan for DeepL translation service."), url: "https://api-free.deepl.com")
+        case .pro:
+            return .init(tag: self.rawValue, displayName: NSLocalizedString("Pro", comment: "Dropdown option for selecting Pro plan for DeepL translation service."), url: "https://api.deepl.com")
+        }
+    }
+
+    static var allModels: [Model] {
+        return Self.allCases.map { $0.model }
+    }
+}

damus/Models/LibreTranslateServer.swift

@@ -17,7 +17,6 @@ enum LibreTranslateServer: String, CaseIterable, Identifiable {
         var url: String?
     }
 
-    case none
     case argosopentech
     case terraprint
     case vern
@@ -25,8 +24,6 @@ enum LibreTranslateServer: String, CaseIterable, Identifiable {
 
     var model: Model {
         switch self {
-        case .none:
-            return .init(tag: self.rawValue, displayName: NSLocalizedString("None", comment: "Dropdown option for selecting no translation server."), url: nil)
         case .argosopentech:
             return .init(tag: self.rawValue, displayName: "translate.argosopentech.com", url: "https://translate.argosopentech.com")
         case .terraprint:

damus/Models/TranslationService.swift

@@ -0,0 +1,37 @@
+//
+//  TranslationService.swift
+//  damus
+//
+//  Created by Terry Yiu on 2/3/23.
+//
+
+import Foundation
+
+enum TranslationService: String, CaseIterable, Identifiable {
+    var id: String { self.rawValue }
+
+    struct Model: Identifiable, Hashable {
+        var id: String { self.tag }
+        var tag: String
+        var displayName: String
+    }
+
+    case none
+    case libretranslate
+    case deepl
+
+    var model: Model {
+        switch self {
+        case .none:
+            return .init(tag: self.rawValue, displayName: NSLocalizedString("None", comment: "Dropdown option for selecting no translation service."))
+        case .libretranslate:
+            return .init(tag: self.rawValue, displayName: NSLocalizedString("LibreTranslate (Open Source)", comment: "Dropdown option for selecting LibreTranslate as the translation service."))
+        case .deepl:
+            return .init(tag: self.rawValue, displayName: NSLocalizedString("DeepL (Proprietary, Higher Accuracy)", comment: "Dropdown option for selecting DeepL as the translation service."))
+        }
+    }
+
+    static var allModels: [Model] {
+        return Self.allCases.map { $0.model }
+    }
+}

damus/Models/UserSettingsStore.swift

@@ -34,7 +34,23 @@ func get_default_wallet(_ pubkey: String) -> Wallet {
     }
 }
 
-func get_libretranslate_server(_ pubkey: String) -> LibreTranslateServer? {
+private func get_translation_service(_ pubkey: String) -> TranslationService? {
+    guard let translation_service = UserDefaults.standard.string(forKey: "translation_service") else {
+        return nil
+    }
+
+    return TranslationService(rawValue: translation_service)
+}
+
+private func get_deepl_plan(_ pubkey: String) -> DeepLPlan? {
+    guard let server_name = UserDefaults.standard.string(forKey: "deepl_plan") else {
+        return nil
+    }
+
+    return DeepLPlan(rawValue: server_name)
+}
+
+private func get_libretranslate_server(_ pubkey: String) -> LibreTranslateServer? {
     guard let server_name = UserDefaults.standard.string(forKey: "libretranslate_server") else {
         return nil
     }
@@ -42,7 +58,7 @@ func get_libretranslate_server(_ pubkey: String) -> LibreTranslateServer? {
     return LibreTranslateServer(rawValue: server_name)
 }
 
-func get_libretranslate_url(_ pubkey: String, server: LibreTranslateServer) -> String? {
+private func get_libretranslate_url(_ pubkey: String, server: LibreTranslateServer) -> String? {
     if let url = server.model.url {
         return url
     }
@@ -69,6 +85,32 @@ class UserSettingsStore: ObservableObject {
         }
     }
 
+    @Published var translation_service: TranslationService {
+        didSet {
+            UserDefaults.standard.set(translation_service.rawValue, forKey: "translation_service")
+        }
+    }
+
+    @Published var deepl_plan: DeepLPlan {
+        didSet {
+            UserDefaults.standard.set(deepl_plan.rawValue, forKey: "deepl_plan")
+        }
+    }
+
+    @Published var deepl_api_key: String {
+        didSet {
+            do {
+                if deepl_api_key == "" {
+                    try clearDeepLApiKey()
+                } else {
+                    try saveDeepLApiKey(deepl_api_key)
+                }
+            } catch {
+                // No-op.
+            }
+        }
+    }
+
     @Published var libretranslate_server: LibreTranslateServer {
         didSet {
             if oldValue == libretranslate_server {
@@ -79,7 +121,7 @@ class UserSettingsStore: ObservableObject {
 
             libretranslate_api_key = ""
 
-            if libretranslate_server == .custom || libretranslate_server == .none {
+            if libretranslate_server == .custom {
                 libretranslate_url = ""
             } else {
                 libretranslate_url = libretranslate_server.model.url!
@@ -114,18 +156,25 @@ class UserSettingsStore: ObservableObject {
         show_wallet_selector = should_show_wallet_selector(pubkey)
 
         left_handed = UserDefaults.standard.object(forKey: "left_handed") as? Bool ?? false
-        
-        if let server = get_libretranslate_server(pubkey) {
-            self.libretranslate_server = server
-            self.libretranslate_url = get_libretranslate_url(pubkey, server: server) ?? ""
+
+        // Note from @tyiu:
+        // Default translation service is disabled by default for now until we gain some confidence that it is working well in production.
+        // Instead of throwing all Damus users onto feature immediately, allow for discovery of feature organically.
+        // Also, we are connecting to servers listed as mirrors on the official LibreTranslate GitHub README that do not require API keys.
+        // However, we have not asked them for permission to use, so we're trying to be good neighbors for now.
+        // Opportunity: spin up dedicated trusted LibreTranslate server that requires an API key for any access (or higher rate limit access).
+        if let translation_service = get_translation_service(pubkey) {
+            self.translation_service = translation_service
         } else {
-            // Note from @tyiu:
-            // Default server is disabled by default for now until we gain some confidence that it is working well in production.
-            // Instead of throwing all Damus users onto feature immediately, allow for discovery of feature organically.
-            // Also, we are connecting to servers listed as mirrors on the official LibreTranslate GitHub README that do not require API keys.
-            // However, we have not asked them for permission to use, so we're trying to be good neighbors for now.
-            // Opportunity: spin up dedicated trusted LibreTranslate server that requires an API key for any access (or higher rate limit access).
-            libretranslate_server = .none
+            self.translation_service = .none
+        }
+
+        if let libretranslate_server = get_libretranslate_server(pubkey) {
+            self.libretranslate_server = libretranslate_server
+            self.libretranslate_url = get_libretranslate_url(pubkey, server: libretranslate_server) ?? ""
+        } else {
+            // Choose a random server to distribute load.
+            libretranslate_server = .allCases.filter { $0 != .custom }.randomElement()!
             libretranslate_url = ""
         }
             
@@ -134,15 +183,46 @@ class UserSettingsStore: ObservableObject {
         } catch {
             libretranslate_api_key = ""
         }
+
+        if let deepl_plan = get_deepl_plan(pubkey) {
+            self.deepl_plan = deepl_plan
+        } else {
+            self.deepl_plan = .free
+        }
+
+        do {
+            deepl_api_key = try Vault.getPrivateKey(keychainConfiguration: DamusDeepLKeychainConfiguration())
+        } catch {
+            deepl_api_key = ""
+        }
     }
 
-    func saveLibreTranslateApiKey(_ apiKey: String) throws {
+    private func saveLibreTranslateApiKey(_ apiKey: String) throws {
         try Vault.savePrivateKey(apiKey, keychainConfiguration: DamusLibreTranslateKeychainConfiguration())
     }
 
-    func clearLibreTranslateApiKey() throws {
+    private func clearLibreTranslateApiKey() throws {
         try Vault.deletePrivateKey(keychainConfiguration: DamusLibreTranslateKeychainConfiguration())
     }
+
+    private func saveDeepLApiKey(_ apiKey: String) throws {
+        try Vault.savePrivateKey(apiKey, keychainConfiguration: DamusDeepLKeychainConfiguration())
+    }
+
+    private func clearDeepLApiKey() throws {
+        try Vault.deletePrivateKey(keychainConfiguration: DamusDeepLKeychainConfiguration())
+    }
+
+    func can_translate(_ pubkey: String) -> Bool {
+        switch translation_service {
+        case .none:
+            return false
+        case .libretranslate:
+            return URLComponents(string: libretranslate_url) != nil
+        case .deepl:
+            return deepl_api_key != ""
+        }
+    }
 }
 
 struct DamusLibreTranslateKeychainConfiguration: KeychainConfiguration {
@@ -150,3 +230,9 @@ struct DamusLibreTranslateKeychainConfiguration: KeychainConfiguration {
     var accessGroup: String? = nil
     var accountName = "libretranslate_apikey"
 }
+
+struct DamusDeepLKeychainConfiguration: KeychainConfiguration {
+    var serviceName = "damus"
+    var accessGroup: String? = nil
+    var accountName = "deepl_apikey"
+}