socket.io-client-swift/SwiftIO/SocketIOClient.swift

//
//  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

public class SocketIOClient: NSObject {
    let socketURL:String!
    let ackQueue = dispatch_queue_create("ackQueue".cStringUsingEncoding(NSUTF8StringEncoding),
        DISPATCH_QUEUE_SERIAL)
    let handleQueue = dispatch_queue_create("handleQueue".cStringUsingEncoding(NSUTF8StringEncoding),
        DISPATCH_QUEUE_SERIAL)
    let emitQueue = dispatch_queue_create("emitQueue".cStringUsingEncoding(NSUTF8StringEncoding),
        DISPATCH_QUEUE_SERIAL)
    let reconnectAttempts:Int!
    private lazy var params = [String: AnyObject]()
    private var ackHandlers = [SocketAckHandler]()
    private var anyHandler:((AnyHandler) -> Void)?
    private var _closed = false
    private var _connected = false
    private var _connecting = false
    private var currentReconnectAttempt = 0
    private var forcePolling = false
    private var handlers = [SocketEventHandler]()
    private var paramConnect = false
    private var _secure = false
    private var _sid:String?
    private var _reconnecting = false
    private var reconnectTimer:NSTimer?
    
    internal var currentAck = -1
    internal var waitingData = [SocketEvent]()
    
    public var closed:Bool {
        return self._closed
    }
    public var connected:Bool {
        return self._connected
    }
    public var connecting:Bool {
        return self._connecting
    }
    public var cookies:[NSHTTPCookie]?
    public var engine:SocketEngine?
    public var nsp:String?
    public var reconnects = true
    public var reconnecting:Bool {
        return self._reconnecting
    }
    public var reconnectWait = 10
    public var secure:Bool {
        return self._secure
    }
    public var sid:String? {
        return self._sid
    }
    
    public init(var socketURL:String, opts:NSDictionary? = nil) {
        if socketURL["https://"].matches().count != 0 {
            self._secure = true
        }
        
        socketURL = socketURL["http://"] ~= ""
        socketURL = socketURL["https://"] ~= ""
        
        self.socketURL = socketURL
        
        // 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
            } else {
                self.reconnectAttempts = -1
            }
            
            if let reconnectWait = opts!["reconnectWait"] as? Int {
                self.reconnectWait = abs(reconnectWait)
            }
            
            if let nsp = opts!["nsp"] as? String {
                self.nsp = nsp
            }
            
            if let polling = opts!["forcePolling"] as? Bool {
                self.forcePolling = polling
            }
            
