src/bzfs/ListServerConnection.cxx

/* bzflag
 * Copyright (c) 1993-2021 Tim Riker
 *
 * This package is free software;  you can redistribute it and/or
 * modify it under the terms of the license found in the file
 * named COPYING that should have accompanied this file.
 *
 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

// Provide BZFS with a list server connection

/* class header */
#include "ListServerConnection.h"

/* system implementation headers */
#include <string.h>
#include <string>
#include <errno.h>
#include <set>

/* common implementation headers */
#include "bzfio.h"
#include "version.h"
#include "TextUtils.h"
#include "Protocol.h"
#include "bzfsAPI.h"
#include "WorldEventManager.h"

/* local implementation headers */
#include "bzfs.h"

const int ListServerLink::NotConnected = -1;

ListServerLink::ListServerLink(std::string listServerURL,
                               std::string publicizedAddress,
                               std::string publicizedTitle,
                               std::string _advertiseGroups)
{

    std::string bzfsUserAgent = "bzfs ";
    bzfsUserAgent     += getAppVersion();

    setURLwithNonce(listServerURL);
    setUserAgent(bzfsUserAgent);
    setTimeout(10);

    publiclyDisconnected = false;

    if (clOptions->pingInterface != "")
        setInterface(clOptions->pingInterface);

    publicizeAddress     = publicizedAddress;
    publicizeDescription = publicizedTitle;
    advertiseGroups      = _advertiseGroups;

    //if this c'tor is called, it's safe to publicize
    publicizeServer      = true;
    queuedRequest = false;
    // schedule initial ADD message
    queueMessage(ListServerLink::ADD);
}

ListServerLink::ListServerLink(): nextMessageType(), queuedRequest(0)
{
    // does not create a usable link, so checks should be placed
    // in  all public member functions to ensure that nothing tries
    // to happen if publicizeServer is false
    publicizeServer = false;
}

ListServerLink::~ListServerLink()
{
    // now tell the list server that we're going away.  this can
    // take some time but we don't want to wait too long.  we do
    // our own multiplexing loop and wait for a maximum of 3 seconds
    // total.

    // if we aren't supposed to be publicizing, skip the whole thing
    // and don't waste 3 seconds.
    if (!publicizeServer)
        return;

    queueMessage(ListServerLink::REMOVE);
    for (int i = 0; i < 12; i++)
    {
        cURLManager::perform();
        if (!queuedRequest)
            break;
        TimeKeeper::sleep(0.25f);
    }
}

