Signal-iOS/SignalMessaging/utils/CallMessageRelay.swift
Evan Hahn 370ff654e7
Change license to AGPL
Change license to AGPL

This commit:

- Updates the `LICENSE` file

- Start every file with something like:

      // Copyright YEAR_FIRST_PUBLISHED Signal Messenger, LLC
      // SPDX-License-Identifier: AGPL-3.0-only

---

First, I removed existing license headers with this Ruby 3.1.2 script:

    require 'set'

    EXTENSIONS_TO_CHECK = Set['.h', '.hpp', '.cpp', '.m', '.mm', '.pch', '.swift']

    same = 0
    different = 0

    all_files = `git ls-files`.lines.map { |line| line.strip }
    all_files.each do |relative_path|
      if relative_path == 'Pods'
        next
      end

      unless EXTENSIONS_TO_CHECK.include? File.extname(relative_path)
        next
      end

      path = File.expand_path(relative_path)

      contents = File.read(path)
      new_contents = contents.sub(/\/\/\n\/\/  Copyright .*\n\/\/\n\n/, '')

      if contents == new_contents
        same += 1
      else
        different += 1
      end

      File.write(path, new_contents)
    end

    puts "updated #{different} file(s), left #{same} untouched"

I'm sure this script could be improved, but it worked well enough.

Then, I created `Scripts/lint/lint-license-headers` and ran it to auto-
fix a lot of files. This changed the mode of some files, but I think
that's actually desirable. For example,
`SignalServiceKit/src/Util/AppContext.m` previously had a mode of
`0755/-rwxr-xr-x`, and it's now `0644/-rw-r--r--`.

Then I fixed some stragglers and updated the precommit script.

See [a similar change in the Desktop app][0].

[0]: 8bfaf598af
2022-10-13 08:25:37 -05:00

103 lines
3.9 KiB
Swift

//
// Copyright 2021 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
import Foundation
public class CallMessagePushPayload: CustomStringConvertible {
private static let identifierKey = "CallMessageRelayPayload"
public let identifier: String
fileprivate init() {
identifier = UUID().uuidString
}
public init?(_ payloadDict: [AnyHashable: Any]) {
guard let payloadId = payloadDict[Self.identifierKey] as? String else { return nil }
identifier = payloadId
}
public var payloadDict: [String: String] {
[Self.identifierKey: identifier]
}
public var description: String {
"\(type(of: self)): \(identifier.suffix(6))"
}
}
@objc
public class CallMessageRelay: NSObject {
private static let pendingCallMessageStore = SDSKeyValueStore(collection: "PendingCallMessageStore")
public static func handleVoipPayload(_ payload: CallMessagePushPayload) {
Logger.info("Handling incoming VoIP payload: \(payload)")
defer { Logger.info("Finished handling incoming VoIP payload: \(payload)") }
// Process all the pending call messages from the NSE in 1 batch.
// This should almost always be a batch of one.
databaseStorage.write { transaction in
defer { pendingCallMessageStore.removeAll(transaction: transaction) }
let pendingPayloads: [Payload]
do {
pendingPayloads = try pendingCallMessageStore.allCodableValues(transaction: transaction).sorted {
$0.envelope.timestamp < $1.envelope.timestamp
}
} catch {
owsFailDebug("Failed to read pending call messages \(error)")
return
}
Logger.info("Processing \(pendingPayloads.count) call messages relayed from the NSE.")
owsAssertDebug(pendingPayloads.count == 1, "Unexpectedly processing multiple messages from the NSE at once")
for payload in pendingPayloads {
// Pretend we are just receiving the message now.
// This ensures that if we process a very old ring message, it will correctly be considered "expired".
// "This should never happen" in normal operation, but in practice we have seen it happen,
// e.g. when there's a crash processing the queued ring message.
let delaySecondsSinceDelivery = -(payload.enqueueTimestamp?.timeIntervalSinceNow ?? 0)
let adjustedDeliveryTimestamp =
payload.serverDeliveryTimestamp + UInt64(1000 * max(0, delaySecondsSinceDelivery))
messageManager.processEnvelope(
payload.envelope,
plaintextData: payload.plaintextData,
wasReceivedByUD: payload.wasReceivedByUD,
serverDeliveryTimestamp: adjustedDeliveryTimestamp,
shouldDiscardVisibleMessages: false,
transaction: transaction
)
}
}
}
public static func enqueueCallMessageForMainApp(
envelope: SSKProtoEnvelope,
plaintextData: Data,
wasReceivedByUD: Bool,
serverDeliveryTimestamp: UInt64,
transaction: SDSAnyWriteTransaction
) throws -> CallMessagePushPayload {
let payload = Payload(
envelope: envelope,
plaintextData: plaintextData,
wasReceivedByUD: wasReceivedByUD,
serverDeliveryTimestamp: serverDeliveryTimestamp,
enqueueTimestamp: Date()
)
try pendingCallMessageStore.setCodable(payload, key: "\(envelope.timestamp)", transaction: transaction)
return CallMessagePushPayload()
}
private struct Payload: Codable {
let envelope: SSKProtoEnvelope
let plaintextData: Data
let wasReceivedByUD: Bool
let serverDeliveryTimestamp: UInt64
let enqueueTimestamp: Date?
}
}