overte/tools/ice-client/src/ICEClientApp.cpp

//
//  ICEClientApp.cpp
//  tools/ice-client/src
//
//  Created by Seth Alves on 3/5/15.
//  Copyright 2015 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//

#include <QDataStream>
#include <QLoggingCategory>
#include <QCommandLineParser>
#include <PathUtils.h>
#include <LimitedNodeList.h>
#include <NetworkLogging.h>

#include "ICEClientApp.h"

ICEClientApp::ICEClientApp(int argc, char* argv[]) :
    QCoreApplication(argc, argv)
{
    // parse command-line
    QCommandLineParser parser;
    parser.setApplicationDescription("High Fidelity ICE client");
    parser.addHelpOption();

    const QCommandLineOption helpOption = parser.addHelpOption();

    const QCommandLineOption verboseOutput("v", "verbose output");
    parser.addOption(verboseOutput);

    const QCommandLineOption iceServerAddressOption("i", "ice-server address", "IP:PORT or HOSTNAME:PORT");
    parser.addOption(iceServerAddressOption);

    const QCommandLineOption howManyTimesOption("n", "how many times to cycle", "1");
    parser.addOption(howManyTimesOption);

    const QCommandLineOption domainIDOption("d", "domain-server uuid", "00000000-0000-0000-0000-000000000000");
    parser.addOption(domainIDOption);

    const QCommandLineOption cacheSTUNOption("s", "cache stun-server response");
    parser.addOption(cacheSTUNOption);

    if (!parser.parse(QCoreApplication::arguments())) {
        qCritical() << parser.errorText() << endl;
        parser.showHelp();
        Q_UNREACHABLE();
    }

    if (parser.isSet(helpOption)) {
        parser.showHelp();
        Q_UNREACHABLE();
    }

    _verbose = parser.isSet(verboseOutput);
    if (!_verbose) {
        const_cast<QLoggingCategory*>(&networking())->setEnabled(QtDebugMsg, false);
        const_cast<QLoggingCategory*>(&networking())->setEnabled(QtInfoMsg, false);
        const_cast<QLoggingCategory*>(&networking())->setEnabled(QtWarningMsg, false);
    }

    _stunSockAddr = HifiSockAddr(STUN_SERVER_HOSTNAME, STUN_SERVER_PORT, true);

    _cacheSTUNResult = parser.isSet(cacheSTUNOption);

    if (parser.isSet(howManyTimesOption)) {
        _actionMax = parser.value(howManyTimesOption).toInt();
    } else {
        _actionMax = 1;
    }

    if (parser.isSet(domainIDOption)) {
        _domainID = QUuid(parser.value(domainIDOption));
        if (_verbose) {
            qDebug() << "domain-server ID is" << _domainID;
        }
    }

    _iceServerAddr = HifiSockAddr("127.0.0.1", ICE_SERVER_DEFAULT_PORT);
    if (parser.isSet(iceServerAddressOption)) {
        // parse the IP and port combination for this target
        QString hostnamePortString = parser.value(iceServerAddressOption);

        QHostAddress address { hostnamePortString.left(hostnamePortString.indexOf(':')) };
        quint16 port { (quint16) hostnamePortString.mid(hostnamePortString.indexOf(':') + 1).toUInt() };
        if (port == 0) {
            port = ICE_SERVER_DEFAULT_PORT;
        }

        if (address.isNull()) {
            qCritical() << "Could not parse an IP address and port combination from" << hostnamePortString << "-" <<
                "The parsed IP was" << address.toString() << "and the parsed port was" << port;

            QMetaObject::invokeMethod(this, "quit", Qt::QueuedConnection);
        } else {
            _iceServerAddr = HifiSockAddr(address, port);
        }
    }

    if (_verbose) {
        qDebug() << "ICE-server address is" << _iceServerAddr;
    }

    setState(lookUpStunServer);

    QTimer* doTimer = new QTimer(this);
    connect(doTimer, &QTimer::timeout, this, &ICEClientApp::doSomething);
    doTimer->start(200);
}

ICEClientApp::~ICEClientApp() {
    delete _socket;
}

void ICEClientApp::setState(int newState) {
    _state = newState;
}

void ICEClientApp::closeSocket() {
    _domainServerPeerSet = false;
    delete _socket;
    _socket = nullptr;
}

