cyphesis/server/TeleportAuthenticator.cpp

// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2010 Alistair Riddoch
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

#include "TeleportAuthenticator.h"
#include "PendingTeleport.h"

#include "common/BaseWorld.h"
#include "common/log.h"
#include "common/compose.hpp"

#include <cassert>

TeleportAuthenticator * TeleportAuthenticator::m_instance = NULL;

/// \brief Checks if there is a pending teleport on an account
///
/// \param entity_id The entity ID to check for pending teleport
bool TeleportAuthenticator::isPending(const std::string & entity_id) const
{
    PendingTeleportMap::const_iterator I = m_teleports.find(entity_id);
    return (I != m_teleports.end());
}

/// \brief Add a teleport authentication entry
///
/// \param entity_id The ID of the entity whose data is to be removed
/// \param possess_key The possess key to authenticate the entity with
int TeleportAuthenticator::addTeleport(const std::string & entity_id,
                                       const std::string & possess_key)
{
    if (isPending(entity_id)) {
        return -1;
    }
    PendingTeleport * pt = new PendingTeleport(entity_id, possess_key);
    if (pt == 0) {
        return -1;
    }
    m_teleports.insert(std::make_pair(entity_id, pt));
    log(INFO, String::compose("Added teleport auth entry for %1,%2",
                              entity_id, possess_key));
    return 0;
}

/// \brief Remove a teleport authentications entry.
///
/// \param entity_id The ID of the entity whose data is to be removed
int TeleportAuthenticator::removeTeleport(const std::string &entity_id)
{
    PendingTeleportMap::iterator I = m_teleports.find(entity_id);
    if (I == m_teleports.end()) {
        log(ERROR, String::compose("No teleport auth entry for entity ID %1",
                                                entity_id));
        return -1;
    }
    removeTeleport(I);
    log(ERROR, String::compose("Removed teleport auth entry for entity ID %1",
                                                entity_id));
    return 0;
}

/// \brief Remove a teleport authentications entry internals.
///
/// Typically after a successful authentication
/// \param I The iterator in m_teleports to be removed
void TeleportAuthenticator::removeTeleport(PendingTeleportMap::iterator I)
{
    assert(I->second != 0);
    delete I->second;
    m_teleports.erase(I);
}

/// \brief Authenticate a teleport request
///
/// \param entity_id The ID of the entity that was created
/// \param possess_key The possess key sent by the client
LocatedEntity * TeleportAuthenticator::authenticateTeleport(const std::string &entity_id,
                                            const std::string &possess_key)
{
    PendingTeleportMap::iterator I = m_teleports.find(entity_id);
    if (I == m_teleports.end()) {
        log(ERROR, String::compose("Unable to find teleported entity with ID %1",
                                                                    entity_id));
        return NULL;
    }
    PendingTeleport *entry = I->second;
    assert(entry != 0);
    if (entry->validate(entity_id, possess_key)) {
        // We are authenticated!
        LocatedEntity * entity = BaseWorld::instance().getEntity(entity_id);
        if (entity == 0) {
            // This means the authentication entry itself is invalid. Remove it.
            log(ERROR, String::compose("Unable to find teleported entity with ID %1",
                                                                        entity_id));
            removeTeleport(I);
            return NULL;
        }
        // Don't remove the entry yet. It will be removed after connecting 
        // the entity to the account in Account::LookOperation() successfully
        // removeTeleport(entity_id);
        return entity;
    }
    // We failed the authentication. Keep authentication entry for retries.
    return NULL;
}