void ListServerLink::finalization(char *data, unsigned int length, bool good)
{
    publiclyDisconnected = !good;
    GameKeeper::Player *playerData = NULL;
    queuedRequest = false;
    if (good && (length < 2048))
    {
        char buf[2048];
        memcpy(buf, data, length);
        int bytes = length;
        buf[bytes]=0;
        char* base = buf;
        const char tokGoodIdentifier[] = "TOKGOOD: ";
        const char tokBadIdentifier[]  = "TOKBAD: ";
        const char unknownPlayer[]     = "UNK: ";
        const char bzIdentifier[]      = "BZID: ";
        const char ownerIdentifier[]   = "OWNER: ";
        // walks entire reply including HTTP headers
        while (*base)
        {
            // find next newline
            char* scan = base;
            while (*scan && *scan != '\r' && *scan != '\n') scan++;
            // if no newline then no more complete replies
            if (*scan != '\r' && *scan != '\n') break;
            while (*scan && (*scan == '\r' || *scan == '\n')) *scan++ = '\0';
            logDebugMessage(4,"Got line: \"%s\"\n", base);
            // TODO don't do this if we don't want central logins

            // is player globally registered ?
            bool  registered = false;
            // is player authenticated ?
            bool  verified   = false;
            // this is a reply to an authentication request ?
            bool  authReply  = false;

            char *callsign;
            if (strncmp(base, tokGoodIdentifier, strlen(tokGoodIdentifier)) == 0)
            {
                callsign = base + strlen(tokGoodIdentifier);
                registered = true;
                verified   = true;
                authReply  = true;
            }
            else if (!strncmp(base, tokBadIdentifier, strlen(tokBadIdentifier)))
            {
                callsign = base + strlen(tokBadIdentifier);
                registered = true;
                authReply  = true;
            }
            else if (!strncmp(base, unknownPlayer, strlen(unknownPlayer)))
            {
                callsign = base + strlen(unknownPlayer);
                authReply  = true;
            }
            else if (!strncmp(base, ownerIdentifier, strlen(ownerIdentifier)))
                setPublicOwner(base + strlen(ownerIdentifier));
            else if (!strncmp(base, bzIdentifier, strlen(bzIdentifier)))
            {
                std::string line = base;
                std::vector<std::string> args = TextUtils::tokenize(line, " \t", 3, true);
                if (args.size() < 3)
                    logDebugMessage(3,"Bad BZID string: %s\n", line.c_str());
                else
                {
                    const std::string& bzId = args[1];
                    const std::string& nick = args[2];
                    logDebugMessage(4,"Got BZID: \"%s\" || \"%s\"\n", bzId.c_str(), nick.c_str());
                    for (int i = 0; i < curMaxPlayers; i++)
                    {
                        GameKeeper::Player* gkp = GameKeeper::Player::getPlayerByIndex(i);
                        if ((gkp != NULL) &&
                                (strcasecmp(gkp->player.getCallSign(), nick.c_str()) == 0) &&
                                (gkp->_LSAState == GameKeeper::Player::verified))
                        {
                            gkp->setBzIdentifier(bzId);
                            logDebugMessage(3,"Set player (%s [%i]) bzId to (%s)\n",
                                            nick.c_str(), i, bzId.c_str());
                            break;
                        }
                    }
                }
            }
            /*
                char* start = base + strlen(bzIdentifier);
                // skip leading white
                while ((*start != '\0') && isspace(*start)) start++;
                const bool useQuotes = (*start == '"');
                if (useQuotes) start++; // ditch the '"'
                char* end = start;
                // skip until the end of the id
                if (useQuotes) {
                  while ((*end != '\0') && (*end != '"')) end++;
                } else {
                  while ((*end != '\0') && !isspace(*end)) end++;
                }
                if ((*end != '\0') && (useQuotes && (*end != '"'))) {
                  if (useQuotes) {
                    callsign = end + 1;
                    end--; // ditch the '"'
                  } else {
                    callsign = end;
                  }
                  // skip leading white
                  while ((*callsign != '\0') && isspace(*callsign)) callsign++;
                  if (*callsign != '\0') {
                    bzId = start;
                    bzId = bzId.substr(end - start);
                    if ((bzId.size() > 0) && (strlen(callsign) > 0)) {
                      bzIdInfo = true;
                    }
                  }
                }
                  }

                  if (bzIdInfo == true) {
                logDebugMessage(3,"Got BZID: %s", base);
                for (int i = 0; i < curMaxPlayers; i++) {
                  GameKeeper::Player* gkp = GameKeeper::Player::getPlayerByIndex(i);
                  if ((gkp != NULL) &&
                      (strcasecmp(gkp->player.getCallSign(), callsign) == 0)) {
                    gkp->setBzIdentifier(bzId);
                    logDebugMessage(3,"Set player (%s [%i]) bzId to (%s)\n", callsign, i, bzId.c_str());
                    break;
                  }
                }
                  }
            */
            if (authReply)
            {
                logDebugMessage(3,"Got: %s", base);
                char *group = (char *)NULL;

                // Isolate callsign from groups
                if (verified)
                {
                    group = callsign;
                    if (group)
                    {
                        while (*group && (*group != ':')) group++;
                        while (*group && (*group == ':')) *group++ = 0;
                    }
                }
                playerData = NULL;
                int playerIndex;
                for (playerIndex = 0; playerIndex < curMaxPlayers; playerIndex++)
                {
                    playerData = GameKeeper::Player::getPlayerByIndex(playerIndex);
                    if (!playerData)
                        continue;
                    if (playerData->_LSAState != GameKeeper::Player::checking)
                        continue;
                    if (!TextUtils::compare_nocase(playerData->player.getCallSign(),
                                                   callsign))
                        break;
                }
                logDebugMessage(3,"[%d]\n", playerIndex);

                if (playerIndex < curMaxPlayers)
                {
                    if (registered)
                    {
                        if (!playerData->accessInfo.isRegistered())
                            // Create an entry on the user database even if
                            // authentication wenk ko. Make the "isRegistered"
                            // things work
                            playerData->accessInfo.storeInfo();
                        if (verified)
                        {
                            playerData->_LSAState = GameKeeper::Player::verified;
                            playerData->accessInfo.setPermissionRights();
                            while (group && *group)
                            {
                                char *nextgroup = group;
                                if (nextgroup)
                                {
                                    while (*nextgroup && (*nextgroup != ':')) nextgroup++;
                                    while (*nextgroup && (*nextgroup == ':')) *nextgroup++ = 0;
                                }
                                playerData->accessInfo.addGroup(group);
                                group = nextgroup;
                            }
                            playerData->authentication.global(true);
                            sendMessage(ServerPlayer, playerIndex,
                                        "Global login approved!");
                        }
                        else
                        {
                            playerData->_LSAState = GameKeeper::Player::failed;
                            sendMessage(ServerPlayer, playerIndex,
                                        "Global login rejected, bad token.");
                        }
                    }
                    else
                    {
                        playerData->_LSAState = GameKeeper::Player::notRequired;
                        if (!playerData->player.isBot())
                        {
                            sendMessage(ServerPlayer, playerIndex,
                                        "This callsign is not registered.");
                            sendMessage(ServerPlayer, playerIndex,
                                        "You can register it at https://forums.bzflag.org/");
                        }
                    }
                    playerData->player.clearToken();
                }
            }

            // next reply
            base = scan;
        }
    }

    if (playerData != NULL)
    {
        // tell the API that auth is complete
        bz_AuthenticationCompleteData_V1 eventData;
        eventData.player = bz_getPlayerByIndex(playerData->getIndex());
        worldEventManager.callEvents(&eventData);
    }

    for (int i = 0; i < curMaxPlayers; i++)
    {
        playerData = GameKeeper::Player::getPlayerByIndex(i);
        if (!playerData)
            continue;
        if (playerData->_LSAState != GameKeeper::Player::checking)
            continue;
        playerData->_LSAState = GameKeeper::Player::timedOut;
    }
    if (nextMessageType != ListServerLink::NONE)
    {
        // There was a pending request arrived after we write:
        // we should redo all the stuff
        sendQueuedMessages();
    }
}