void ICEClientApp::openSocket() {
    if (_socket) {
        return;
    }

    _socket = new udt::Socket();
    unsigned int localPort = 0;
    _socket->bind(QHostAddress::AnyIPv4, localPort);
    _socket->setPacketHandler([this](std::unique_ptr<udt::Packet> packet) { processPacket(std::move(packet)); });
    _socket->addUnfilteredHandler(_stunSockAddr,
                                  [this](std::unique_ptr<udt::BasePacket> packet) {
                                      processSTUNResponse(std::move(packet));
                                  });

    if (_verbose) {
        qDebug() << "local port is" << _socket->localPort();
    }
    _localSockAddr = HifiSockAddr("127.0.0.1", _socket->localPort());
    _publicSockAddr = HifiSockAddr("127.0.0.1", _socket->localPort());
    _domainPingCount = 0;
}

void ICEClientApp::doSomething() {
    if (_actionMax > 0 && _actionCount >= _actionMax) {
        // time to stop.
        QMetaObject::invokeMethod(this, "quit", Qt::QueuedConnection);

    } else if (_state == lookUpStunServer) {
        // lookup STUN server address
        if (!_stunSockAddr.getAddress().isNull()) {
            if (_verbose) {
                qDebug() << "stun server is" << _stunSockAddr;
            }
            setState(sendStunRequestPacket);
        } else {
            if (_verbose) {
                qDebug() << "_stunSockAddr is" << _stunSockAddr.getAddress();
            }
            QCoreApplication::exit(stunFailureExitStatus);
        }

    } else if (_state == sendStunRequestPacket) {
        // send STUN request packet
        closeSocket();
        openSocket();

        if (!_cacheSTUNResult || !_stunResultSet) {
            const int NUM_BYTES_STUN_HEADER = 20;
            char stunRequestPacket[NUM_BYTES_STUN_HEADER];
            LimitedNodeList::makeSTUNRequestPacket(stunRequestPacket);
            if (_verbose) {
                qDebug() << "sending STUN request";
            }
            _socket->writeDatagram(stunRequestPacket, sizeof(stunRequestPacket), _stunSockAddr);
            _stunResponseTimer.setSingleShot(true);
            connect(&_stunResponseTimer, SIGNAL(timeout()), this, SLOT(stunResponseTimeout()));
            _stunResponseTimer.start(stunResponseTimeoutMilliSeconds);

            setState(waitForStunResponse);
        } else {
            if (_verbose) {
                qDebug() << "using cached STUN response";
            }
            _publicSockAddr.setPort(_socket->localPort());
            setState(talkToIceServer);
        }

    } else if (_state == talkToIceServer) {
        QUuid peerID;
        if (_domainID == QUuid()) {
            // pick a random domain-id which will fail
            peerID = QUuid::createUuid();
            setState(pause0);
        } else {
            // use the domain UUID given on the command-line
            peerID = _domainID;
            setState(waitForIceReply);
        }
        _sessionUUID = QUuid::createUuid();
        if (_verbose) {
            qDebug() << "I am" << _sessionUUID;
        }

        sendPacketToIceServer(PacketType::ICEServerQuery, _iceServerAddr, _sessionUUID, peerID);
        _iceResponseTimer.setSingleShot(true);
        connect(&_iceResponseTimer, SIGNAL(timeout()), this, SLOT(iceResponseTimeout()));
        _iceResponseTimer.start(iceResponseTimeoutMilliSeconds);
    } else if (_state == pause0) {
        setState(pause1);
    } else if (_state == pause1) {
        if (_verbose) {
            qDebug() << "";
        }
        closeSocket();
        setState(sendStunRequestPacket);
        _actionCount++;
    }
}

void ICEClientApp::iceResponseTimeout() {
    if (_verbose) {
        qDebug() << "timeout waiting for ice-server response";
    }
    QCoreApplication::exit(iceFailureExitStatus);
}

void ICEClientApp::stunResponseTimeout() {
    if (_verbose) {
        qDebug() << "timeout waiting for stun-server response";
    }
    QCoreApplication::exit(stunFailureExitStatus);
}

void ICEClientApp::sendPacketToIceServer(PacketType packetType, const HifiSockAddr& iceServerSockAddr,
                                         const QUuid& clientID, const QUuid& peerID) {
    std::unique_ptr<NLPacket> icePacket = NLPacket::create(packetType);

    QDataStream iceDataStream(icePacket.get());
    iceDataStream << clientID << _publicSockAddr << _localSockAddr;

    if (packetType == PacketType::ICEServerQuery) {
        assert(!peerID.isNull());

        iceDataStream << peerID;

        if (_verbose) {
            qDebug() << "Sending packet to ICE server to request connection info for peer with ID"
                     << uuidStringWithoutCurlyBraces(peerID);
        }
    }

    // fillPacketHeader(packet, connectionSecret);
    _socket->writePacket(*icePacket, _iceServerAddr);
}

