Caps-Server/Sources/App/CapServer.swift

281 lines
8.4 KiB
Swift
Raw Normal View History

2021-11-08 21:58:55 +01:00
import Foundation
import Vapor
final class CapServer {
// MARK: Paths
private let imageFolder: URL
2022-05-24 14:47:50 +02:00
/// The file where the database of caps is stored
private let dbFile: URL
2021-11-08 21:58:55 +01:00
private let classifierVersionFile: URL
2022-06-23 22:48:58 +02:00
private let classifierFile: URL
2021-11-08 21:58:55 +01:00
private let fm = FileManager.default
// MARK: Caps
2022-05-27 09:25:41 +02:00
private var writers: Set<String>
2022-06-23 22:48:58 +02:00
var classifierVersion: Int {
get {
do {
let content = try String(contentsOf: classifierVersionFile)
2022-06-24 11:53:27 +02:00
.trimmingCharacters(in: .whitespacesAndNewlines)
2022-06-24 11:49:34 +02:00
guard let value = Int(content) else {
log("Invalid classifier version: \(content)")
return 0
}
return value
2022-06-23 22:48:58 +02:00
} catch {
log("Failed to read classifier version file: \(error)")
return 0
}
}
set {
do {
try "\(newValue)".data(using: .utf8)!
.write(to: classifierVersionFile)
} catch {
log("Failed to save classifier version: \(error)")
}
}
}
2022-05-27 09:25:41 +02:00
2022-05-28 21:58:51 +02:00
/**
The time to wait for changes to be written to disk.
This delay is used to prevent file writes for each small update to the caps.
*/
private let saveDelay: TimeInterval = 1
/**
The time when a save should occur.
No save is necessary if this property is `nil`.
*/
private var nextSaveTime: Date?
2022-05-24 14:47:50 +02:00
private var caps = [Int: Cap]() {
2022-05-28 21:58:51 +02:00
didSet { scheduleSave() }
2022-05-24 14:47:50 +02:00
}
var nextClassifierVersion: Int {
2022-05-27 09:25:41 +02:00
caps.values.compactMap { $0.classifierVersion }.max() ?? 1
2022-05-24 14:47:50 +02:00
}
2021-11-08 21:58:55 +01:00
2022-05-27 09:25:41 +02:00
init(in folder: URL, writers: [String]) throws {
2021-11-08 21:58:55 +01:00
self.imageFolder = folder.appendingPathComponent("images")
2022-05-24 14:47:50 +02:00
self.dbFile = folder.appendingPathComponent("caps.json")
self.classifierVersionFile = folder.appendingPathComponent("classifier.version")
2022-06-23 22:48:58 +02:00
self.classifierFile = folder.appendingPathComponent("classifier.mlmodel")
2022-05-27 09:25:41 +02:00
self.writers = Set(writers)
2021-11-08 21:58:55 +01:00
var isDirectory: ObjCBool = false
guard fm.fileExists(atPath: folder.path, isDirectory: &isDirectory),
2022-05-24 14:47:50 +02:00
isDirectory.boolValue else {
2021-11-08 21:58:55 +01:00
log("Public directory \(folder.path) is not a folder, or doesn't exist")
throw CapError.invalidConfiguration
}
2022-05-24 14:47:50 +02:00
try loadCaps()
try updateCounts()
2021-11-08 21:58:55 +01:00
}
2022-05-24 14:47:50 +02:00
private func loadCaps() throws {
2022-10-07 21:13:21 +02:00
do {
let data = try Data(contentsOf: dbFile)
caps = try JSONDecoder().decode([Cap].self, from: data)
.reduce(into: [:]) { $0[$1.id] = $1 }
} catch {
log("Failed to load caps: \(error)")
throw error
}
2021-11-08 21:58:55 +01:00
log("\(caps.count) caps loaded")
}
2022-05-28 21:58:51 +02:00
private func scheduleSave() {
nextSaveTime = Date().addingTimeInterval(saveDelay)
2022-06-11 01:05:02 +02:00
DispatchQueue.global().asyncAfter(deadline: .now() + saveDelay) {
2022-05-28 21:58:51 +02:00
self.performScheduledSave()
}
}
private func performScheduledSave() {
guard let date = nextSaveTime else {
// No save necessary, or already saved
return
}
guard date < Date() else {
// Save pushed to future
return
}
do {
try saveCaps()
nextSaveTime = nil
} catch {
// Attempt save again
scheduleSave()
}
}
2022-05-24 14:47:50 +02:00
private func saveCaps() throws {
let data = try JSONEncoder().encode(caps.values.sorted())
try data.write(to: dbFile)
}
2021-11-08 21:58:55 +01:00
// MARK: Paths
func folder(of cap: Int) -> URL {
imageFolder.appendingPathComponent(String(format: "%04d", cap))
}
func file(of cap: Int, version: Int) -> URL {
folder(of: cap).appendingPathComponent(String(format: "%04d-%02d.jpg", cap, version))
}
2022-05-27 09:25:41 +02:00
// MARK: Authentication
func hasAuthorization(for key: String) -> Bool {
// Note: This is not a constant-time compare, so there may be an opportunity
// for timing attack here. Sets perform hashed lookups, so this may be less of an issue,
// and we're not doing anything critical in this application.
// Worst case, an unauthorized person with a lot of free time and energy to hack this system
// is able to change contents of the database, which are backed up in any case.
writers.contains(key)
}
2021-11-08 21:58:55 +01:00
// MARK: Counts
2022-05-24 14:47:50 +02:00
private func updateCounts() throws {
2022-10-07 21:13:21 +02:00
do {
caps = try caps.mapValues {
var cap = $0
cap.count = try count(of: $0.id)
return cap
}
} catch {
log("Failed to update counts: \(error)")
throw error
2022-05-24 14:47:50 +02:00
}
}
2021-11-08 21:58:55 +01:00
func countImages(in folder: URL) throws -> Int {
2022-05-24 14:47:50 +02:00
try fm.contentsOfDirectory(at: folder, includingPropertiesForKeys: nil)
.filter({ $0.pathExtension == "jpg" }).count
2021-11-08 21:58:55 +01:00
}
2022-05-24 14:47:50 +02:00
/**
Get the image count of a cap.
*/
2021-11-08 21:58:55 +01:00
func count(of cap: Int) throws -> Int {
let f = folder(of: cap)
guard fm.fileExists(atPath: f.path) else {
return 0
}
return try countImages(in: f)
}
2022-05-24 14:47:50 +02:00
2021-11-08 21:58:55 +01:00
// MARK: Images
/**
Save a cap image to disk.
Automatically creates the image name with the current image count.
- Parameter data: The image data
- Parameter cap: The id of the cap.
2022-05-24 14:47:50 +02:00
- Throws: `CapError.unknownId`, if the cap doesn't exist. `CapError.dataInconsistency` if an image already exists for the current count.
2021-11-08 21:58:55 +01:00
*/
func save(image data: Data, for cap: Int) throws {
guard caps[cap] != nil else {
2022-05-24 14:47:50 +02:00
throw CapError.unknownId
}
var id = 0
2022-06-11 01:01:24 +02:00
let capFolder = folder(of: cap)
2022-05-24 14:47:50 +02:00
var f = file(of: cap, version: id)
2022-06-11 01:01:24 +02:00
if fm.fileExists(atPath: capFolder.path) {
while fm.fileExists(atPath: f.path) {
id += 1
f = file(of: cap, version: id)
}
} else {
try fm.createDirectory(at: capFolder, withIntermediateDirectories: true)
2021-11-08 21:58:55 +01:00
}
try data.write(to: f)
2022-06-11 00:38:53 +02:00
caps[cap]!.count = try count(of: cap)
2022-05-24 14:47:50 +02:00
log("Added image \(id) for cap \(cap)")
2021-11-08 21:58:55 +01:00
}
func switchMainImage(to version: Int, for cap: Int) throws {
let file2 = file(of: cap, version: version)
guard fm.fileExists(atPath: file2.path) else {
log("No image \(version) for cap \(cap)")
throw CapError.invalidFile
}
2022-05-24 14:47:50 +02:00
caps[cap]?.mainImage = version
2021-11-08 21:58:55 +01:00
log("Switched cap \(cap) to version \(version)")
}
func addOrUpdate(_ cap: Cap) throws {
if let existingCap = caps[cap.id] {
2022-06-11 00:38:53 +02:00
update(existingCap, with: cap)
} else {
try add(cap)
}
}
private func add(_ cap: Cap) throws {
2022-06-11 00:38:53 +02:00
guard cap.mainImage == 0 else {
throw CapError.invalidData
}
2022-06-11 00:38:53 +02:00
var cap = cap
cap.count = 0
cap.classifierVersion = nextClassifierVersion
caps[cap.id] = cap
2022-05-28 22:09:29 +02:00
log("Added cap \(cap.id) '\(cap.name)'")
}
2022-06-11 00:38:53 +02:00
private func update(_ existingCap: Cap, with cap: Cap) {
var updatedCap = existingCap
if cap.name != "" {
updatedCap.name = cap.name
}
2022-05-28 22:09:29 +02:00
let url = file(of: existingCap.id, version: cap.mainImage)
if fm.fileExists(atPath: url.path) {
updatedCap.mainImage = cap.mainImage
}
if let color = cap.color {
updatedCap.color = color
}
2022-05-28 22:09:29 +02:00
caps[existingCap.id] = updatedCap
log("Updated cap \(existingCap.id)")
}
2022-06-23 22:48:58 +02:00
func updateTrainedClasses(content: String) {
let trainedCaps = content
.components(separatedBy: "\n")
.compactMap(Int.init)
2022-06-23 22:48:58 +02:00
let version = classifierVersion
for cap in trainedCaps {
if caps[cap]?.classifierVersion == nil {
caps[cap]?.classifierVersion = version
}
}
2022-06-24 11:49:34 +02:00
log("Updated \(trainedCaps.count) classifier classes")
}
2022-06-23 22:48:58 +02:00
func save(classifier: Data, version: Int) throws {
do {
2022-06-23 22:48:58 +02:00
try classifier.write(to: classifierFile)
} catch {
2022-06-23 22:48:58 +02:00
log("Failed to write classifier: \(error)")
throw Abort(.internalServerError)
}
2022-06-23 22:48:58 +02:00
classifierVersion = version
2022-06-24 11:49:34 +02:00
log("Updated classifier to version \(version)")
}
2021-11-08 21:58:55 +01:00
}