From 315e2510d577b7303f4b8204a4555aad26bc41a3 Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Tue, 12 Dec 2023 13:07:40 -0700 Subject: move files --- Package.swift | 6 + README.md | 3 +- Sources/Helpers.swift | 9 - Sources/fileTypes.swift | 133 ------------ Sources/gopherHandler.swift | 353 ------------------------------- Sources/server.swift | 94 -------- Sources/swift-gopher/fileTypes.swift | 133 ++++++++++++ Sources/swift-gopher/gopherHandler.swift | 353 +++++++++++++++++++++++++++++++ Sources/swift-gopher/helpers.swift | 9 + Sources/swift-gopher/server.swift | 94 ++++++++ 10 files changed, 597 insertions(+), 590 deletions(-) delete mode 100644 Sources/Helpers.swift delete mode 100644 Sources/fileTypes.swift delete mode 100644 Sources/gopherHandler.swift delete mode 100644 Sources/server.swift create mode 100644 Sources/swift-gopher/fileTypes.swift create mode 100644 Sources/swift-gopher/gopherHandler.swift create mode 100644 Sources/swift-gopher/helpers.swift create mode 100644 Sources/swift-gopher/server.swift diff --git a/Package.swift b/Package.swift index 0527f01..4fdc0ea 100644 --- a/Package.swift +++ b/Package.swift @@ -27,6 +27,12 @@ let package = Package( .product(name: "ArgumentParser", package: "swift-argument-parser"), .product(name: "Logging", package: "swift-log"), ] + ), + .target( + name: "swiftGopherClient", + dependencies: [ + .product(name: "NIO", package: "swift-nio") + ] ) ] ) diff --git a/README.md b/README.md index e237947..461cef8 100644 --- a/README.md +++ b/README.md @@ -104,9 +104,10 @@ Although, `swift-gopher` does not currently have a native HTTP handler, you can - [ ] Support Gemini Protocol - [ ] Add a client library - [ ] Add native HTTP handler +- [ ] Guestbook ## Generating Docs ```bash swift package --allow-writing-to-directory docs generate-documentation --transform-for-static-hosting --target swift-gopher --output-path docs --hosting-base-path swift-gopher -``` \ No newline at end of file +``` diff --git a/Sources/Helpers.swift b/Sources/Helpers.swift deleted file mode 100644 index caf841b..0000000 --- a/Sources/Helpers.swift +++ /dev/null @@ -1,9 +0,0 @@ -import Foundation - -let versionString = "generated and served by swift-gopher/1.0.0" // TODO: Handle automatic versioning - -func buildVersionStringResponse() -> String { - let repeatedString = "i" + String(repeating: "-", count: 80) + "\t\terror.host\t1\r\n" - let versionResponseString = "i" + String(repeating: " ", count: 80 - versionString.count) + versionString + "\t\terror.host\t1\r\n" - return "\(repeatedString)\(versionResponseString)" -} \ No newline at end of file diff --git a/Sources/fileTypes.swift b/Sources/fileTypes.swift deleted file mode 100644 index 221b7b2..0000000 --- a/Sources/fileTypes.swift +++ /dev/null @@ -1,133 +0,0 @@ -// -// fileTypes.swift -// -// -// Created by Navan Chauhan on 12/3/23. -// - -import Foundation - -enum ResponseType { - case string(String) - case data(Data) -} - -enum gopherFileType { - case text - case directory - case nameserver - case error - case binhex - case bindos - case uuencoded - case indexSearch - case telnet - case binary - case redundantServer - case tn3270Session - case gif - case image - case bitmap - case movie - case sound - case doc - case html - case message - case png - case rtf - case wavfile - case pdf - case xml -} - -func getFileType(fileExtension: String) -> gopherFileType { - switch fileExtension { - case "txt": - return .text - case "md": - return .text - case "html": - return .html - case "pdf": - return .pdf - case "png": - return .png - case "gif": - return .gif - case "jpg": - return .image - case "jpeg": - return .image - case "mp3": - return .sound - case "wav": - return .wavfile - case "mp4": - return .movie - case "mov": - return .movie - case "avi": - return .movie - case "rtf": - return .rtf - case "xml": - return .xml - default: - return .binary - } -} - -func fileTypeToGopherItem(fileType: gopherFileType) -> String { - switch fileType { - case .text: - return "0" - case .directory: - return "1" - case .nameserver: - return "2" - case .error: - return "3" - case .binhex: - return "4" - case .bindos: - return "5" - case .uuencoded: - return "6" - case .indexSearch: - return "7" - case .telnet: - return "8" - case .binary: - return "9" - case .redundantServer: - return "+" - case .tn3270Session: - return "T" - case .gif: - return "g" - case .image: - return "I" - case .bitmap: - return "b" - case .movie: - return "M" - case .sound: - return "s" - case .doc: - return "d" - case .html: - return "h" - case .message: - return "i" - case .png: - return "p" - case .rtf: - return "t" - case .wavfile: - return "w" - case .pdf: - return "P" - case .xml: - return "x" - } -} diff --git a/Sources/gopherHandler.swift b/Sources/gopherHandler.swift deleted file mode 100644 index 00a3a30..0000000 --- a/Sources/gopherHandler.swift +++ /dev/null @@ -1,353 +0,0 @@ -import ArgumentParser -import Foundation -import Logging -import NIO - -final class GopherHandler: ChannelInboundHandler { - typealias InboundIn = ByteBuffer - typealias OutboundOut = ByteBuffer - - let gopherdata_dir: String - let gopherdata_host: String - let gopherdata_port: Int - let logger: Logger - let enableSearch: Bool - let disableGophermap: Bool - - init( - logger: Logger, - gopherdata_dir: String = "./example-gopherdata", gopherdata_host: String = "localhost", - gopherdata_port: Int = 70, enableSearch: Bool = false, - disableGophermap: Bool = false - ) { - self.gopherdata_dir = gopherdata_dir - self.gopherdata_host = gopherdata_host - self.gopherdata_port = gopherdata_port - self.logger = logger - self.enableSearch = enableSearch - self.disableGophermap = disableGophermap - } - - func channelRead(context: ChannelHandlerContext, data: NIOAny) { - let input = self.unwrapInboundIn(data) - - guard let requestString = input.getString(at: 0, length: input.readableBytes) else { - return - } - - if let remoteAddress = context.remoteAddress { - logger.info("Received request from \(remoteAddress) for '\(requestString.replacingOccurrences(of: "\r\n", with: "").replacingOccurrences(of: "\n", with: ""))'") - } else { - logger.warning("Unable to retrieve remote address") - } - - let response = processGopherRequest(requestString) - - var buffer: ByteBuffer - - switch response { - case .string(let string): - buffer = context.channel.allocator.buffer(string: string) - case .data(let data): - buffer = context.channel.allocator.buffer(bytes: data) - } - - context.writeAndFlush(self.wrapOutboundOut(buffer)).whenComplete { _ in - context.close(mode: .all, promise: nil) - } - } - - func requestHandler(path: URL) -> ResponseType { - logger.info("Handling request for '\(path.path)'") - - // Check if path is a directory or a file - let fm = FileManager.default - var isDir: ObjCBool = false - - if fm.fileExists(atPath: path.path, isDirectory: &isDir) { - if isDir.boolValue { - return .string(prepareGopherMenu(path: path)) - } else { - // Check if file is plain text or binary - let fileExtension = path.pathExtension - let fileType = getFileType(fileExtension: fileExtension) - - if fileType == .text || fileType == .html { - do { - let fileContents = try String(contentsOfFile: path.path, encoding: .utf8) - - return .string(fileContents) - } catch { - logger.error("Error reading file: \(path.path) Error: \(error)") - return .string("3Error reading file...\t\terror.host\t1\r\n") - } - } else { - // Handle binary file - do { - let fileContents = try Data(contentsOf: path) - return .data(fileContents) - } catch { - logger.error("Error reading binary file: \(path.path) Error: \(error)") - return .string("3Error reading file...\t\terror.host\t1\r\n") - } - } - - } - } else { - logger.error("Error reading directory: \(path.path) Directory does not exist.") - return .string("3Error reading file...\t\terror.host\t1\r\n") - } - - } - - func preparePath(path: String = "/") -> URL { - var sanitizedPath = sanitizeSelectorPath(path: path) - let base_dir = URL(fileURLWithPath: gopherdata_dir) - if base_dir.path.hasSuffix("/") && sanitizedPath.hasPrefix("/") { - sanitizedPath = String(sanitizedPath.dropFirst()) - } - - // Now check if there is still a prefix - if sanitizedPath.hasPrefix("/") { - sanitizedPath = String(sanitizedPath.dropFirst()) - } - - let full_path = base_dir.appendingPathComponent(sanitizedPath) - return full_path - } - - func generateGopherItem( - item_name: String, item_path: URL, item_host: String? = nil, item_port: String? = nil - ) -> String { - let myItemHost = item_host ?? gopherdata_host - let myItemPort = item_port ?? String(gopherdata_port) - let base_path = URL(fileURLWithPath: gopherdata_dir) - var relative_path = item_path.path.replacingOccurrences(of: base_path.path, with: "") - if !relative_path.hasPrefix("/") { - relative_path = "/\(relative_path)" - } - return "\(item_name)\t\(relative_path)\t\(myItemHost)\t\(myItemPort)\r\n" - } - - func generateGopherMap(path: URL) -> [String] { - var items: [String] = [] - - var basePath = URL(fileURLWithPath: gopherdata_dir).path - if basePath.hasSuffix("/") { - basePath = String(basePath.dropLast()) - } - - let fm = FileManager.default - do { - print("Reading directory: \(path.path)") - let itemsInDirectory = try fm.contentsOfDirectory(at: path, includingPropertiesForKeys: nil) - for item in itemsInDirectory { - let isDirectory = try item.resourceValues(forKeys: [.isDirectoryKey]).isDirectory ?? false - let name = item.lastPathComponent - if isDirectory { - items.append(generateGopherItem(item_name: "1\(name)", item_path: item)) - } else { - let fileType = getFileType(fileExtension: item.pathExtension) - let gopherFileType = fileTypeToGopherItem(fileType: fileType) - items.append(generateGopherItem(item_name: "\(gopherFileType)\(name)", item_path: item)) - } - } - } catch { - print("Error reading directory: \(path.path)") - } - return items - } - - func prepareGopherMenu(path: URL = URL(string: "/")!) -> String { - var gopherResponse: [String] = [] - - let fm = FileManager.default - - do { - let gophermap_path = path.appendingPathComponent("gophermap") - if fm.fileExists(atPath: gophermap_path.path) && !disableGophermap { - let gophermap_contents = try String(contentsOfFile: gophermap_path.path, encoding: .utf8) - let gophermap_lines = gophermap_contents.components(separatedBy: "\n") - for originalLine in gophermap_lines { - // Only keep first 80 characters - var line = String(originalLine)//.prefix(80) - if "0123456789+gIT:; 1 { - if line.hasSuffix("\n") { - line = String(line.dropLast()) - } - if line.prefix(1) == "i" { - gopherResponse.append("\(line)\t\terror.host\t1\r\n") - continue - } - - let regex = try! NSRegularExpression(pattern: "\\t+| {2,}") - let nsString = line as NSString - let range = NSRange(location: 0, length: nsString.length) - let matches = regex.matches(in: String(line), range: range) - - var lastRangeEnd = 0 - var components = [String]() - - for match in matches { - let range = NSRange( - location: lastRangeEnd, length: match.range.location - lastRangeEnd) - components.append(nsString.substring(with: range)) - lastRangeEnd = match.range.location + match.range.length - } - - if lastRangeEnd < nsString.length { - components.append(nsString.substring(from: lastRangeEnd)) - } - - if components.count < 3 { - continue - } - - let item_name = components[0] - let item_path = components[1] - let item_host = components[2] - let item_port = components.count > 3 ? components[3] : "70" - - let item_line = "\(item_name)\t\(item_path)\t\(item_host)\t\(item_port)\r\n" - gopherResponse.append(item_line) - } else { - line = line.replacingOccurrences(of: "\n", with: "") - gopherResponse.append("i\(line)\t\terror.host\t1\r\n") - } - } - } else { - print("No gophermap found for \(path.path)") - gopherResponse = generateGopherMap(path: path) - } - } catch { - logger.error("Error reading directory: \(path.path)") - gopherResponse.append("3Error reading directory...\r\n") - } - - // Append Search - if enableSearch { - let search_line = "7Search Server\t/search\t\(gopherdata_host)\t\(gopherdata_port)\r\n" - gopherResponse.append(search_line) - } - - // Append Server Info - gopherResponse.append(buildVersionStringResponse()) - - - return gopherResponse.joined(separator: "") - } - - // TODO: Refactor - func performSearch(query: String) -> String { - // Really basic search implementation - - var search_results = [String: String]() - - let fm = FileManager.default - - let base_dir = URL(fileURLWithPath: gopherdata_dir) - - let enumerator = fm.enumerator(at: base_dir, includingPropertiesForKeys: nil) - - while let file = enumerator?.nextObject() as? URL { - let file_name = file.lastPathComponent - let file_path = file.path - let file_type = - try? file.resourceValues(forKeys: [.isDirectoryKey]).isDirectory ?? false ? "1" : "0" - - if file_type == "0" { - // Check if file name or contents match the query - let file_contents = try? String(contentsOfFile: file_path, encoding: .utf8) - if file_name.lowercased().contains(query) - || (file_contents?.lowercased().contains(query) ?? false) - { - search_results[file_name] = file_path - } - } else { - // Check if directory name matches the query - if file_name.lowercased().contains(query) { - search_results[file_name] = file_path - } - } - } - - // Prepare Gopher menu with search results - var gopherResponse: [String] = [] - - for (_, file_path) in search_results { - let item_type = - try? URL(fileURLWithPath: file_path).resourceValues(forKeys: [.isDirectoryKey]).isDirectory - ?? false ? "1" : "0" - let item_host = gopherdata_host - let item_port = gopherdata_port - let item_path = file_path.replacingOccurrences(of: base_dir.path, with: "") - let item_line = - "\(item_type ?? "0")\(item_path)\t\(item_path)\t\(item_host)\t\(item_port)\r\n" - gopherResponse.append(item_line) - } - - if gopherResponse.count == 0 { - gopherResponse.append("iNo results found for the query \(query)\r\n") - } - gopherResponse.append(buildVersionStringResponse()) - return gopherResponse.joined(separator: "") - - } - - func sanitizeSelectorPath(path: String) -> String { - // Replace \r\n with empty string - var sanitizedRequest = path.replacingOccurrences(of: "\r\n", with: "") - - // Basic escape against directory traversal - while sanitizedRequest.contains("..") { - sanitizedRequest = sanitizedRequest.replacingOccurrences(of: "..", with: "") - } - - while sanitizedRequest.contains("//") { - sanitizedRequest = sanitizedRequest.replacingOccurrences(of: "//", with: "/") - } - - return sanitizedRequest - } - - func channelReadComplete(context: ChannelHandlerContext) { - context.flush() - } - - func errorCaught(context: ChannelHandlerContext, error: Error) { - print("Error: \(error)") - logger.error("Error: \(error)") - context.close(promise: nil) - } - - private func processGopherRequest(_ originalRequest: String) -> ResponseType { - var request = originalRequest - - // Fix for "Gopher" (iOS) client sending an extra \n - if request.hasSuffix("\n\n") { - request = String(request.dropLast()) - } - - if request == "\r\n" { // Empty request - return .string(prepareGopherMenu(path: preparePath())) - } - - // Again, fix for the iOS client. Might as well make my own client - if request.hasSuffix("\n") { - request = String(request.dropLast()) - } - - if request.contains("\t") { - if enableSearch { - var searchQuery = request.components(separatedBy: "\t")[1] - searchQuery = searchQuery.replacingOccurrences(of: "\r\n", with: "") - return .string(performSearch(query: searchQuery.lowercased())) - } else { - return .string("3Search is disabled on this server.\r\n") - } - } - - //TODO: Potential Bug in Gopher implementation? curl gopher://localhost:8080/new_folder/ does not work but curl gopher://localhost:8080//new_folder/ works (tested with gopher://gopher.meulie.net//EFFector/ as well) - return requestHandler(path: preparePath(path: request)) - } -} diff --git a/Sources/server.swift b/Sources/server.swift deleted file mode 100644 index c8cf97b..0000000 --- a/Sources/server.swift +++ /dev/null @@ -1,94 +0,0 @@ -// The Swift Programming Language -// https://docs.swift.org/swift-book - -import ArgumentParser -import Foundation -import Logging -import NIO - -@main -struct swiftGopher: ParsableCommand { - @Option(name: [.short, .long], help: "Hostname used for generating selectors") - var gopherHostName: String = "localhost" - @Option(name: [.short, .long]) - var host: String = "0.0.0.0" - @Option(name: [.short, .long]) - var port: Int = 8080 - @Option(name: [.customShort("d"), .long], help: "Data directory to map") - var gopherDataDir: String = "./example-gopherdata" - @Flag(help: "Disable full-text search feature") - var disableSearch: Bool = false - @Flag(help: "Disable reading gophermap files to override automatic generation") - var disableGophermap: Bool = false - - public mutating func run() throws { - let eventLoopGroup = MultiThreadedEventLoopGroup( - numberOfThreads: System.coreCount - ) - - defer { - try! eventLoopGroup.syncShutdownGracefully() - } - - let localGopherDataDir = gopherDataDir - let localGopherHostName = gopherHostName - let localPort = port - let localEnableSearch = !disableSearch - let localDisableGophermap = disableGophermap - - let logger = Logger(label: "com.navanchauhan.gopher.server") - - let serverBootstrap = ServerBootstrap( - group: eventLoopGroup - ) - .serverChannelOption( - ChannelOptions.backlog, - value: 256 - ) - .serverChannelOption( - ChannelOptions.socketOption( - .so_reuseaddr - ), - value: 1 - ) - .childChannelInitializer { channel in - channel.pipeline.addHandlers([ - BackPressureHandler(), - GopherHandler( - logger: logger, - gopherdata_dir: localGopherDataDir, - gopherdata_host: localGopherHostName, - gopherdata_port: localPort, - enableSearch: localEnableSearch, - disableGophermap: localDisableGophermap - ), - ]) - } - .childChannelOption( - ChannelOptions.socketOption( - .so_reuseaddr - ), - value: 1 - ) - .childChannelOption( - ChannelOptions.maxMessagesPerRead, - value: 16 - ) - .childChannelOption( - ChannelOptions.recvAllocator, - value: AdaptiveRecvByteBufferAllocator() - ) - - let defaultHost = host - let defaultPort = port - - let channel = try serverBootstrap.bind( - host: defaultHost, - port: defaultPort - ).wait() - - logger.info("Server started and listening on \(channel.localAddress!)") - try channel.closeFuture.wait() - logger.info("Server closed") - } -} diff --git a/Sources/swift-gopher/fileTypes.swift b/Sources/swift-gopher/fileTypes.swift new file mode 100644 index 0000000..221b7b2 --- /dev/null +++ b/Sources/swift-gopher/fileTypes.swift @@ -0,0 +1,133 @@ +// +// fileTypes.swift +// +// +// Created by Navan Chauhan on 12/3/23. +// + +import Foundation + +enum ResponseType { + case string(String) + case data(Data) +} + +enum gopherFileType { + case text + case directory + case nameserver + case error + case binhex + case bindos + case uuencoded + case indexSearch + case telnet + case binary + case redundantServer + case tn3270Session + case gif + case image + case bitmap + case movie + case sound + case doc + case html + case message + case png + case rtf + case wavfile + case pdf + case xml +} + +func getFileType(fileExtension: String) -> gopherFileType { + switch fileExtension { + case "txt": + return .text + case "md": + return .text + case "html": + return .html + case "pdf": + return .pdf + case "png": + return .png + case "gif": + return .gif + case "jpg": + return .image + case "jpeg": + return .image + case "mp3": + return .sound + case "wav": + return .wavfile + case "mp4": + return .movie + case "mov": + return .movie + case "avi": + return .movie + case "rtf": + return .rtf + case "xml": + return .xml + default: + return .binary + } +} + +func fileTypeToGopherItem(fileType: gopherFileType) -> String { + switch fileType { + case .text: + return "0" + case .directory: + return "1" + case .nameserver: + return "2" + case .error: + return "3" + case .binhex: + return "4" + case .bindos: + return "5" + case .uuencoded: + return "6" + case .indexSearch: + return "7" + case .telnet: + return "8" + case .binary: + return "9" + case .redundantServer: + return "+" + case .tn3270Session: + return "T" + case .gif: + return "g" + case .image: + return "I" + case .bitmap: + return "b" + case .movie: + return "M" + case .sound: + return "s" + case .doc: + return "d" + case .html: + return "h" + case .message: + return "i" + case .png: + return "p" + case .rtf: + return "t" + case .wavfile: + return "w" + case .pdf: + return "P" + case .xml: + return "x" + } +} diff --git a/Sources/swift-gopher/gopherHandler.swift b/Sources/swift-gopher/gopherHandler.swift new file mode 100644 index 0000000..00a3a30 --- /dev/null +++ b/Sources/swift-gopher/gopherHandler.swift @@ -0,0 +1,353 @@ +import ArgumentParser +import Foundation +import Logging +import NIO + +final class GopherHandler: ChannelInboundHandler { + typealias InboundIn = ByteBuffer + typealias OutboundOut = ByteBuffer + + let gopherdata_dir: String + let gopherdata_host: String + let gopherdata_port: Int + let logger: Logger + let enableSearch: Bool + let disableGophermap: Bool + + init( + logger: Logger, + gopherdata_dir: String = "./example-gopherdata", gopherdata_host: String = "localhost", + gopherdata_port: Int = 70, enableSearch: Bool = false, + disableGophermap: Bool = false + ) { + self.gopherdata_dir = gopherdata_dir + self.gopherdata_host = gopherdata_host + self.gopherdata_port = gopherdata_port + self.logger = logger + self.enableSearch = enableSearch + self.disableGophermap = disableGophermap + } + + func channelRead(context: ChannelHandlerContext, data: NIOAny) { + let input = self.unwrapInboundIn(data) + + guard let requestString = input.getString(at: 0, length: input.readableBytes) else { + return + } + + if let remoteAddress = context.remoteAddress { + logger.info("Received request from \(remoteAddress) for '\(requestString.replacingOccurrences(of: "\r\n", with: "").replacingOccurrences(of: "\n", with: ""))'") + } else { + logger.warning("Unable to retrieve remote address") + } + + let response = processGopherRequest(requestString) + + var buffer: ByteBuffer + + switch response { + case .string(let string): + buffer = context.channel.allocator.buffer(string: string) + case .data(let data): + buffer = context.channel.allocator.buffer(bytes: data) + } + + context.writeAndFlush(self.wrapOutboundOut(buffer)).whenComplete { _ in + context.close(mode: .all, promise: nil) + } + } + + func requestHandler(path: URL) -> ResponseType { + logger.info("Handling request for '\(path.path)'") + + // Check if path is a directory or a file + let fm = FileManager.default + var isDir: ObjCBool = false + + if fm.fileExists(atPath: path.path, isDirectory: &isDir) { + if isDir.boolValue { + return .string(prepareGopherMenu(path: path)) + } else { + // Check if file is plain text or binary + let fileExtension = path.pathExtension + let fileType = getFileType(fileExtension: fileExtension) + + if fileType == .text || fileType == .html { + do { + let fileContents = try String(contentsOfFile: path.path, encoding: .utf8) + + return .string(fileContents) + } catch { + logger.error("Error reading file: \(path.path) Error: \(error)") + return .string("3Error reading file...\t\terror.host\t1\r\n") + } + } else { + // Handle binary file + do { + let fileContents = try Data(contentsOf: path) + return .data(fileContents) + } catch { + logger.error("Error reading binary file: \(path.path) Error: \(error)") + return .string("3Error reading file...\t\terror.host\t1\r\n") + } + } + + } + } else { + logger.error("Error reading directory: \(path.path) Directory does not exist.") + return .string("3Error reading file...\t\terror.host\t1\r\n") + } + + } + + func preparePath(path: String = "/") -> URL { + var sanitizedPath = sanitizeSelectorPath(path: path) + let base_dir = URL(fileURLWithPath: gopherdata_dir) + if base_dir.path.hasSuffix("/") && sanitizedPath.hasPrefix("/") { + sanitizedPath = String(sanitizedPath.dropFirst()) + } + + // Now check if there is still a prefix + if sanitizedPath.hasPrefix("/") { + sanitizedPath = String(sanitizedPath.dropFirst()) + } + + let full_path = base_dir.appendingPathComponent(sanitizedPath) + return full_path + } + + func generateGopherItem( + item_name: String, item_path: URL, item_host: String? = nil, item_port: String? = nil + ) -> String { + let myItemHost = item_host ?? gopherdata_host + let myItemPort = item_port ?? String(gopherdata_port) + let base_path = URL(fileURLWithPath: gopherdata_dir) + var relative_path = item_path.path.replacingOccurrences(of: base_path.path, with: "") + if !relative_path.hasPrefix("/") { + relative_path = "/\(relative_path)" + } + return "\(item_name)\t\(relative_path)\t\(myItemHost)\t\(myItemPort)\r\n" + } + + func generateGopherMap(path: URL) -> [String] { + var items: [String] = [] + + var basePath = URL(fileURLWithPath: gopherdata_dir).path + if basePath.hasSuffix("/") { + basePath = String(basePath.dropLast()) + } + + let fm = FileManager.default + do { + print("Reading directory: \(path.path)") + let itemsInDirectory = try fm.contentsOfDirectory(at: path, includingPropertiesForKeys: nil) + for item in itemsInDirectory { + let isDirectory = try item.resourceValues(forKeys: [.isDirectoryKey]).isDirectory ?? false + let name = item.lastPathComponent + if isDirectory { + items.append(generateGopherItem(item_name: "1\(name)", item_path: item)) + } else { + let fileType = getFileType(fileExtension: item.pathExtension) + let gopherFileType = fileTypeToGopherItem(fileType: fileType) + items.append(generateGopherItem(item_name: "\(gopherFileType)\(name)", item_path: item)) + } + } + } catch { + print("Error reading directory: \(path.path)") + } + return items + } + + func prepareGopherMenu(path: URL = URL(string: "/")!) -> String { + var gopherResponse: [String] = [] + + let fm = FileManager.default + + do { + let gophermap_path = path.appendingPathComponent("gophermap") + if fm.fileExists(atPath: gophermap_path.path) && !disableGophermap { + let gophermap_contents = try String(contentsOfFile: gophermap_path.path, encoding: .utf8) + let gophermap_lines = gophermap_contents.components(separatedBy: "\n") + for originalLine in gophermap_lines { + // Only keep first 80 characters + var line = String(originalLine)//.prefix(80) + if "0123456789+gIT:; 1 { + if line.hasSuffix("\n") { + line = String(line.dropLast()) + } + if line.prefix(1) == "i" { + gopherResponse.append("\(line)\t\terror.host\t1\r\n") + continue + } + + let regex = try! NSRegularExpression(pattern: "\\t+| {2,}") + let nsString = line as NSString + let range = NSRange(location: 0, length: nsString.length) + let matches = regex.matches(in: String(line), range: range) + + var lastRangeEnd = 0 + var components = [String]() + + for match in matches { + let range = NSRange( + location: lastRangeEnd, length: match.range.location - lastRangeEnd) + components.append(nsString.substring(with: range)) + lastRangeEnd = match.range.location + match.range.length + } + + if lastRangeEnd < nsString.length { + components.append(nsString.substring(from: lastRangeEnd)) + } + + if components.count < 3 { + continue + } + + let item_name = components[0] + let item_path = components[1] + let item_host = components[2] + let item_port = components.count > 3 ? components[3] : "70" + + let item_line = "\(item_name)\t\(item_path)\t\(item_host)\t\(item_port)\r\n" + gopherResponse.append(item_line) + } else { + line = line.replacingOccurrences(of: "\n", with: "") + gopherResponse.append("i\(line)\t\terror.host\t1\r\n") + } + } + } else { + print("No gophermap found for \(path.path)") + gopherResponse = generateGopherMap(path: path) + } + } catch { + logger.error("Error reading directory: \(path.path)") + gopherResponse.append("3Error reading directory...\r\n") + } + + // Append Search + if enableSearch { + let search_line = "7Search Server\t/search\t\(gopherdata_host)\t\(gopherdata_port)\r\n" + gopherResponse.append(search_line) + } + + // Append Server Info + gopherResponse.append(buildVersionStringResponse()) + + + return gopherResponse.joined(separator: "") + } + + // TODO: Refactor + func performSearch(query: String) -> String { + // Really basic search implementation + + var search_results = [String: String]() + + let fm = FileManager.default + + let base_dir = URL(fileURLWithPath: gopherdata_dir) + + let enumerator = fm.enumerator(at: base_dir, includingPropertiesForKeys: nil) + + while let file = enumerator?.nextObject() as? URL { + let file_name = file.lastPathComponent + let file_path = file.path + let file_type = + try? file.resourceValues(forKeys: [.isDirectoryKey]).isDirectory ?? false ? "1" : "0" + + if file_type == "0" { + // Check if file name or contents match the query + let file_contents = try? String(contentsOfFile: file_path, encoding: .utf8) + if file_name.lowercased().contains(query) + || (file_contents?.lowercased().contains(query) ?? false) + { + search_results[file_name] = file_path + } + } else { + // Check if directory name matches the query + if file_name.lowercased().contains(query) { + search_results[file_name] = file_path + } + } + } + + // Prepare Gopher menu with search results + var gopherResponse: [String] = [] + + for (_, file_path) in search_results { + let item_type = + try? URL(fileURLWithPath: file_path).resourceValues(forKeys: [.isDirectoryKey]).isDirectory + ?? false ? "1" : "0" + let item_host = gopherdata_host + let item_port = gopherdata_port + let item_path = file_path.replacingOccurrences(of: base_dir.path, with: "") + let item_line = + "\(item_type ?? "0")\(item_path)\t\(item_path)\t\(item_host)\t\(item_port)\r\n" + gopherResponse.append(item_line) + } + + if gopherResponse.count == 0 { + gopherResponse.append("iNo results found for the query \(query)\r\n") + } + gopherResponse.append(buildVersionStringResponse()) + return gopherResponse.joined(separator: "") + + } + + func sanitizeSelectorPath(path: String) -> String { + // Replace \r\n with empty string + var sanitizedRequest = path.replacingOccurrences(of: "\r\n", with: "") + + // Basic escape against directory traversal + while sanitizedRequest.contains("..") { + sanitizedRequest = sanitizedRequest.replacingOccurrences(of: "..", with: "") + } + + while sanitizedRequest.contains("//") { + sanitizedRequest = sanitizedRequest.replacingOccurrences(of: "//", with: "/") + } + + return sanitizedRequest + } + + func channelReadComplete(context: ChannelHandlerContext) { + context.flush() + } + + func errorCaught(context: ChannelHandlerContext, error: Error) { + print("Error: \(error)") + logger.error("Error: \(error)") + context.close(promise: nil) + } + + private func processGopherRequest(_ originalRequest: String) -> ResponseType { + var request = originalRequest + + // Fix for "Gopher" (iOS) client sending an extra \n + if request.hasSuffix("\n\n") { + request = String(request.dropLast()) + } + + if request == "\r\n" { // Empty request + return .string(prepareGopherMenu(path: preparePath())) + } + + // Again, fix for the iOS client. Might as well make my own client + if request.hasSuffix("\n") { + request = String(request.dropLast()) + } + + if request.contains("\t") { + if enableSearch { + var searchQuery = request.components(separatedBy: "\t")[1] + searchQuery = searchQuery.replacingOccurrences(of: "\r\n", with: "") + return .string(performSearch(query: searchQuery.lowercased())) + } else { + return .string("3Search is disabled on this server.\r\n") + } + } + + //TODO: Potential Bug in Gopher implementation? curl gopher://localhost:8080/new_folder/ does not work but curl gopher://localhost:8080//new_folder/ works (tested with gopher://gopher.meulie.net//EFFector/ as well) + return requestHandler(path: preparePath(path: request)) + } +} diff --git a/Sources/swift-gopher/helpers.swift b/Sources/swift-gopher/helpers.swift new file mode 100644 index 0000000..caf841b --- /dev/null +++ b/Sources/swift-gopher/helpers.swift @@ -0,0 +1,9 @@ +import Foundation + +let versionString = "generated and served by swift-gopher/1.0.0" // TODO: Handle automatic versioning + +func buildVersionStringResponse() -> String { + let repeatedString = "i" + String(repeating: "-", count: 80) + "\t\terror.host\t1\r\n" + let versionResponseString = "i" + String(repeating: " ", count: 80 - versionString.count) + versionString + "\t\terror.host\t1\r\n" + return "\(repeatedString)\(versionResponseString)" +} \ No newline at end of file diff --git a/Sources/swift-gopher/server.swift b/Sources/swift-gopher/server.swift new file mode 100644 index 0000000..c8cf97b --- /dev/null +++ b/Sources/swift-gopher/server.swift @@ -0,0 +1,94 @@ +// The Swift Programming Language +// https://docs.swift.org/swift-book + +import ArgumentParser +import Foundation +import Logging +import NIO + +@main +struct swiftGopher: ParsableCommand { + @Option(name: [.short, .long], help: "Hostname used for generating selectors") + var gopherHostName: String = "localhost" + @Option(name: [.short, .long]) + var host: String = "0.0.0.0" + @Option(name: [.short, .long]) + var port: Int = 8080 + @Option(name: [.customShort("d"), .long], help: "Data directory to map") + var gopherDataDir: String = "./example-gopherdata" + @Flag(help: "Disable full-text search feature") + var disableSearch: Bool = false + @Flag(help: "Disable reading gophermap files to override automatic generation") + var disableGophermap: Bool = false + + public mutating func run() throws { + let eventLoopGroup = MultiThreadedEventLoopGroup( + numberOfThreads: System.coreCount + ) + + defer { + try! eventLoopGroup.syncShutdownGracefully() + } + + let localGopherDataDir = gopherDataDir + let localGopherHostName = gopherHostName + let localPort = port + let localEnableSearch = !disableSearch + let localDisableGophermap = disableGophermap + + let logger = Logger(label: "com.navanchauhan.gopher.server") + + let serverBootstrap = ServerBootstrap( + group: eventLoopGroup + ) + .serverChannelOption( + ChannelOptions.backlog, + value: 256 + ) + .serverChannelOption( + ChannelOptions.socketOption( + .so_reuseaddr + ), + value: 1 + ) + .childChannelInitializer { channel in + channel.pipeline.addHandlers([ + BackPressureHandler(), + GopherHandler( + logger: logger, + gopherdata_dir: localGopherDataDir, + gopherdata_host: localGopherHostName, + gopherdata_port: localPort, + enableSearch: localEnableSearch, + disableGophermap: localDisableGophermap + ), + ]) + } + .childChannelOption( + ChannelOptions.socketOption( + .so_reuseaddr + ), + value: 1 + ) + .childChannelOption( + ChannelOptions.maxMessagesPerRead, + value: 16 + ) + .childChannelOption( + ChannelOptions.recvAllocator, + value: AdaptiveRecvByteBufferAllocator() + ) + + let defaultHost = host + let defaultPort = port + + let channel = try serverBootstrap.bind( + host: defaultHost, + port: defaultPort + ).wait() + + logger.info("Server started and listening on \(channel.localAddress!)") + try channel.closeFuture.wait() + logger.info("Server closed") + } +} -- cgit v1.2.3