            if let cookies = opts!["cookies"] as? [NSHTTPCookie] {
                self.cookies = cookies
            }
        } else {
            self.reconnectAttempts = -1
        }
        
        super.init()
        
        self.engine = SocketEngine(client: self,
            forcePolling: self.forcePolling,
            withCookies: self.cookies)
    }
    
    public convenience init(socketURL:String, options:NSDictionary?) {
        self.init(socketURL: socketURL, opts: options)
    }
    
    // Closes the socket
    public func close() {
        self._closed = true
        self._connecting = false
        self._connected = false
        self._reconnecting = false
        self.engine?.close()
    }
    
    // Connects to the server
    public func connect() {
        if self.closed {
            println("Warning! This socket was previously closed. This might be dangerous!")
            self._closed = false
        }
        
        self.engine?.open()
    }
    
    // Connect to the server using params
    public func connectWithParams(params:[String: AnyObject]) {
        if self.closed {
            println("Warning! This socket was previously closed. This might be dangerous!")
            self._closed = false
        }
        
        self.params = params
        self.paramConnect = true
        
        self.engine?.open(opts: params)
    }
    
    func didConnect() {
        self._closed = false
        self._connected = true
        self._connecting = false
        self._reconnecting = false
        self.currentReconnectAttempt = 0
        self.reconnectTimer?.invalidate()
        self.reconnectTimer = nil
        self._sid = self.engine?.sid
        
        // Don't handle as internal because something crazy could happen where
        // we disconnect before it's handled
        self.handleEvent("connect", data: nil, isInternalMessage: false)
    }
    
    // Server wants us to die
    func didForceClose(#message:String) {
        self._closed = true
        self._connected = false
        self.reconnects = false
        self._connecting = false
        self._reconnecting = false
        self.handleEvent("disconnect", data: message, isInternalMessage: true)
    }
    
    // Sends a message with multiple args
    // If a message contains binary we have to send those
    // seperately.
    public func emit(event:String, _ args:AnyObject...) {
        if !self.connected {
            return
        }
        
        dispatch_async(self.emitQueue) {[weak self] in
            self?._emit(event, args)
            return
        }
    }
    
    // Objc doesn't have variadics
    public func emitObjc(event:String, withItems items:[AnyObject]) {
        self.emit(event, items)
    }
    
    public func emitWithAck(event:String, _ args:AnyObject...) -> SocketAckHandler {
        if !self.connected {
            return SocketAckHandler(event: "fail", socket: self)
        }
        
        self.currentAck++
        let ackHandler = SocketAckHandler(event: event,
            ackNum: self.currentAck, socket: self)
        self.ackHandlers.append(ackHandler)
        
        dispatch_async(self.emitQueue) {[weak self, ack = self.currentAck] in
            self?._emit(event, args, ack: ack)
            return
        }
        
        return ackHandler
    }
    
    public func emitWithAckObjc(event:String, withItems items:[AnyObject]) -> SocketAckHandler {
        return self.emitWithAck(event, items)
    }
    
    private func _emit(event:String, _ args:[AnyObject], ack:Int? = nil) {
        var frame:SocketEvent
        var str:String
        
        let (items, hasBinary, emitDatas) = SocketParser.parseEmitArgs(args)
        
        if !self.connected {
            return
        }
        
        if hasBinary {
            if ack == nil {
                str = SocketEvent.createMessageForEvent(event, withArgs: items,
                    hasBinary: true, withDatas: emitDatas.count, toNamespace: self.nsp)
            } else {
                str = SocketEvent.createMessageForEvent(event, withArgs: items,
                    hasBinary: true, withDatas: emitDatas.count, toNamespace: self.nsp, wantsAck: ack)
            }
            
            self.engine?.send(str, datas: emitDatas)
        } else {
            if ack == nil {
                str = SocketEvent.createMessageForEvent(event, withArgs: items, hasBinary: false,
                    withDatas: 0, toNamespace: self.nsp)
            } else {
                str = SocketEvent.createMessageForEvent(event, withArgs: items, hasBinary: false,
                    withDatas: 0, toNamespace: self.nsp, wantsAck: ack)
            }
            
            self.engine?.send(str)
        }
    }
    
    // If the server wants to know that the client received data
    func emitAck(ack:Int, withData data:[AnyObject]?, withAckType ackType:Int) {
        dispatch_async(self.ackQueue) {[weak self] in
            if self == nil || !self!.connected || data == nil {
                return
            }
            
            let (items, hasBinary, emitDatas) = SocketParser.parseEmitArgs(data!)
            var str:String
            
            if !hasBinary {
                if self?.nsp == nil {
                    str = SocketEvent.createAck(ack, withArgs: items,
                        withAckType: 3, withNsp: "/")
                } else {
                    str = SocketEvent.createAck(ack, withArgs: items,
                        withAckType: 3, withNsp: self!.nsp!)
                }
                
                self?.engine?.send(str)
            } else {
                if self?.nsp == nil {
                    str = SocketEvent.createAck(ack, withArgs: items,
                        withAckType: 6, withNsp: "/", withBinary: emitDatas.count)
                } else {
                    str = SocketEvent.createAck(ack, withArgs: items,
                        withAckType: 6, withNsp: self!.nsp!, withBinary: emitDatas.count)
                }
                
                self?.engine?.send(str, datas: emitDatas)
            }
        }
    }
    
    // Called when the socket gets an ack for something it sent
    func handleAck(ack:Int, data:AnyObject?) {
        self.ackHandlers = self.ackHandlers.filter {handler in
            if handler.ackNum != ack {
                return true
            } else {
                if data is NSArray {
                    handler.executeAck(data as? NSArray)
                } else if data != nil {
                    handler.executeAck([data!])
                } else {
                    handler.executeAck(nil)
                }
                
                return false
            }
        }
    }
    
    // Handles events
    public func handleEvent(event:String, data:AnyObject?, isInternalMessage:Bool = false,
        wantsAck ack:Int? = nil, withAckType ackType:Int = 3) {
            // println("Should do event: \(event) with data: \(data)")
            if !self.connected && !isInternalMessage {
                return
            }
            
            if self.anyHandler != nil {
                dispatch_async(dispatch_get_main_queue()) {[weak self] in
                    self?.anyHandler?((event, data))
                    return
                }
            }
            
            for handler in self.handlers {
                if handler.event == event {
                    if data is NSArray {
                        if ack != nil {
                            handler.executeCallback(data as? NSArray, withAck: ack!,
                                withAckType: ackType, withSocket: self)
                        } else {
                            handler.executeCallback(data as? NSArray)
                        }
                    } else {
                        
                        // Trying to do a ternary expression in the executeCallback method
                        // seemed to crash Swift
                        var dataArr:NSArray? = nil
                        
                        if let data:AnyObject = data {
                            dataArr = [data]
                        }
                        
                        if ack != nil {
                            handler.executeCallback(dataArr, withAck: ack!,
                                withAckType: ackType, withSocket: self)
                        } else {
                            handler.executeCallback(dataArr)
                        }
                    }
                }
            }
    }
    
    // Should be removed and moved to SocketEngine
    func joinNamespace() {
        if self.nsp != nil {
            self.engine?.send("0/\(self.nsp!)")
        }
    }
    
    // Adds handler for an event
    public func on(name:String, callback:NormalCallback) {
        let handler = SocketEventHandler(event: name, callback: callback)
        self.handlers.append(handler)
    }
    
    // Adds a handler for any event
    public func onAny(handler:(AnyHandler) -> Void) {
        self.anyHandler = handler
    }
    
    // Opens the connection to the socket
    public func open() {
        self.connect()
    }
    
    func parseSocketMessage(msg:String) {
        SocketParser.parseSocketMessage(msg, socket: self)
    }
    
    func parseBinaryData(data:NSData) {
        SocketParser.parseBinaryData(data, socket: self)
    }
    
    // Something happened while polling
    func pollingDidFail(err:NSError?) {
        if !self.reconnecting {
            self._connected = false
            self.handleEvent("reconnect", data: err?.localizedDescription, isInternalMessage: true)
            self.tryReconnect()
        }
    }
    
    func removeAck(ack:SocketAckHandler) {
        self.ackHandlers = self.ackHandlers.filter {$0 === ack ? false : true}
    }
    
    // We lost connection and should attempt to reestablish
    func tryReconnect() {
        if self.reconnectAttempts != -1 && self.currentReconnectAttempt + 1 > self.reconnectAttempts {
            self.didForceClose(message: "Reconnect Failed")
            return
        } else if self.connected {
            self._connecting = false
            self._reconnecting = false
            return
        }
        
        if self.reconnectTimer == nil {
            self._reconnecting = true
            
            dispatch_async(dispatch_get_main_queue()) {[weak self] in
                if self == nil {
                    return
                }
                
                self?.reconnectTimer = NSTimer.scheduledTimerWithTimeInterval(Double(self!.reconnectWait),
                    target: self!, selector: "tryReconnect", userInfo: nil, repeats: true)
                return
            }
        }
        
        self.handleEvent("reconnectAttempt", data: self.reconnectAttempts - self.currentReconnectAttempt,
            isInternalMessage: true)
        
        self.currentReconnectAttempt++
        if self.paramConnect {
            self.connectWithParams(self.params)
        } else {
            self.connect()
        }
    }
    
    // Called when the socket is closed
    func webSocketDidCloseWithCode(code:Int, reason:String!, wasClean:Bool) {
        self._connected = false
        self._connecting = false
        if self.closed || !self.reconnects {
            self.didForceClose(message: "WebSocket closed")
        } else {
            self.handleEvent("reconnect", data: reason, isInternalMessage: true)
            self.tryReconnect()
        }
    }
    
    // Called when an error occurs.
    func webSocketDidFailWithError(error:NSError!) {
        self._connected = false
        self._connecting = false
        self.handleEvent("error", data: error.localizedDescription, isInternalMessage: true)
        if self.closed || !self.reconnects {
            self.didForceClose(message: "WebSocket closed with an error \(error)")
        } else if !self.reconnecting {
            self.handleEvent("reconnect", data: error.localizedDescription, isInternalMessage: true)
            self.tryReconnect()
        }
    }
}