void ListServerLink::queueMessage(MessageType type)
{
    // ignore if the server is not public
    if (!publicizeServer) return;

    // record next message to send.
    nextMessageType = type;

    if (!queuedRequest)
        sendQueuedMessages();
    else
        logDebugMessage(3,"There is a message already queued to the list server: not sending this one yet.\n");
}

void ListServerLink::sendQueuedMessages()
{
    queuedRequest = true;
    if (nextMessageType == ListServerLink::ADD)
    {
        logDebugMessage(3,"Queuing ADD message to list server\n");

        bz_ListServerUpdateEvent_V1 updateEvent;
        updateEvent.address = publicizeAddress;
        updateEvent.description = publicizeDescription;
        updateEvent.groups = advertiseGroups;

        worldEventManager.callEvents(bz_eListServerUpdateEvent,&updateEvent);

        addMe(getTeamCounts(), std::string(updateEvent.address.c_str()), std::string(updateEvent.description.c_str()),
              std::string(updateEvent.groups.c_str()));
        lastAddTime = TimeKeeper::getCurrent();
    }
    else if (nextMessageType == ListServerLink::REMOVE)
    {
        logDebugMessage(3,"Queuing REMOVE message to list server\n");
        removeMe(publicizeAddress);
    }
    nextMessageType = ListServerLink::NONE;
}

void ListServerLink::addMe(PingPacket pingInfo,
                           std::string publicizedAddress,
                           std::string publicizedTitle,
                           std::string _advertiseGroups)
{
    std::string msg;

    // encode ping reply as ascii hex digits plus NULL
    char gameInfo[PingPacketHexPackedSize + 1];
    pingInfo.packHex(gameInfo);

    // send ADD message (must send blank line)
    msg  = "action=ADD&nameport=";
    msg += publicizedAddress;
    msg += "&version=";
    msg += getServerVersion();
    msg += "&gameinfo=";
    msg += gameInfo;
    msg += "&build=";
    msg += getAppVersion();
    msg += "&checktokens=";

    std::set<std::string> callSigns;
    // callsign1@ip1=token1%0D%0Acallsign2@ip2=token2%0D%0A
    for (int i = 0; i < curMaxPlayers; i++)
    {
        GameKeeper::Player *playerData = GameKeeper::Player::getPlayerByIndex(i);
        if (!playerData)
            continue;
        if ((playerData->_LSAState != GameKeeper::Player::required)
                && (playerData->_LSAState != GameKeeper::Player::requesting))
            continue;
        if (callSigns.count(playerData->player.getCallSign()))
            continue;
        callSigns.insert(playerData->player.getCallSign());
        playerData->_LSAState = GameKeeper::Player::checking;
        NetHandler *handler = playerData->netHandler;
        msg += TextUtils::url_encode(playerData->player.getCallSign());
        Address addr = handler->getIPAddress();
        if (!addr.isPrivate())
        {
            msg += "@";
            msg += handler->getTargetIP();
        }
        msg += "=";
        msg += playerData->player.getToken();
        msg += "%0D%0A";
    }

    msg += "&groups=";
    // *groups=GROUP0%0D%0AGROUP1%0D%0A
    PlayerAccessMap::iterator itr = groupAccess.begin();
    for ( ; itr != groupAccess.end(); ++itr)
    {
        if (itr->first.substr(0, 6) != "LOCAL.")
        {
            msg += itr->first.c_str();
            msg += "%0D%0A";
        }
    }

    if (clOptions && !clOptions->publicizedKey.empty())
        msg += "&key=" + clOptions->publicizedKey;

    msg += "&advertgroups=";
    msg += TextUtils::url_encode(_advertiseGroups);
    msg += "&title=";
    msg += TextUtils::url_encode(publicizedTitle);

    setPostMode(msg);
    addHandle();
}

void ListServerLink::removeMe(std::string publicizedAddress)
{
    std::string msg;

    msg  = "action=REMOVE&nameport=";
    msg += publicizedAddress;

    setPostMode(msg);
    addHandle();
}

// Local Variables: ***
// mode: C++ ***
// tab-width: 4 ***
// c-basic-offset: 4 ***
// indent-tabs-mode: nil ***
// End: ***
// ex: shiftwidth=4 tabstop=4