File: DocumentationSchemeHandler.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (101 lines) | stat: -rw-r--r-- 3,324 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See https://swift.org/LICENSE.txt for license information
 See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

import Foundation

#if canImport(WebKit)
import WebKit

public class DocumentationSchemeHandler: NSObject {
    
    public typealias FallbackResponseHandler = (URLRequest) -> (URLResponse, Data)?
    
    // The schema to support the documentation.
    public static let scheme = "doc"
    public static var fullScheme: String {
        return "\(scheme)://"
    }
    
    /// Fallback handler is called if the response data is nil.
    public var fallbackHandler: FallbackResponseHandler?
    
    /// The `FileServer` instance for serving content.
    var fileServer: FileServer
    
    /// The default file provider to serve content from memory.
    var memoryProvider = MemoryFileServerProvider()
    
    /**
     Initializes a `DocumentationSchemeHandler` with content coming from a folder.
     */
    public init(withTemplateURL templateURL:URL) {
        fileServer = FileServer(baseURL: URL(string: DocumentationSchemeHandler.fullScheme)!)
        let templateProvider = FileSystemServerProvider(directoryPath: templateURL.path)!
        fileServer.register(provider: templateProvider)
        fileServer.register(provider: memoryProvider, subPath: "/data")
    }
    
    public override init() {
        fileServer = FileServer(baseURL: URL(string: DocumentationSchemeHandler.fullScheme)!)
        fileServer.register(provider: memoryProvider)
    }
    
    /// Adds the data to the FileServer.
    public func setData(data: [String: Data]) {
        memoryProvider.removeAllFiles()
        
        for (key, value) in data {
            memoryProvider.addFile(path: key, data: value)
        }
    }
    
    /// Set the template files of the renderer.
    public func setTemplate(files: [String: Data]) {
        for (key, value) in files {
            memoryProvider.addFile(path: key, data: value)
        }
    }
    
    /// Loads the template from an existing path on disk.
    public func loadTemplate(from path: String) {
        memoryProvider.addFiles(inFolder: path)
    }
    
    /// Returns a response to a given request.
    public func response(to request: URLRequest) -> (URLResponse, Data?) {
        var (response, data) = fileServer.response(to: request)
        if data == nil, let fallbackHandler,
            let (fallbackResponse, fallbackData) = fallbackHandler(request) {
            response = fallbackResponse
            data = fallbackData
        }
        return (response, data)
    }
}

// MARK: WKURLSchemeHandler protocol
extension DocumentationSchemeHandler: WKURLSchemeHandler {

    public func webView(_ webView: WKWebView, start urlSchemeTask: WKURLSchemeTask) {
        let (response, data) = self.response(to: urlSchemeTask.request)
        urlSchemeTask.didReceive(response)
        if let data {
            urlSchemeTask.didReceive(data)
        }
        urlSchemeTask.didFinish()
    }
    
    public func webView(_ webView: WKWebView, stop urlSchemeTask: WKURLSchemeTask) {
        // TODO: add handler for a stop
    }

}

#endif