// // SocketIOClient.swift // Socket.IO-Swift // // Created by Erik Little on 11/23/14. // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. import Foundation typealias NormalCallback = (AnyObject?) -> Void typealias MultipleCallback = (NSArray?) -> Void class SocketIOClient: NSObject, SRWebSocketDelegate { let socketURL:NSMutableString! let handleQueue = dispatch_queue_create("handleQueue".cStringUsingEncoding(NSUTF8StringEncoding), DISPATCH_QUEUE_SERIAL) let emitQueue = dispatch_queue_create("emitQueue".cStringUsingEncoding(NSUTF8StringEncoding), DISPATCH_QUEUE_SERIAL) private var secure = false private var handlers = [SocketEventHandler]() private var lastSocketMessage:SocketEvent? private var pingTimer:NSTimer! var closed = false var connected = false var connecting = false var io:SRWebSocket? var nsp:String? var reconnects = true var reconnecting = false var reconnectAttempts = -1 var reconnectWait = 10 var sid:String? init(socketURL:String, opts:[String: AnyObject]? = nil) { var mutURL = RegexMutable(socketURL) if mutURL["https://"].matches().count != 0 { self.secure = true } else { self.secure = false } mutURL = mutURL["http://"] ~= "" mutURL = mutURL["https://"] ~= "" self.socketURL = mutURL // Set options if opts != nil { if let reconnects = opts!["reconnects"] as? Bool { self.reconnects = reconnects } if let reconnectAttempts = opts!["reconnectAttempts"] as? Int { self.reconnectAttempts = reconnectAttempts } if let reconnectWait = opts!["reconnectWait"] as? Int { self.reconnectWait = abs(reconnectWait) } if let nsp = opts!["nsp"] as? String { self.nsp = nsp } } } // Closes the socket func close() { self.pingTimer?.invalidate() self.closed = true self.connecting = false self.connected = false self.io?.close() } // Connects to the server func connect() { if self.closed { println("Warning: This socket was previvously closed. Reopening could be dangerous. Be careful.") } self.connecting = true self.closed = false var endpoint:String if self.secure { endpoint = "wss://\(self.socketURL)/socket.io/?EIO=2&transport=websocket" } else { endpoint = "ws://\(self.socketURL)/socket.io/?EIO=2&transport=websocket" } self.io = SRWebSocket(URL: NSURL(string: endpoint)) self.io?.delegate = self self.io?.open() } // Creates a binary message, ready for sending private class func createBinaryDataForSend(data:NSData) -> NSData { var byteArray = [UInt8](count: 1, repeatedValue: 0x0) byteArray[0] = 4 var mutData = NSMutableData(bytes: &byteArray, length: 1) mutData.appendData(data) return mutData } // Sends a message with multiple args // If a message contains binary we have to send those // seperately. func emit(event:String, _ args:AnyObject...) { if !self.connected { return } dispatch_async(self.emitQueue) {self._emit(event, args)} } private func _emit(event:String, _ args:[AnyObject]) { var frame:SocketEvent var str:String var items = [AnyObject](count: args.count, repeatedValue: 1) var numberOfPlaceholders = -1 var hasBinary = false var emitDatas = [NSData]() for i in 0.. (NSArray, Bool, [NSData]) { var replacementArr = [AnyObject](count: arr.count, repeatedValue: 1) var hasBinary = false var arrayDatas = [NSData]() if placeholders == -1 { placeholders = 0 } for g in 0.. AnyObject? { if data == nil { return nil } var err:NSError? let stringData = data!.dataUsingEncoding(NSUTF8StringEncoding, allowLossyConversion: false) let parsed:AnyObject? = NSJSONSerialization.JSONObjectWithData(stringData!, options: NSJSONReadingOptions.AllowFragments, error: &err) if err != nil { // println(err) return nil } return parsed } // Parses a NSDictionary, looking for NSData objects private class func parseNSDictionary(dict:NSDictionary, var placeholders:Int) -> (NSDictionary, Bool, [NSData]) { var returnDict = NSMutableDictionary() var hasBinary = false if placeholders == -1 { placeholders = 0 } var returnDatas = [NSData]() for (key, value) in dict { if let binaryData = value as? NSData { hasBinary = true let sendData = self.createBinaryDataForSend(binaryData) returnDatas.append(sendData) returnDict[key as! String] = ["_placeholder": true, "num": placeholders++] } else if let arr = value as? NSArray { let (replace, hadBinary, arrDatas) = self.parseArray(arr, placeholders: placeholders) if hadBinary { hasBinary = true returnDict[key as! String] = replace placeholders += arrDatas.count returnDatas.extend(arrDatas) } else { returnDict[key as! String] = arr } } else if let dict = value as? NSDictionary { // Recursive let (nestDict, hadBinary, nestDatas) = self.parseNSDictionary(dict, placeholders: placeholders) if hadBinary { hasBinary = true returnDict[key as! String] = nestDict placeholders += nestDatas.count returnDatas.extend(nestDatas) } else { returnDict[key as! String] = dict } } else { returnDict[key as! String] = value } } return (returnDict, hasBinary, returnDatas) } // Parses messages recieved private func parseSocketMessage(message:AnyObject?) { if message == nil { return } // println(message!) if let stringMessage = message as? String { // Check for successful namepsace connect if self.nsp != nil { if stringMessage == "40/\(self.nsp!)" { self.handleEvent("connect", data: nil) return } } /** Begin check for socket info frame **/ var mutMessage = RegexMutable(stringMessage) var setup:String! let messageData = mutMessage["(\\d*)(\\{.*\\})?"].groups() if messageData != nil && messageData[1] == "0" { setup = messageData[2] let data = setup.dataUsingEncoding(NSUTF8StringEncoding)! var jsonError:NSError? if let json:AnyObject? = NSJSONSerialization.JSONObjectWithData(data, options: nil, error: &jsonError) { self.sid = json!["sid"] as? String self.startPingTimer(interval: (json!["pingInterval"] as! Int) / 1000) return } } /** End check for socket info frame **/ /** Begin check for message **/ let messageGroups = mutMessage["(\\d*)\\/?(\\w*)?,?(\\[.*\\])?"].groups() if messageGroups[1] == "42" { var namespace:String? var messagePart:String! if messageGroups.count == 4 { namespace = messageGroups[2] messagePart = messageGroups[3] } if namespace == "" && self.nsp != nil { return } let messageInternals = RegexMutable(messagePart)["\\[\"(.*?)\",(.*?)?\\]$"].groups() if messageInternals != nil && messageInternals.count > 2 { let event = messageInternals[1] var data:String? if messageInternals[2] == "" { data = nil } else { data = messageInternals[2] } // It would be nice if socket.io only allowed one thing // per message, but alas, it doesn't. if let parsed:AnyObject = SocketIOClient.parseData(data) { self.handleEvent(event, data: parsed) return } else if let strData = data { // There are multiple items in the message // Turn it into a String and run it through // parseData to try and get an array. let asArray = "[\(strData)]" if let parsed:AnyObject = SocketIOClient.parseData(asArray) { self.handleEvent(event, data: parsed, multipleItems: true) return } } } // Check for no item event let noItemMessage = RegexMutable(messagePart)["\\[\"(.*?)\"]$"].groups() if noItemMessage != nil && noItemMessage.count == 2 { let event = noItemMessage[1] self.handleEvent(event, data: nil, multipleItems: false) return } } /** End Check for message **/ // Check for message with binary placeholders self.parseBinaryMessage(message: message!) } // Message is binary if let binary = message as? NSData { if self.lastSocketMessage == nil { return } self.parseBinaryData(binary) } } // Tries to parse a message that contains binary private func parseBinaryMessage(#message:AnyObject) { // println(message) if let stringMessage = message as? String { var mutMessage = RegexMutable(stringMessage) /** Begin check for binary placeholders **/ let binaryGroup = mutMessage["(\\d*)-\\/?(\\w*)?,?\\[(\".*?\"),(.*)\\]$"].groups() if binaryGroup != nil { // println(binaryGroup) var event:String! var mutMessageObject:NSMutableString! var namespace:String? let messageType = RegexMutable(binaryGroup[1]) let numberOfPlaceholders = messageType["45"] ~= "" // Check if message came from a namespace if binaryGroup.count == 5 { namespace = binaryGroup[2] event = (RegexMutable(binaryGroup[3])["\""] ~= "") as String mutMessageObject = RegexMutable(binaryGroup[4]) } if namespace == "" && self.nsp != nil { self.lastSocketMessage = nil return } let placeholdersRemoved = mutMessageObject["(\\{\"_placeholder\":true,\"num\":(\\d*)\\})"] ~= "\"~~$2\"" let mes = SocketEvent(event: event, args: placeholdersRemoved, placeholders: numberOfPlaceholders.integerValue) self.lastSocketMessage = mes } /** End check for binary placeholders **/ } } // Handles binary data private func parseBinaryData(data:NSData) { let shouldExecute = self.lastSocketMessage?.addData(data) if shouldExecute != nil && shouldExecute! { var event = self.lastSocketMessage!.event var parsedArgs:AnyObject? = SocketIOClient.parseData(self.lastSocketMessage!.args as? String) if let args:AnyObject = parsedArgs { let filledInArgs:AnyObject = self.lastSocketMessage!.fillInPlaceholders(args) self.handleEvent(event, data: filledInArgs) } else { let filledInArgs:AnyObject = self.lastSocketMessage!.fillInPlaceholders() self.handleEvent(event, data: filledInArgs, multipleItems: true) return } } } func sendPing() { if self.connected { self.io?.send("2") } } // Starts the ping timer private func startPingTimer(#interval:Int) { self.pingTimer = NSTimer.scheduledTimerWithTimeInterval(NSTimeInterval(interval), target: self, selector: Selector("sendPing"), userInfo: nil, repeats: true) } // We lost connection and should attempt to reestablish private func tryReconnect(var #triesLeft:Int) { if triesLeft != -1 && triesLeft <= 0 { self.connecting = false self.reconnects = false self.reconnecting = false self.handleEvent("disconnect", data: "Failed to reconnect", multipleItems: false, internalMessage: true) return } else if self.connected { self.connecting = false self.reconnecting = false return } // println("Trying to reconnect #\(reconnectAttempts - triesLeft)") self.handleEvent("reconnectAttempt", data: triesLeft, multipleItems: false, internalMessage: true) let waitTime = UInt64(self.reconnectWait) * NSEC_PER_SEC let time = dispatch_time(DISPATCH_TIME_NOW, Int64(waitTime)) // Wait reconnectWait seconds and then check if connected. Repeat if not dispatch_after(time, dispatch_get_main_queue()) {[weak self] in if self == nil || self!.connected || self!.closed { return } if triesLeft != -1 { triesLeft = triesLeft - 1 } self!.tryReconnect(triesLeft: triesLeft) } self.reconnecting = true self.connect() } // Called when a message is recieved func webSocket(webSocket:SRWebSocket!, didReceiveMessage message:AnyObject?) { dispatch_async(self.handleQueue) {self.parseSocketMessage(message)} } // Called when the socket is opened func webSocketDidOpen(webSocket:SRWebSocket!) { self.closed = false self.connecting = false self.reconnecting = false self.connected = true if self.nsp != nil { // Join namespace self.joinNamespace() return } // Don't handle as internal because something crazy could happen where // we disconnect before it's handled self.handleEvent("connect", data: nil) } // Called when the socket is closed func webSocket(webSocket:SRWebSocket!, didCloseWithCode code:Int, reason:String!, wasClean:Bool) { self.pingTimer?.invalidate() self.connected = false self.connecting = false if self.closed || !self.reconnects { self.handleEvent("disconnect", data: reason, multipleItems: false, internalMessage: true) } else { self.handleEvent("reconnect", data: reason, multipleItems: false, internalMessage: true) self.tryReconnect(triesLeft: self.reconnectAttempts) } } // Called when an error occurs. func webSocket(webSocket:SRWebSocket!, didFailWithError error:NSError!) { self.pingTimer?.invalidate() self.connected = false self.connecting = false self.handleEvent("error", data: error.localizedDescription, multipleItems: false, internalMessage: true) if self.closed || !self.reconnects { self.handleEvent("disconnect", data: error.localizedDescription, multipleItems: false, internalMessage: true) } else if !self.reconnecting { self.handleEvent("reconnect", data: error.localizedDescription, multipleItems: false, internalMessage: true) self.tryReconnect(triesLeft: self.reconnectAttempts) } } }