Signal-iOS/SignalMessaging/utils/RefreshEvent.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

114 lines
2.9 KiB
Swift

//
// Copyright 2021 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
import Foundation
// This class can be used to coordinate the refresh of a
// value obtained from the network.
@objc
public class RefreshEvent: NSObject {
public typealias Block = () -> Void
private let block: Block
private let refreshInterval: TimeInterval
private var refreshTimer: Timer?
// The block will be performed with a rough frequency of refreshInterval.
//
// It will not be performed if the app isn't ready, the user isn't registered,
// if the app isn't the main app, if the app isn't active.
//
// It will also be performed immediately if any of the conditions change.
public required init(refreshInterval: TimeInterval,
block: @escaping Block) {
self.refreshInterval = refreshInterval
self.block = block
super.init()
AppReadiness.runNowOrWhenAppDidBecomeReadyAsync { [weak self] in
self?.ensureRefreshTimer()
}
NotificationCenter.default.addObserver(
self,
selector: #selector(didEnterBackground),
name: .OWSApplicationDidEnterBackground,
object: nil
)
NotificationCenter.default.addObserver(
self,
selector: #selector(didBecomeActive),
name: .OWSApplicationDidBecomeActive,
object: nil
)
NotificationCenter.default.addObserver(
self,
selector: #selector(fireEvent),
name: SSKReachability.owsReachabilityDidChange,
object: nil)
}
private var canFire: Bool {
guard AppReadiness.isAppReady,
CurrentAppContext().isMainAppAndActive,
tsAccountManager.isRegisteredAndReady else {
return false
}
return true
}
@objc
private func fireEvent() {
guard canFire else {
return
}
block()
}
@objc
private func didEnterBackground() {
AssertIsOnMainThread()
ensureRefreshTimer()
}
@objc
private func didBecomeActive() {
AssertIsOnMainThread()
ensureRefreshTimer()
}
private func ensureRefreshTimer() {
guard canFire else {
stopRefreshTimer()
return
}
startRefreshTimer()
}
private func stopRefreshTimer() {
refreshTimer?.invalidate()
refreshTimer = nil
}
private func startRefreshTimer() {
guard refreshTimer == nil else {
return
}
refreshTimer = WeakTimer.scheduledTimer(timeInterval: refreshInterval,
target: self,
userInfo: nil,
repeats: true) { [weak self] _ in
self?.fireEvent()
}
fireEvent()
}
}