capacitor-jpush-core 0.0.1

package/ios/Sources/JPushPlugin/JPushPlugin.swift

@@ -0,0 +1,524 @@
+import Foundation
+import Capacitor
+
+/**
+ * 极光推送Capacitor插件
+ */
+
+/// JPush事件名称枚举
+enum JPushEventName {
+    static let notificationReceived = "notificationReceived"
+    static let notificationOpened = "notificationOpened"
+    static let customMessageReceived = "customMessageReceived"
+    static let registrationCompleted = "registrationCompleted"
+    static let registrationFailed = "registrationFailed"
+}
+
+// 1. 扩展 NSNotification.Name，定义专属通知名
+extension NSNotification.Name {
+    // 自定义通知名（本质是封装字符串，类型为 NSNotification.Name）
+    static let backgroundPush = NSNotification.Name("CapacitorJPushCoreBackgroundPush")
+}
+
+@objc(JPushPlugin)
+public class JPushPlugin: CAPPlugin, CAPBridgedPlugin, JPUSHRegisterDelegate {
+    public let identifier = "JPushPlugin"
+    public let jsName = "JPush"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "setupJPush", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getRegistrationID", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setAlias", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "deleteAlias", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setTags", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "addTags", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "deleteTags", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "cleanTags", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "checkPermissions", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "requestPermissions", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setBadge", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "removeAllListeners", returnType: CAPPluginReturnPromise)
+    ]
+    
+    private var registrationIdCall: CAPPluginCall?
+    private var aliasCall: CAPPluginCall?
+    private var activeClearBadge = false
+    
+    override public func load() {
+        super.load()
+        addObservers()
+        
+        // 根据配置决定是否在load时初始化JPush
+        if isIosAutoRegisterEnabled() {
+            registerJPushDelegate()
+            initializeJPush()
+        }
+    }
+    
+    deinit {
+        // 移除所有观察者，避免内存泄漏
+        NotificationCenter.default.removeObserver(self, name: .capacitorDidRegisterForRemoteNotifications, object: nil)
+        NotificationCenter.default.removeObserver(self, name: .capacitorDidFailToRegisterForRemoteNotifications, object: nil)
+        NotificationCenter.default.removeObserver(self, name: UIApplication.didBecomeActiveNotification, object: nil)
+        NotificationCenter.default.removeObserver(self, name: .backgroundPush, object: nil)
+    }
+    
+    private func registerJPushDelegate() {
+        // 注册JPUSHRegisterDelegate
+        let registerConfig = JPUSHRegisterEntity()
+        registerConfig.types = Int(JPAuthorizationOptions.alert.rawValue | JPAuthorizationOptions.badge.rawValue | JPAuthorizationOptions.sound.rawValue)
+        // 忽略主线程的警告，否则冷启动通知收不到回调。
+        JPUSHService.register(forRemoteNotificationConfig: registerConfig, delegate: self)
+    }
+    
+    // MARK: - 监听
+    
+    private func addObservers() {
+        
+        // 监听 DeviceToken 注册成功
+        NotificationCenter.default.addObserver(self, selector: #selector(deviceTokenRegistered(_:)), name: .capacitorDidRegisterForRemoteNotifications, object: nil)
+        
+        // 监听 DeviceToken 注册失败
+        NotificationCenter.default.addObserver(self, selector: #selector(deviceTokenFailToRegister(_:)), name:.capacitorDidFailToRegisterForRemoteNotifications, object: nil)
+        
+        // 监听 App 进入前台时的状态
+        NotificationCenter.default.addObserver(self, selector: #selector(appDidBecomeActive), name: UIApplication.didBecomeActiveNotification, object: nil)
+        
+        // 监听后台收到远程推送
+        NotificationCenter.default.addObserver(self, selector: #selector(didReceiveRemoteNotification(_:)), name: .backgroundPush, object: nil)
+    }
+    
+    
+    @objc private func appDidBecomeActive() {
+        // 当应用回到前台时，如果配置了activeClearBadge为true，则清除角标
+        if activeClearBadge {
+            JPushWrapper.setBadge(0)
+        }
+    }
+    
+    @objc private func backgroundPush(userInfo: [AnyHashable : Any]) {
+        JPushWrapper.handleRemoteNotification(userInfo);
+    }
+    
+    @objc private func deviceTokenRegistered(_ notification: NSNotification) {
+        // 从通知中获取 DeviceToken
+        if let deviceToken = notification.object as? Data {
+            
+            // 上报给极光
+            JPUSHService.registerDeviceToken(deviceToken)
+            
+            // 获取registrationID并透传给JS层
+            let registrationID = JPushWrapper.registrationID()
+            if !registrationID.isEmpty {
+                notifyListeners(JPushEventName.registrationCompleted, data: ["registrationID": registrationID], retainUntilConsumed: true)
+            }
+        }
+    }
+    
+    @objc private func deviceTokenFailToRegister(_ notification: NSNotification) {
+        // 从通知中获取错误信息
+        if let error = notification.object as? Error {
+            print("极光远程推送注册失败: \(error.localizedDescription)")
+            // 发送注册失败事件给JS层
+            notifyListeners(JPushEventName.registrationFailed, data: ["errorCode": -1, "errorMessage": error.localizedDescription], retainUntilConsumed: true)
+        }
+    }
+    
+    @objc private func didReceiveRemoteNotification(_ notification: NSNotification) {
+        // 从通知中获取推送数据
+        if let userInfo = notification.object as? [AnyHashable: Any] {
+            print("后台收到推送: \(userInfo)")
+            
+            // 处理推送通知
+            JPushWrapper.handleRemoteNotification(userInfo)
+            
+            // 检查是否是JPush的通知
+            if let aps = userInfo["aps"] as? [String: Any] {
+                var notificationData: [String: Any] = aps
+                
+                // 添加额外的数据
+                if let alert = aps["alert"] as? [String: String] {
+                    notificationData["title"] = alert["title"]
+                    notificationData["body"] = alert["body"]
+                } else if let alert = aps["alert"] as? String {
+                    notificationData["title"] = ""
+                    notificationData["body"] = alert
+                }
+                
+                // 添加自定义字段
+                notificationData["extras"] = userInfo.filter { $0.key as! String != "aps" }
+                
+                // 发送收到通知事件给JS层
+                notifyListeners(JPushEventName.notificationReceived, data: notificationData)
+            }
+            
+            // 处理自定义消息
+            if userInfo["msg_content"] != nil {
+                let messageData: [String: Any] = userInfo as! [String : Any]
+                notifyListeners(JPushEventName.customMessageReceived, data: messageData)
+            }
+        }
+    }
+    
+    // MARK: - 插件方法实现
+    
+    /**
+     * 初始化极光推送（私有方法）
+     */
+    private func initializeJPush() {
+        // 从Capacitor配置中读取参数
+        let config = getConfig()
+        let appKey = config.getString("appKey") ?? ""
+        let channel = config.getString("channel", "App Store")
+        let production = config.getBoolean("production", false)
+        activeClearBadge = config.getBoolean("activeClearBadge", false)
+        
+        // 初始化JPush
+        JPushWrapper.initJPush(withAppKey: appKey, channel: channel, production: production)
+    }
+    
+    private func isIosAutoRegisterEnabled() -> Bool {
+        let config = getConfig()
+        return config.getBoolean("iosAutoRegister", false)
+    }
+    
+    /**
+     * 初始化极光推送
+     */
+    @objc func setupJPush(_ call: CAPPluginCall) {
+        guard let appKey = getConfig().getString("appKey"), appKey != "" else {
+            call.reject("appKey 不能为空")
+            return
+        }
+        
+        initializeJPush()
+        call.resolve()
+    }
+    
+    /**
+     * 获取注册ID
+     */
+    @objc func getRegistrationID(_ call: CAPPluginCall) {
+        self.registrationIdCall = call
+        
+        // 获取缓存的registrationID
+        let registrationID = JPushWrapper.registrationID()
+        if !registrationID.isEmpty {
+            call.resolve(["registrationID": registrationID])
+            self.registrationIdCall = nil
+        } else {
+            // 保存call，等待注册成功后回调
+            call.keepAlive = true
+        }
+    }
+    
+    /**
+     * 设置别名
+     */
+    @objc func setAlias(_ call: CAPPluginCall) {
+        guard let alias = call.getString("alias") else {
+            call.reject("别名不能为空")
+            return
+        }
+        
+        // 获取可选的seq参数
+        let seq = call.getInt("seq")
+        
+        self.aliasCall = call
+        
+        // 设置别名
+        JPushWrapper.setAlias(alias, seq: seq) { [weak self] (success, error) in
+            guard let call = self?.aliasCall else { return }
+            
+            if success {
+                call.resolve()
+                self?.aliasCall = nil
+            } else {
+                call.reject(error?.localizedDescription ?? "别名设置失败")
+                self?.aliasCall = nil
+            }
+        }
+        
+        call.keepAlive = true
+    }
+
+    /**
+     * 删除别名
+     */
+    @objc func deleteAlias(_ call: CAPPluginCall) {
+        self.aliasCall = call
+        
+        // 获取可选的seq参数
+        let seq = call.getInt("seq")
+        
+        // 删除别名
+        JPushWrapper.deleteAlias(seq: seq) { [weak self] (success, error) in
+            guard let call = self?.aliasCall else { return }
+            
+            if success {
+                call.resolve()
+                self?.aliasCall = nil
+            } else {
+                call.reject(error?.localizedDescription ?? "别名删除失败")
+                self?.aliasCall = nil
+            }
+        }
+        
+        call.keepAlive = true
+    }
+
+    /**
+     * 设置标签（替换所有现有标签）
+     */
+    @objc func setTags(_ call: CAPPluginCall) {
+        guard let tagsArray = call.getArray("tags", String.self) else {
+            call.reject("标签不能为空")
+            return
+        }
+        
+        let tags = Set(tagsArray)
+        let seq = call.getInt("seq")
+        
+        // 设置标签
+        JPushWrapper.setTags(tags, seq: seq) { (success, error) in
+            if success {
+                call.resolve()
+            } else {
+                call.reject(error?.localizedDescription ?? "标签设置失败")
+            }
+        }
+    }
+
+    /**
+     * 添加标签
+     */
+    @objc func addTags(_ call: CAPPluginCall) {
+        guard let tagsArray = call.getArray("tags", String.self) else {
+            call.reject("标签不能为空")
+            return
+        }
+        
+        let tags = Set(tagsArray)
+        let seq = call.getInt("seq")
+        
+        // 添加标签
+        JPushWrapper.addTags(tags, seq: seq) { (success, error) in
+            if success {
+                call.resolve()
+            } else {
+                call.reject(error?.localizedDescription ?? "标签添加失败")
+            }
+        }
+    }
+
+    /**
+     * 删除标签
+     */
+    @objc func deleteTags(_ call: CAPPluginCall) {
+        guard let tagsArray = call.getArray("tags", String.self) else {
+            call.reject("标签不能为空")
+            return
+        }
+        
+        let tags = Set(tagsArray)
+        let seq = call.getInt("seq")
+        
+        // 删除标签
+        JPushWrapper.deleteTags(tags, seq: seq) { (success, error) in
+            if success {
+                call.resolve()
+            } else {
+                call.reject(error?.localizedDescription ?? "标签删除失败")
+            }
+        }
+    }
+
+    /**
+     * 清除所有标签
+     */
+    @objc func cleanTags(_ call: CAPPluginCall) {
+        // 清除所有标签
+        JPushWrapper.cleanTags() { (success, error) in
+            if success {
+                call.resolve()
+            } else {
+                call.reject(error?.localizedDescription ?? "标签清除失败")
+            }
+        }
+    }
+    
+    /**
+     * 检查权限
+     */
+    @objc public override func checkPermissions(_ call: CAPPluginCall) {
+        UNUserNotificationCenter.current().getNotificationSettings { settings in
+            DispatchQueue.main.async {
+                var permissionStatus: String = "denied"
+                
+                switch settings.authorizationStatus {
+                case .notDetermined:
+                    permissionStatus = "prompt"
+                case .authorized:
+                    permissionStatus = "granted"
+                case .denied:
+                    permissionStatus = "denied"
+                case .provisional:
+                    permissionStatus = "granted"
+                case .ephemeral:
+                    permissionStatus = "granted"
+                @unknown default:
+                    permissionStatus = "denied"
+                }
+                
+                call.resolve(["permission": permissionStatus])
+            }
+        }
+    }
+    
+    /**
+     * 请求权限
+     */
+    @objc public override func requestPermissions(_ call: CAPPluginCall) {
+        let center = UNUserNotificationCenter.current()
+        
+        center.requestAuthorization(options: [.alert, .sound, .badge]) { granted, error in
+            DispatchQueue.main.async {
+                if let error = error {
+                    call.reject("请求通知权限失败: \(error.localizedDescription)")
+                } else {
+                    let permissionStatus: String = granted ? "granted" : "denied"
+                    call.resolve(["permission": permissionStatus])
+                    
+                    // 如果用户授权，需要注册APNs
+                    if granted {
+                        DispatchQueue.main.async {
+                            UIApplication.shared.registerForRemoteNotifications()
+                        }
+                    }
+                }
+            }
+        }
+    }
+    
+    /**
+     * 设置未读角标数量
+     */
+    @objc func setBadge(_ call: CAPPluginCall) {
+        let badge = call.getInt("badge", 0)
+        
+        // 设置角标数量
+        JPushWrapper.setBadge(Int(badge))
+        
+        call.resolve()
+    }
+    
+    // MARK: - JPUSHRegisterDelegate协议方法
+    
+    /**
+     * 前台收到通知时调用
+     */
+    public func jpushNotificationCenter(_ center: UNUserNotificationCenter!, willPresent notification: UNNotification!, withCompletionHandler completionHandler: ((NSInteger) -> Void)!) {
+        
+        self.handleNotification(request: notification.request, isClick: false)
+        
+        // 显示通知（使用默认行为）
+        completionHandler(NSInteger(UNNotificationPresentationOptions.banner.rawValue | UNNotificationPresentationOptions.sound.rawValue | UNNotificationPresentationOptions.badge.rawValue))
+    }
+    
+    /**
+     * 用户点击通知时调用
+     */
+    public func jpushNotificationCenter(_ center: UNUserNotificationCenter!, didReceive response: UNNotificationResponse!, withCompletionHandler completionHandler: (() -> Void)!) {
+        
+        // 测试结论:
+        // 通过点击通知启动App， applicationState = background；App在后台时，点击通知打开App，applicationState = inactive;
+//        bridge?.showAlertWith(title: "applicationState", message: String(describing: UIApplication.shared.applicationState), buttonTitle: "confirm")
+        
+        self.handleNotification(request: response.notification.request, isClick: true)
+        
+        // 完成处理
+        completionHandler()
+    }
+    
+    /**
+     * 打开通知设置时调用（iOS 12.0+）
+     */
+    public func jpushNotificationCenter(_ center: UNUserNotificationCenter!, openSettingsFor notification: UNNotification!) {
+        // 可以在这里处理打开通知设置的逻辑
+    }
+    
+    /**
+     * 监测通知授权状态返回的结果
+     */
+    public func jpushNotificationAuthorization(_ status: JPAuthorizationStatus, withInfo info: [AnyHashable : Any]!) {
+        // 可以在这里处理通知授权状态变化的逻辑
+    }
+    
+    // MARK: - 私有方法
+    
+    private func handleNotification(request: UNNotificationRequest, isClick: Bool) {
+        let userInfo = request.content.userInfo
+        if let trigger = request.trigger, trigger.isKind(of: UNPushNotificationTrigger.self) {
+            JPushWrapper.handleRemoteNotification(userInfo)
+        }
+        
+        UNUserNotificationCenter.current().removeDeliveredNotifications(withIdentifiers: [request.identifier])
+        
+        /*
+         {
+             "mutable-content": 1,
+             "alert": {
+                 "body": "地震预警6.6级",
+                 "title": "重要情报"
+             },
+             "sound": "default",
+             "interruption-level": "active",
+             "content-available": false,
+             "badge": 1,
+             "body": "地震预警6.6级",
+             "thread-id": "",
+             "title": "重要情报",
+             "extras": {
+                 "_j_data_": {
+                     "data_msgtype": 1,
+                     "push_type": 8,
+                     "is_vip": 0
+                 },
+                 "_j_business": 1,
+                 "_j_msgid": 18102787182097624,
+                 "_j_uid": 67885102067
+             }
+         }
+         */
+        
+        // 检查是否是JPush的通知
+        if let aps = userInfo["aps"] as? [String: Any] {
+            var notificationData: [String: Any] = aps
+            
+            // 添加额外的数据
+            if let alert = aps["alert"] as? [String: String] {
+                notificationData["title"] = alert["title"]
+                notificationData["body"] = alert["body"]
+            } else if let alert = aps["alert"] as? String {
+                notificationData["title"] = ""
+                notificationData["body"] = alert
+            }
+            
+            // 添加自定义字段
+            notificationData["extras"] = userInfo.filter { $0.key as! String != "aps" }
+            
+            if isClick {
+                // 用户点击通知
+                notifyListeners(JPushEventName.notificationOpened, data: notificationData, retainUntilConsumed: true)
+            } else {
+                // 收到通知
+                notifyListeners(JPushEventName.notificationReceived, data: notificationData)
+            }
+        }
+        
+        // 处理自定义消息
+        if userInfo["msg_content"] != nil {
+            let messageData: [String: Any] = userInfo as! [String : Any]
+            notifyListeners(JPushEventName.customMessageReceived, data: messageData)
+        }
+    }
+}