void ICEClientApp::checkDomainPingCount() {
    _domainPingCount++;
    if (_domainPingCount > 5) {
        if (_verbose) {
            qDebug() << "too many unanswered pings to domain-server.";
        }
        QCoreApplication::exit(domainPingExitStatus);
    }
}

void ICEClientApp::icePingDomainServer() {
    if (!_domainServerPeerSet) {
        return;
    }

    if (_verbose) {
        qDebug() << "ice-pinging domain-server: " << _domainServerPeer;
    }

    auto localPingPacket = LimitedNodeList::constructICEPingPacket(PingType::Local, _sessionUUID);
    _socket->writePacket(*localPingPacket, _domainServerPeer.getLocalSocket());

    auto publicPingPacket = LimitedNodeList::constructICEPingPacket(PingType::Public, _sessionUUID);
    _socket->writePacket(*publicPingPacket, _domainServerPeer.getPublicSocket());
    checkDomainPingCount();
}

void ICEClientApp::processSTUNResponse(std::unique_ptr<udt::BasePacket> packet) {
    if (_verbose) {
        qDebug() << "got stun response";
    }
    if (_state != waitForStunResponse) {
        if (_verbose) {
            qDebug() << "got unexpected stun response";
        }
        QCoreApplication::exit(stunFailureExitStatus);
    }

    _stunResponseTimer.stop();

    uint16_t newPublicPort;
    QHostAddress newPublicAddress;
    if (LimitedNodeList::parseSTUNResponse(packet.get(), newPublicAddress, newPublicPort)) {
        _publicSockAddr = HifiSockAddr(newPublicAddress, newPublicPort);
        if (_verbose) {
            qDebug() << "My public address is" << _publicSockAddr;
        }
        _stunResultSet = true;
        setState(talkToIceServer);
    } else {
        QCoreApplication::exit(stunFailureExitStatus);
    }
}


void ICEClientApp::processPacket(std::unique_ptr<udt::Packet> packet) {
    std::unique_ptr<NLPacket> nlPacket = NLPacket::fromBase(std::move(packet));

    if (nlPacket->getPayloadSize() < NLPacket::localHeaderSize(PacketType::ICEServerHeartbeat)) {
        if (_verbose) {
            qDebug() << "got a short packet.";
        }
        return;
    }

    QSharedPointer<ReceivedMessage> message = QSharedPointer<ReceivedMessage>::create(*nlPacket);
    const HifiSockAddr& senderAddr = message->getSenderSockAddr();

    if (nlPacket->getType() == PacketType::ICEServerPeerInformation) {
        // cancel the timeout timer
        _iceResponseTimer.stop();

        QDataStream iceResponseStream(message->getMessage());
        if (!_domainServerPeerSet) {
            iceResponseStream >> _domainServerPeer;
            if (_verbose) {
                qDebug() << "got ICEServerPeerInformation from" << _domainServerPeer;
            }
            _domainServerPeerSet = true;

            icePingDomainServer();
            _pingDomainTimer = new QTimer(this);
            connect(_pingDomainTimer, &QTimer::timeout, this, &ICEClientApp::icePingDomainServer);
            _pingDomainTimer->start(500);
        } else {
            NetworkPeer domainServerPeer;
            iceResponseStream >> domainServerPeer;
            if (_verbose) {
                qDebug() << "got repeat ICEServerPeerInformation from" << domainServerPeer;
            }
        }

    } else if (nlPacket->getType() == PacketType::ICEPing) {
        if (_verbose) {
            qDebug() << "got packet: " << nlPacket->getType();
        }
        auto replyPacket = LimitedNodeList::constructICEPingReplyPacket(*message, _sessionUUID);
        _socket->writePacket(*replyPacket, senderAddr);
        checkDomainPingCount();

    } else if (nlPacket->getType() == PacketType::ICEPingReply) {
        if (_verbose) {
            qDebug() << "got packet: " << nlPacket->getType();
        }
        if (_domainServerPeerSet && _state == waitForIceReply &&
            (senderAddr == _domainServerPeer.getLocalSocket() ||
             senderAddr == _domainServerPeer.getPublicSocket())) {

            delete _pingDomainTimer;
            _pingDomainTimer = nullptr;

            setState(pause0);
        } else {
            if (_verbose) {
                qDebug() << "got unexpected ICEPingReply" << senderAddr;
            }
        }

    } else {
        if (_verbose) {
            qDebug() << "got unexpected packet: " << nlPacket->getType();
        }
    }
}