├── README.md ├── InfomaniakNotificationsSample └── InfomaniakNotificationsSample │ ├── Assets.xcassets │ ├── Contents.json │ ├── AccentColor.colorset │ │ └── Contents.json │ └── AppIcon.appiconset │ │ └── Contents.json │ ├── Preview Content │ └── Preview Assets.xcassets │ │ └── Contents.json │ ├── InfomaniakNotificationsSample.entitlements │ ├── ContentView.swift │ └── InfomaniakNotificationsSampleApp.swift ├── file-header-template.txt ├── Sources └── InfomaniakNotifications │ ├── Subscription.swift │ ├── RegistrationInfos.swift │ ├── Topic.swift │ └── InfomaniakNotifications.swift ├── Package.swift ├── Tests └── InfomaniakNotificationsTests │ ├── Env.sample.swift │ └── InfomaniakNotificationsTests.swift ├── .gitignore ├── Package.resolved └── LICENSE.txt /README.md: -------------------------------------------------------------------------------- 1 | # InfomaniakNotifications 2 | 3 | A description of this package. 4 | -------------------------------------------------------------------------------- /InfomaniakNotificationsSample/InfomaniakNotificationsSample/Assets.xcassets/Contents.json: -------------------------------------------------------------------------------- 1 | { 2 | "info" : { 3 | "author" : "xcode", 4 | "version" : 1 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /InfomaniakNotificationsSample/InfomaniakNotificationsSample/Preview Content/Preview Assets.xcassets/Contents.json: -------------------------------------------------------------------------------- 1 | { 2 | "info" : { 3 | "author" : "xcode", 4 | "version" : 1 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /InfomaniakNotificationsSample/InfomaniakNotificationsSample/Assets.xcassets/AccentColor.colorset/Contents.json: -------------------------------------------------------------------------------- 1 | { 2 | "colors" : [ 3 | { 4 | "idiom" : "universal" 5 | } 6 | ], 7 | "info" : { 8 | "author" : "xcode", 9 | "version" : 1 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /InfomaniakNotificationsSample/InfomaniakNotificationsSample/Assets.xcassets/AppIcon.appiconset/Contents.json: -------------------------------------------------------------------------------- 1 | { 2 | "images" : [ 3 | { 4 | "idiom" : "universal", 5 | "platform" : "ios", 6 | "size" : "1024x1024" 7 | } 8 | ], 9 | "info" : { 10 | "author" : "xcode", 11 | "version" : 1 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /InfomaniakNotificationsSample/InfomaniakNotificationsSample/InfomaniakNotificationsSample.entitlements: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | aps-environment 6 | development 7 | 8 | 9 | -------------------------------------------------------------------------------- /file-header-template.txt: -------------------------------------------------------------------------------- 1 | 2 | /* 3 | Infomaniak Notifications - iOS 4 | Copyright (C) 2023 Infomaniak Network SA 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program. If not, see . 18 | */ 19 | -------------------------------------------------------------------------------- /Sources/InfomaniakNotifications/Subscription.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2023 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | import Foundation 20 | 21 | public struct Subscription: Codable, Sendable { 22 | public let token: String 23 | public let topics: [Topic] 24 | } 25 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version: 6.0 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | import PackageDescription 5 | 6 | let package = Package( 7 | name: "InfomaniakNotifications", 8 | platforms: [ 9 | .iOS(.v15), 10 | .macOS(.v11) 11 | ], 12 | products: [ 13 | .library( 14 | name: "InfomaniakNotifications", 15 | targets: ["InfomaniakNotifications"]), 16 | ], 17 | dependencies: [ 18 | .package(url: "https://github.com/Infomaniak/ios-core", .upToNextMajor(from: "18.0.0")), 19 | ], 20 | targets: [ 21 | .target( 22 | name: "InfomaniakNotifications", 23 | dependencies: [ 24 | .product(name: "InfomaniakCore", package: "ios-core"), 25 | ]), 26 | .testTarget( 27 | name: "InfomaniakNotificationsTests", 28 | dependencies: ["InfomaniakNotifications"]), 29 | ]) 30 | -------------------------------------------------------------------------------- /Tests/InfomaniakNotificationsTests/Env.sample.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2023 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | // Use this template to create your `Env` file. You will need to remove "_Sample" from the name. 20 | enum Env_Sample { 21 | static let token = "" 22 | static let userId = 0 23 | } 24 | -------------------------------------------------------------------------------- /Sources/InfomaniakNotifications/RegistrationInfos.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2023 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | #if canImport(UIKit) 20 | import UIKit 21 | #else 22 | import Foundation 23 | #endif 24 | 25 | struct RegistrationInfos: Encodable { 26 | let os = "ios" 27 | let token: String 28 | let model: String 29 | let name: String 30 | let isSandboxed: Bool 31 | var topics: [Topic] 32 | 33 | @MainActor 34 | init(token: String, topics: [Topic]) { 35 | self.topics = topics 36 | self.token = token 37 | 38 | #if canImport(UIKit) 39 | model = UIDevice().model 40 | name = UIDevice().name 41 | #else 42 | model = "Mac" 43 | name = ProcessInfo().hostName 44 | #endif 45 | 46 | #if DEBUG 47 | isSandboxed = true 48 | #else 49 | isSandboxed = false 50 | #endif 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/swiftpackagemanager,macos,xcode 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=swiftpackagemanager,macos,xcode 4 | 5 | ### macOS ### 6 | # General 7 | .DS_Store 8 | .AppleDouble 9 | .LSOverride 10 | 11 | # Icon must end with two \r 12 | Icon 13 | 14 | # Thumbnails 15 | ._* 16 | 17 | # Files that might appear in the root of a volume 18 | .DocumentRevisions-V100 19 | .fseventsd 20 | .Spotlight-V100 21 | .TemporaryItems 22 | .Trashes 23 | .VolumeIcon.icns 24 | .com.apple.timemachine.donotpresent 25 | 26 | # Directories potentially created on remote AFP share 27 | .AppleDB 28 | .AppleDesktop 29 | Network Trash Folder 30 | Temporary Items 31 | .apdisk 32 | 33 | ### SwiftPackageManager ### 34 | Packages 35 | .build/ 36 | xcuserdata 37 | DerivedData/ 38 | *.xcodeproj 39 | 40 | 41 | ### Xcode ### 42 | # Xcode 43 | # 44 | # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore 45 | 46 | ## User settings 47 | xcuserdata/ 48 | 49 | ## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9) 50 | *.xcscmblueprint 51 | *.xccheckout 52 | 53 | ## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4) 54 | build/ 55 | *.moved-aside 56 | *.pbxuser 57 | !default.pbxuser 58 | *.mode1v3 59 | !default.mode1v3 60 | *.mode2v3 61 | !default.mode2v3 62 | *.perspectivev3 63 | !default.perspectivev3 64 | 65 | ## Gcc Patch 66 | /*.gcno 67 | 68 | ### Xcode Patch ### 69 | *.xcodeproj/* 70 | !*.xcodeproj/project.pbxproj 71 | !*.xcodeproj/xcshareddata/ 72 | !*.xcworkspace/contents.xcworkspacedata 73 | **/xcshareddata/WorkspaceSettings.xcsettings 74 | 75 | # End of https://www.toptal.com/developers/gitignore/api/swiftpackagemanager,macos,xcode 76 | 77 | ## Tests Env file 78 | Env.swift -------------------------------------------------------------------------------- /Sources/InfomaniakNotifications/Topic.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2025 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | import Foundation 20 | 21 | public struct Topic: ExpressibleByStringLiteral, Sendable, Codable, Hashable, Equatable { 22 | let rawValue: String 23 | 24 | public init(stringLiteral value: StringLiteralType) { 25 | rawValue = value 26 | } 27 | 28 | public init(rawValue: String) { 29 | self.rawValue = rawValue 30 | } 31 | 32 | public func encode(to encoder: any Encoder) throws { 33 | var container = encoder.singleValueContainer() 34 | try container.encode(rawValue) 35 | } 36 | 37 | public init(from decoder: any Decoder) throws { 38 | let container = try decoder.singleValueContainer() 39 | rawValue = try container.decode(String.self) 40 | } 41 | } 42 | 43 | extension Collection where Element == Topic { 44 | func isEqualToTopics(_ other: [Topic]) -> Bool { 45 | let sortedSelf = sorted { $0.rawValue < $1.rawValue } 46 | let sortedOther = other.sorted { $0.rawValue < $1.rawValue } 47 | return sortedSelf == sortedOther 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /Package.resolved: -------------------------------------------------------------------------------- 1 | { 2 | "originHash" : "7951d18631f54ac1f778d49293bded97984b138f0e9f1ac6290f6e915b9cbd5c", 3 | "pins" : [ 4 | { 5 | "identity" : "alamofire", 6 | "kind" : "remoteSourceControl", 7 | "location" : "https://github.com/Alamofire/Alamofire", 8 | "state" : { 9 | "revision" : "513364f870f6bfc468f9d2ff0a95caccc10044c5", 10 | "version" : "5.10.2" 11 | } 12 | }, 13 | { 14 | "identity" : "ios-core", 15 | "kind" : "remoteSourceControl", 16 | "location" : "https://github.com/Infomaniak/ios-core", 17 | "state" : { 18 | "revision" : "ab299bc6aec7dcc0461792a6c61bcd1126f4dde5", 19 | "version" : "18.0.0" 20 | } 21 | }, 22 | { 23 | "identity" : "ios-dependency-injection", 24 | "kind" : "remoteSourceControl", 25 | "location" : "https://github.com/Infomaniak/ios-dependency-injection", 26 | "state" : { 27 | "revision" : "7d127ead20bbb4a6a39ca60e6dc32e580197b59e", 28 | "version" : "2.0.2" 29 | } 30 | }, 31 | { 32 | "identity" : "ios-login", 33 | "kind" : "remoteSourceControl", 34 | "location" : "https://github.com/Infomaniak/ios-login", 35 | "state" : { 36 | "revision" : "d3c8fa9dd7ea7e44a1a741b58d1036d4a7989588", 37 | "version" : "7.2.0" 38 | } 39 | }, 40 | { 41 | "identity" : "osinfo", 42 | "kind" : "remoteSourceControl", 43 | "location" : "https://github.com/MarcoEidinger/OSInfo.git", 44 | "state" : { 45 | "revision" : "54fd6673923ef5966268918152235b0e15ed057c", 46 | "version" : "1.0.1" 47 | } 48 | }, 49 | { 50 | "identity" : "realm-core", 51 | "kind" : "remoteSourceControl", 52 | "location" : "https://github.com/realm/realm-core.git", 53 | "state" : { 54 | "revision" : "85eeca41654cc9070ad81a21a4b1d153ad467c33", 55 | "version" : "14.13.1" 56 | } 57 | }, 58 | { 59 | "identity" : "realm-swift", 60 | "kind" : "remoteSourceControl", 61 | "location" : "https://github.com/realm/realm-swift", 62 | "state" : { 63 | "revision" : "a3abcdf95a3176f5ad990239920aad4ef86e00de", 64 | "version" : "10.54.2" 65 | } 66 | }, 67 | { 68 | "identity" : "sentry-cocoa", 69 | "kind" : "remoteSourceControl", 70 | "location" : "https://github.com/getsentry/sentry-cocoa", 71 | "state" : { 72 | "revision" : "0c34e4da899a1dd9183db04082d1ceb6e9c2b301", 73 | "version" : "8.44.0" 74 | } 75 | } 76 | ], 77 | "version" : 3 78 | } 79 | -------------------------------------------------------------------------------- /InfomaniakNotificationsSample/InfomaniakNotificationsSample/ContentView.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2023 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | import InfomaniakCore 20 | import InfomaniakDI 21 | import InfomaniakLogin 22 | import InfomaniakNotifications 23 | import SwiftUI 24 | 25 | class EmptyRefreshTokenDelegate: RefreshTokenDelegate { 26 | func didUpdateToken(newToken: InfomaniakCore.ApiToken, oldToken: InfomaniakCore.ApiToken) {} 27 | 28 | func didFailRefreshToken(_ token: InfomaniakCore.ApiToken) {} 29 | } 30 | 31 | struct ContentView: View { 32 | @EnvironmentObject var appDelegate: AppDelegate 33 | @InjectService var login: InfomaniakLogin 34 | 35 | var body: some View { 36 | VStack { 37 | Button("Login & Register notifications") { 38 | login.asWebAuthenticationLoginFrom { result in 39 | switch result { 40 | case .success(let success): 41 | login.getApiTokenUsing(code: success.code, codeVerifier: success.verifier) { token, _ in 42 | guard let token else { return } 43 | let apiFetcher = ApiFetcher() 44 | apiFetcher.setToken(token, delegate: EmptyRefreshTokenDelegate()) 45 | DispatchQueue.main.async { 46 | appDelegate.apiFetcher = apiFetcher 47 | 48 | UIApplication.shared.registerForRemoteNotifications() 49 | } 50 | } 51 | case .failure(let failure): 52 | break 53 | } 54 | } 55 | } 56 | } 57 | .padding() 58 | } 59 | } 60 | 61 | struct ContentView_Previews: PreviewProvider { 62 | static var previews: some View { 63 | ContentView() 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /InfomaniakNotificationsSample/InfomaniakNotificationsSample/InfomaniakNotificationsSampleApp.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2023 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | import InfomaniakCore 20 | import InfomaniakDI 21 | import InfomaniakLogin 22 | import InfomaniakNotifications 23 | import SwiftUI 24 | 25 | @main 26 | struct InfomaniakNotificationsSampleApp: App { 27 | @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate 28 | 29 | init() { 30 | let mailClientId = "E90BC22D-67A8-452C-BE93-28DA33588CA4" 31 | let mailRedirectUri = "com.infomaniak.mail://oauth2redirect" 32 | let loginFactory = Factory(type: InfomaniakLogin.self) { _, _ in 33 | InfomaniakLogin(clientId: mailClientId, redirectUri: mailRedirectUri) 34 | } 35 | 36 | let networkLogin = Factory(type: InfomaniakNetworkLogin.self) { _, _ in 37 | InfomaniakNetworkLogin(clientId: mailClientId, redirectUri: mailRedirectUri) 38 | } 39 | 40 | let notificationFactory = Factory(type: InfomaniakNotifications.self) { _, _ in 41 | InfomaniakNotifications() 42 | } 43 | 44 | do { 45 | try SimpleResolver.sharedResolver.store(factory: loginFactory) 46 | try SimpleResolver.sharedResolver.store(factory: networkLogin) 47 | try SimpleResolver.sharedResolver.store(factory: notificationFactory) 48 | } 49 | catch { 50 | fatalError("unexpected DI error \(error)") 51 | } 52 | } 53 | 54 | var body: some Scene { 55 | WindowGroup { 56 | ContentView() 57 | } 58 | } 59 | } 60 | 61 | class AppDelegate: NSObject, UIApplicationDelegate, ObservableObject { 62 | var apiFetcher: ApiFetcher? 63 | func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { 64 | guard let apiFetcher else { return } 65 | let notificationsService = InjectService().wrappedValue 66 | Task { 67 | await notificationsService.registerUserForRemoteNotificationsIfNeeded(tokenData: deviceToken, userApiFetcher: apiFetcher) 68 | } 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /Tests/InfomaniakNotificationsTests/InfomaniakNotificationsTests.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2023 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | import InfomaniakCore 20 | import InfomaniakDI 21 | import InfomaniakLogin 22 | @testable import InfomaniakNotifications 23 | import XCTest 24 | 25 | class FakeTokenDelegate: RefreshTokenDelegate { 26 | func didUpdateToken(newToken: ApiToken, oldToken: ApiToken) {} 27 | 28 | func didFailRefreshToken(_ token: ApiToken) {} 29 | } 30 | 31 | final class InfomaniakNotificationsTests: XCTestCase { 32 | private static let token = ApiToken(accessToken: Env.token, 33 | expiresIn: Int.max, 34 | refreshToken: "", 35 | scope: "", 36 | tokenType: "", 37 | userId: Env.userId, 38 | expirationDate: Date(timeIntervalSinceNow: TimeInterval(Int.max))) 39 | 40 | private var apiFetcher: ApiFetcher! 41 | private static let fakeAPNSToken = "aabbcc" 42 | private static let fakeAPNSTokenData = fakeAPNSToken.data(using: .utf8)! 43 | 44 | override class func setUp() { 45 | let factory = Factory(type: InfomaniakNetworkLogin.self) { _, _ in 46 | // We don't need InfomaniakNetworkLogin but it is injected in the ApiFetcher 47 | InfomaniakNetworkLogin(config: .init(clientId: "")) 48 | } 49 | SimpleResolver.sharedResolver.store(factory: factory) 50 | } 51 | 52 | override func setUp() { 53 | apiFetcher = ApiFetcher() 54 | apiFetcher.setToken(InfomaniakNotificationsTests.token, delegate: FakeTokenDelegate()) 55 | } 56 | 57 | func testApiRegistration() async throws { 58 | let registrationInfos = await RegistrationInfos(token: InfomaniakNotificationsTests.fakeAPNSToken, topics: ["test1"]) 59 | let registrationResult = try await apiFetcher.registerForNotifications(registrationInfos: registrationInfos) 60 | XCTAssertTrue(registrationResult, "Registration shouldn't fail") 61 | } 62 | 63 | func testRegisterDeviceTokenIfNeeded() async throws { 64 | let notificationsService = InfomaniakNotifications() 65 | await notificationsService.updateRemoteNotificationsToken( 66 | tokenData: InfomaniakNotificationsTests.fakeAPNSTokenData, 67 | userApiFetcher: apiFetcher, 68 | updatePolicy: .ifModified 69 | ) 70 | let registeredToken = await notificationsService.userSubscriptionsStore 71 | .subscriptionForUser(id: apiFetcher.currentToken!.userId) 72 | XCTAssertNotNil(registeredToken, "Registered token shouldn't be nil") 73 | } 74 | 75 | func testUpdateTopics() async throws { 76 | let notificationsService = InfomaniakNotifications() 77 | let testTopics: [Topic] = ["topic1", "topic2"] 78 | await notificationsService.removeStoredTokenFor(userId: apiFetcher.currentToken!.userId) 79 | 80 | await notificationsService.updateTopicsIfNeeded(testTopics, userApiFetcher: apiFetcher) 81 | let storedSubscription = await notificationsService.userSubscriptionsStore 82 | .subscriptionForUser(id: apiFetcher.currentToken!.userId) 83 | XCTAssertNotNil(storedSubscription, "Stored subscription shouldn't be null") 84 | XCTAssertEqual(storedSubscription?.topics, testTopics, "Stored topics are not matching") 85 | XCTAssertTrue(storedSubscription?.token.isEmpty == true, "Stored token should be empty") 86 | await notificationsService.updateRemoteNotificationsToken( 87 | tokenData: InfomaniakNotificationsTests.fakeAPNSTokenData, 88 | userApiFetcher: apiFetcher, 89 | updatePolicy: .ifModified 90 | ) 91 | let storedSubscriptionWithToken = await notificationsService.userSubscriptionsStore 92 | .subscriptionForUser(id: apiFetcher.currentToken!.userId) 93 | XCTAssertNotNil(storedSubscriptionWithToken, "Stored subscription shouldn't be null") 94 | XCTAssertEqual(storedSubscriptionWithToken?.topics, testTopics, "Stored topics are not matching") 95 | XCTAssertTrue(storedSubscriptionWithToken?.token.isEmpty == false, "Stored token shouldn't be nil") 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /Sources/InfomaniakNotifications/InfomaniakNotifications.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Infomaniak Notifications - iOS 3 | Copyright (C) 2023 Infomaniak Network SA 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | import Foundation 20 | import InfomaniakCore 21 | import InfomaniakDI 22 | 23 | public extension Endpoint { 24 | static var registerDevice: Endpoint { 25 | return .baseV1.appending(path: "/devices/register") 26 | } 27 | } 28 | 29 | extension ApiFetcher { 30 | func registerForNotifications(registrationInfos: RegistrationInfos) async throws -> Bool { 31 | try await perform(request: authenticatedRequest(.registerDevice, method: .post, parameters: registrationInfos)) 32 | } 33 | } 34 | 35 | actor UserSubscriptionStore { 36 | private let registeredUsersKey = "registeredUsers" 37 | private let jsonEncoder = JSONEncoder() 38 | private let userDefaults: UserDefaults 39 | var registeredUsers = [String: Subscription]() 40 | 41 | init(appGroup: String?) { 42 | if let appGroup, 43 | let appGroupDefaults = UserDefaults(suiteName: appGroup) { 44 | userDefaults = appGroupDefaults 45 | } else { 46 | userDefaults = UserDefaults.standard 47 | } 48 | guard let registeredUsersData = userDefaults.dictionary(forKey: registeredUsersKey) as? [String: Data] 49 | else { return } 50 | let jsonDecoder = JSONDecoder() 51 | 52 | for registeredUserData in registeredUsersData { 53 | if let registeredUser = try? jsonDecoder.decode(Subscription.self, from: registeredUserData.value) { 54 | registeredUsers[registeredUserData.key] = registeredUser 55 | } 56 | } 57 | } 58 | 59 | func saveRegisteredUsers() { 60 | var rawRegisteredUsers = [String: Data]() 61 | for registeredUser in registeredUsers { 62 | rawRegisteredUsers[registeredUser.key] = try? jsonEncoder.encode(registeredUser.value) 63 | } 64 | userDefaults.set(rawRegisteredUsers, forKey: registeredUsersKey) 65 | } 66 | 67 | func saveSubscriptionForUser(id: Int, subscription: Subscription) { 68 | registeredUsers["\(id)"] = subscription 69 | saveRegisteredUsers() 70 | } 71 | 72 | func subscriptionForUser(id: Int) -> Subscription? { 73 | return registeredUsers["\(id)"] 74 | } 75 | 76 | func removeSubscription(for userId: Int) { 77 | registeredUsers["\(userId)"] = nil 78 | saveRegisteredUsers() 79 | } 80 | } 81 | 82 | public protocol InfomaniakNotifiable { 83 | /// Get the current Subscription for a given user 84 | func subscriptionForUser(id: Int) async -> Subscription? 85 | /// Register topics for a user 86 | func updateTopicsIfNeeded(_ topics: [Topic], userApiFetcher: ApiFetcher) async 87 | /// Register the user for remote notifications using the given token 88 | func updateRemoteNotificationsToken(tokenData: Data, userApiFetcher: ApiFetcher, updatePolicy: TokenUpdatePolicy) async 89 | /// After logging out manually remove the token for a given user 90 | func removeStoredTokenFor(userId: Int) async 91 | } 92 | 93 | public enum TokenUpdatePolicy { 94 | /// Always send the token and topics to the server 95 | case always 96 | /// Send the token and topics to the server only if they were modified 97 | case ifModified 98 | } 99 | 100 | public struct InfomaniakNotifications: Sendable, InfomaniakNotifiable { 101 | let userSubscriptionsStore: UserSubscriptionStore 102 | 103 | public init(appGroup: String? = nil) { 104 | userSubscriptionsStore = UserSubscriptionStore(appGroup: appGroup) 105 | } 106 | 107 | func registerAndSave(newSubscription: Subscription, userApiFetcher: ApiFetcher) async { 108 | guard let userId = userApiFetcher.currentToken?.userId else { 109 | return 110 | } 111 | 112 | guard !newSubscription.token.isEmpty else { 113 | // We will send topics when we get an APNS token 114 | await userSubscriptionsStore.saveSubscriptionForUser(id: userId, subscription: newSubscription) 115 | return 116 | } 117 | 118 | do { 119 | let registrationInfos = await RegistrationInfos(token: newSubscription.token, topics: newSubscription.topics) 120 | let success = try await userApiFetcher.registerForNotifications(registrationInfos: registrationInfos) 121 | if success { 122 | await userSubscriptionsStore.saveSubscriptionForUser(id: userId, subscription: newSubscription) 123 | } 124 | } catch { 125 | // Fail silently, will be retried next time registerAndSave is called 126 | } 127 | } 128 | 129 | public func subscriptionForUser(id: Int) async -> Subscription? { 130 | return await userSubscriptionsStore.subscriptionForUser(id: id) 131 | } 132 | 133 | public func updateTopicsIfNeeded(_ topics: [Topic], userApiFetcher: ApiFetcher) async { 134 | guard let userId = userApiFetcher.currentToken?.userId else { 135 | return 136 | } 137 | 138 | let newUniqueTopics = Array(Set(topics)) 139 | 140 | let existingSubscription = await userSubscriptionsStore.subscriptionForUser(id: userId) 141 | 142 | guard !(existingSubscription?.topics ?? []).isEqualToTopics(newUniqueTopics) else { return } 143 | 144 | let newSubscription = Subscription(token: existingSubscription?.token ?? "", topics: newUniqueTopics) 145 | await registerAndSave(newSubscription: newSubscription, userApiFetcher: userApiFetcher) 146 | } 147 | 148 | public func updateRemoteNotificationsToken( 149 | tokenData: Data, 150 | userApiFetcher: ApiFetcher, 151 | updatePolicy: TokenUpdatePolicy 152 | ) async { 153 | guard let userId = userApiFetcher.currentToken?.userId else { 154 | return 155 | } 156 | 157 | let tokenParts = tokenData.map { data in String(format: "%02.2hhx", data) } 158 | let apnsToken = tokenParts.joined() 159 | 160 | let existingSubscription = await userSubscriptionsStore.subscriptionForUser(id: userId) 161 | 162 | if updatePolicy == .ifModified && existingSubscription?.token == apnsToken { return } 163 | 164 | let newSubscription = Subscription(token: apnsToken, topics: existingSubscription?.topics ?? []) 165 | await registerAndSave(newSubscription: newSubscription, userApiFetcher: userApiFetcher) 166 | } 167 | 168 | public func removeStoredTokenFor(userId: Int) async { 169 | await userSubscriptionsStore.removeSubscription(for: userId) 170 | } 171 | } 172 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------