connecthand.cpp

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 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 3 of the  License,
       |                              or (at your option) any later version.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
 
#include <fc_config.h>
 
#include <cstring>
 
// utility
#include "capability.h"
#include "fcintl.h"
#include "log.h"
#include "registry_ini.h"
#include "support.h"
 
// generated
#include "fc_version.h"
 
// common
#include "capstr.h"
#include "events.h"
#include "game.h"
#include "packets.h"
#include "player.h"
#include "version.h"
 
// server
#include "aiiface.h"
#include "auth.h"
#include "diplhand.h"
#include "edithand.h"
#include "gamehand.h"
#include "maphand.h"
#include "meta.h"
#include "notify.h"
#include "plrhand.h"
#include "report.h"
#include "ruleset.h"
#include "settings.h"
#include "srv_main.h"
#include "stdinhand.h"
#include "voting.h"
 
#include "connecthand.h"
 
static bool connection_attach_real(struct connection *pconn,
                                   struct player *pplayer, bool observing,
                                   bool connecting);
 
void conn_set_access(struct connection *pconn, enum cmdlevel new_level,
                     bool granted)
{
  enum cmdlevel old_level = conn_get_access(pconn);
 
  pconn->access_level = new_level;
  if (granted) {
    pconn->server.granted_access_level = new_level;
  }
 
  if (old_level != new_level) {
    send_server_access_level_settings(pconn->self, old_level, new_level);
  }
}
 
static void restore_access_level(struct connection *pconn)
{
  // Restore previous privileges.
  enum cmdlevel level = pconn->server.granted_access_level;
 
  /* Detached connections must have at most the same privileges
   * as observers, unless they were granted something higher than
   * ALLOW_BASIC in the first place. */
  if ((pconn->observer || !pconn->playing) && level == ALLOW_BASIC) {
    level = ALLOW_INFO;
  }
 
  conn_set_access(pconn, level, false);
}
 
void establish_new_connection(struct connection *pconn)
{
  struct conn_list *dest = pconn->self;
  struct player *pplayer;
  struct packet_server_join_reply packet;
  struct packet_chat_msg connect_info;
  char hostname[512];
  bool delegation_error = false;
  struct packet_set_topology topo_packet;
 
  // zero out the password
  memset(pconn->server.password, 0, sizeof(pconn->server.password));
 
  // send join_reply packet
  packet.you_can_join = true;
  sz_strlcpy(packet.capability, our_capability);
  fc_snprintf(packet.message, sizeof(packet.message), _("%s Welcome"),
              pconn->username);
  sz_strlcpy(packet.challenge_file, new_challenge_filename(pconn));
  packet.conn_id = pconn->id;
  send_packet_server_join_reply(pconn, &packet);
 
  // "establish" the connection
  pconn->established = true;
  pconn->server.status = AS_ESTABLISHED;
 
  pconn->server.delegation.status = false;
  pconn->server.delegation.playing = nullptr;
  pconn->server.delegation.observer = false;
 
  conn_list_append(game.est_connections, pconn);
  if (conn_list_size(game.est_connections) == 1) {
    /* First connection
     * Replace "restarting in x seconds" meta message */
    maybe_automatic_meta_message(default_meta_message_string());
    (void) send_server_info_to_metaserver(META_INFO);
  }
 
  // introduce the server to the connection
  if (fc_gethostname(hostname, sizeof(hostname)) == 0) {
    notify_conn(dest, nullptr, E_CONNECTION, ftc_any,
                _("Welcome to the %s Server running at %s port %d."),
                freeciv_name_version(), hostname, srvarg.port);
  } else {
    notify_conn(dest, nullptr, E_CONNECTION, ftc_any,
                _("Welcome to the %s Server at port %d."),
                freeciv_name_version(), srvarg.port);
  }
 
  /* FIXME: this (getting messages about others logging on) should be a
   * message option for the client with event */
 
  // Notify the console that you're here.
  qInfo(_("%s has connected from %s."), pconn->username,
        qUtf8Printable(pconn->addr));
 
  conn_compression_freeze(pconn);
  send_rulesets(dest);
  send_server_setting_control(pconn);
  send_server_settings(dest);
  send_scenario_info(dest);
  send_scenario_description(dest);
  send_game_info(dest);
  topo_packet.topology_id = wld.map.topology_id;
  send_packet_set_topology(pconn, &topo_packet);
 
  // Do we have a player that a delegate is currently controlling?
  if ((pplayer = player_by_user_delegated(pconn->username))) {
    // Reassert our control over the player.
    struct connection *pdelegate;
    fc_assert_ret(player_delegation_get(pplayer) != nullptr);
    pdelegate = conn_by_user(player_delegation_get(pplayer));
 
    if (pdelegate && connection_delegate_restore(pdelegate)) {
      /* Delegate now detached from our player. We will restore control
       * over them as normal below. */
      notify_conn(pconn->self, nullptr, E_CONNECTION, ftc_server,
                  _("Your delegate %s was controlling your player '%s'; "
                    "now detached."),
                  pdelegate->username, player_name(pplayer));
      notify_conn(pdelegate->self, nullptr, E_CONNECTION, ftc_server,
                  _("%s reconnected, ending your delegated control of "
                    "player '%s'."),
                  pconn->username, player_name(pplayer));
    } else {
      fc_assert(pdelegate);
      // This really shouldn't happen.
      qCritical("Failed to revoke delegate %s's control of %s, so owner %s "
                "can't regain control.",
                pdelegate->username, player_name(pplayer), pconn->username);
      notify_conn(dest, nullptr, E_CONNECTION, ftc_server,
                  _("Couldn't get control of '%s' from delegation to %s."),
                  player_name(pplayer), pdelegate->username);
      delegation_error = true;
      pplayer = nullptr;
    }
  }
 
  if (!delegation_error) {
    if ((pplayer = player_by_user(pconn->username))
        && connection_attach_real(pconn, pplayer, false, true)) {
      // a player has already been created for this user, reconnect
 
      if (S_S_INITIAL == server_state()) {
        send_player_info_c(nullptr, dest);
      }
    } else {
      if (!game_was_started()) {
        if (connection_attach_real(pconn, nullptr, false, true)) {
          pplayer = conn_get_player(pconn);
          fc_assert(pplayer != nullptr);
        } else {
          notify_conn(dest, nullptr, E_CONNECTION, ftc_server,
                      _("Couldn't attach your connection to new player."));
          qDebug("%s is not attached to a player", pconn->username);
        }
      }
      send_player_info_c(nullptr, dest);
    }
  }
 
  send_conn_info(game.est_connections, dest);
 
  if (nullptr == pplayer) {
    // Else this has already been done in connection_attach_real().
    send_pending_events(pconn, true);
    send_running_votes(pconn, false);
    restore_access_level(pconn);
    send_conn_info(dest, game.est_connections);
 
    notify_conn(dest, nullptr, E_CONNECTION, ftc_server,
                _("You are logged in as '%s' connected to no player."),
                pconn->username);
  } else {
    notify_conn(dest, nullptr, E_CONNECTION, ftc_server,
                _("You are logged in as '%s' connected to %s."),
                pconn->username, player_name(pconn->playing));
  }
 
  // Send information about delegation(s).
  send_delegation_info(pconn);
 
  /* Notify the *other* established connections that you are connected, and
   * add the info for all in event cache. Note we must to do it after we
   * sent the pending events to pconn (from this function and also
   * connection_attach()), otherwise pconn will receive it too. */
  if (conn_controls_player(pconn)) {
    package_event(&connect_info, nullptr, E_CONNECTION, ftc_server,
                  _("%s has connected (player %s)."), pconn->username,
                  player_name(conn_get_player(pconn)));
  } else {
    package_event(&connect_info, nullptr, E_CONNECTION, ftc_server,
                  _("%s has connected."), pconn->username);
  }
  conn_list_iterate(game.est_connections, aconn)
  {
    if (aconn != pconn) {
      send_packet_chat_msg(aconn, &connect_info);
    }
  }
  conn_list_iterate_end;
  event_cache_add_for_all(&connect_info);
 
  // if need be, tell who we're waiting on to end the game.info.turn
  if (S_S_RUNNING == server_state() && game.server.turnblock
      && !game.server.fixedlength) {
    players_iterate_alive(cplayer)
    {
      if (is_human(cplayer) && !cplayer->phase_done
          && cplayer != pconn->playing) { // skip current player
        notify_conn(dest, nullptr, E_CONNECTION, ftc_any,
                    _("Turn-blocking game play: "
                      "waiting on %s to finish turn..."),
                    player_name(cplayer));
      }
    }
    players_iterate_alive_end;
  }
 
  if (game.info.is_edit_mode) {
    notify_conn(dest, nullptr, E_SETTING, ftc_editor,
                _(" *** Server is in edit mode. *** "));
  }
 
  if (nullptr != pplayer) {
    // Else, no need to do anything.
    reset_all_start_commands(true);
    (void) send_server_info_to_metaserver(META_INFO);
  }
 
  send_current_history_report(pconn->self);
 
  conn_compression_thaw(pconn);
}
 
void reject_new_connection(const char *msg, struct connection *pconn)
{
  struct packet_server_join_reply packet;
 
  // zero out the password
  memset(pconn->server.password, 0, sizeof(pconn->server.password));
 
  packet.you_can_join = false;
  sz_strlcpy(packet.capability, our_capability);
  sz_strlcpy(packet.message, msg);
  packet.challenge_file[0] = '\0';
  packet.conn_id = -1;
  send_packet_server_join_reply(pconn, &packet);
  qInfo(_("Client rejected: %s."), conn_description(pconn));
  flush_connection_send_buffer_all(pconn);
}
 
bool handle_login_request(struct connection *pconn,
                          struct packet_server_join_req *req)
{
  char msg[MAX_LEN_MSG];
  int kick_time_remaining;
 
  if (pconn->established || pconn->server.status != AS_NOT_ESTABLISHED) {
    /* We read the PACKET_SERVER_JOIN_REQ twice from this connection,
     * this is probably not a Freeciv21 client. */
    return false;
  }
 
  qInfo(_("Connection request from %s from %s"), req->username,
        qUtf8Printable(pconn->addr));
 
  // print server and client capabilities to console
  qInfo(_("%s has client version %d.%d.%d%s"), pconn->username,
        req->major_version, req->minor_version, req->patch_version,
        req->version_label);
  qDebug("Client caps: %s", req->capability);
  qDebug("Server caps: %s", our_capability);
  conn_set_capability(pconn, req->capability);
 
  // Make sure the server has every capability the client needs
  if (!has_capabilities(our_capability, req->capability)) {
    fc_snprintf(
        msg, sizeof(msg),
        _("The client is missing a capability that this server needs.\n"
          "Server version: %d.%d.%d%s Client version: %d.%d.%d%s."
          "  Upgrading may help!"),
        MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION, VERSION_LABEL,
        req->major_version, req->minor_version, req->patch_version,
        req->version_label);
    reject_new_connection(msg, pconn);
    qInfo(_("%s was rejected: Mismatched capabilities."), req->username);
    return false;
  }
 
  // Make sure the client has every capability the server needs
  if (!has_capabilities(req->capability, our_capability)) {
    fc_snprintf(
        msg, sizeof(msg),
        _("The server is missing a capability that the client needs.\n"
          "Server version: %d.%d.%d%s Client version: %d.%d.%d%s."
          "  Upgrading may help!"),
        MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION, VERSION_LABEL,
        req->major_version, req->minor_version, req->patch_version,
        req->version_label);
    reject_new_connection(msg, pconn);
    qInfo(_("%s was rejected: Mismatched capabilities."), req->username);
    return false;
  }
 
  {
    /* Client is compatible. That includes ability to receive server info.
     * Send it. */
    struct packet_server_info info;
 
    info.major_version = MAJOR_VERSION;
    info.minor_version = MINOR_VERSION;
    info.patch_version = PATCH_VERSION;
    info._obsolete = 0;
    sz_strlcpy(info.version_label, VERSION_LABEL);
    send_packet_server_info(pconn, &info);
  }
 
  remove_leading_trailing_spaces(req->username);
 
  // Name-sanity check: could add more checks?
  if (!is_valid_username(req->username)) {
    fc_snprintf(msg, sizeof(msg), _("Invalid username '%s'"), req->username);
    reject_new_connection(msg, pconn);
    qInfo(_("%s was rejected: Invalid name [%s]."), req->username,
          qUtf8Printable(pconn->addr));
    return false;
  }
 
  if (conn_is_kicked(pconn, &kick_time_remaining)) {
    fc_snprintf(msg, sizeof(msg),
                _("You have been kicked from this server "
                  "and cannot reconnect for %d seconds."),
                kick_time_remaining);
    reject_new_connection(msg, pconn);
    qInfo(_("%s was rejected: Connection kicked "
            "(%d seconds remaining)."),
          req->username, kick_time_remaining);
    return false;
  }
 
  // don't allow duplicate logins
  conn_list_iterate(game.all_connections, aconn)
  {
    if (fc_strcasecmp(req->username, aconn->username) == 0) {
      fc_snprintf(msg, sizeof(msg), _("'%s' already connected."),
                  req->username);
      reject_new_connection(msg, pconn);
      qInfo(_("%s was rejected: Duplicate login name [%s]."), req->username,
            qUtf8Printable(pconn->addr));
      return false;
    }
  }
  conn_list_iterate_end;
 
  // Remove the ping timeout given in sernet.c:server_make_connection().
  fc_assert_msg(1 == pconn->server.ping_timers->size(),
                "Ping timer list size %d, should be 1. Have we sent "
                "a ping to unestablished connection %s?",
                pconn->server.ping_timers->size(), conn_description(pconn));
 
  civtimer *deltimer = pconn->server.ping_timers->takeFirst();
  timer_destroy(deltimer);
 
  if (game.server.connectmsg[0] != '\0') {
    log_debug("Sending connectmsg: %s", game.server.connectmsg);
    dsend_packet_connect_msg(pconn, game.server.connectmsg);
  }
 
  if (srvarg.auth_enabled) {
    return auth_user(pconn, req->username);
  } else {
    sz_strlcpy(pconn->username, req->username);
    establish_new_connection(pconn);
    return true;
  }
}
 
void lost_connection_to_client(struct connection *pconn)
{
  fc_assert_ret(true == pconn->server.is_closing);
 
  qInfo(_("Lost connection: %s."), conn_description(pconn, true));
 
  // Special color (white on black) for player loss
  notify_conn(game.est_connections, nullptr, E_CONNECTION,
              conn_controls_player(pconn) ? ftc_player_lost : ftc_server,
              _("Lost connection: %s."), conn_description(pconn, false));
 
  connection_detach(pconn, true);
  send_conn_info_remove(pconn->self, game.est_connections);
  notify_if_first_access_level_is_available();
 
  check_for_full_turn_done();
}
 
static void package_conn_info(struct connection *pconn,
                              struct packet_conn_info *packet)
{
  packet->id = pconn->id;
  packet->used = pconn->used;
  packet->established = pconn->established;
  packet->player_num = (nullptr != pconn->playing)
                           ? player_number(pconn->playing)
                           : MAX_NUM_PLAYER_SLOTS;
  packet->observer = pconn->observer;
  packet->access_level = pconn->access_level;
 
  sz_strlcpy(packet->username, pconn->username);
  sz_strlcpy(packet->addr, "");
  sz_strlcpy(packet->capability, pconn->capability);
}
 
static void send_conn_info_arg(struct conn_list *src, struct conn_list *dest,
                               bool remove_conn)
{
  struct packet_conn_info packet;
 
  if (!dest) {
    dest = game.est_connections;
  }
 
  conn_list_iterate(src, psrc)
  {
    package_conn_info(psrc, &packet);
    if (remove_conn) {
      packet.used = false;
    }
    lsend_packet_conn_info(dest, &packet);
  }
  conn_list_iterate_end;
}
 
void send_conn_info(struct conn_list *src, struct conn_list *dest)
{
  send_conn_info_arg(src, dest, false);
}
 
void send_conn_info_remove(struct conn_list *src, struct conn_list *dest)
{
  send_conn_info_arg(src, dest, true);
}
 
struct player *find_uncontrolled_player()
{
  players_iterate(played)
  {
    if (!played->is_connected && !played->was_created) {
      return played;
    }
  }
  players_iterate_end;
 
  return nullptr;
}
 
static bool connection_attach_real(struct connection *pconn,
                                   struct player *pplayer, bool observing,
                                   bool connecting)
{
  fc_assert_ret_val(pconn != nullptr, false);
  fc_assert_ret_val_msg(!pconn->observer && pconn->playing == nullptr, false,
                        "connections must be detached with "
                        "connection_detach() before calling this!");
 
  if (!observing) {
    if (nullptr == pplayer) {
      // search for uncontrolled player
      pplayer = find_uncontrolled_player();
 
      if (nullptr == pplayer) {
        // no uncontrolled player found
        if (player_count() >= game.server.max_players
            || normal_player_count() >= server.playable_nations) {
          return false;
        }
        // add new player, or not
        /* Should only be called in such a way as to create a new player
         * in the pregame */
        fc_assert_ret_val(!game_was_started(), false);
        pplayer =
            server_create_player(-1, default_ai_type_name(), nullptr, false);
        // Pregame => no need to assign_player_colors()
        if (!pplayer) {
          return false;
        }
      } else {
        team_remove_player(pplayer);
      }
      server_player_init(pplayer, false, true);
 
      // Make it human!
      set_as_human(pplayer);
    }
 
    sz_strlcpy(pplayer->username, pconn->username);
    pplayer->unassigned_user = false;
    pplayer->user_turns = 0; // reset for a new user
    pplayer->is_connected = true;
 
    if (!game_was_started()) {
      if (!pplayer->was_created && nullptr == pplayer->nation) {
        // Temporarily set player_name() to username.
        server_player_set_name(pplayer, pconn->username);
      }
      (void) aifill(game.info.aifill);
    }
 
    if (game.server.auto_ai_toggle && !is_human(pplayer)) {
      toggle_ai_player_direct(nullptr, pplayer);
    }
 
    send_player_info_c(pplayer, game.est_connections);
 
    // Remove from global observers list, if was there
    conn_list_remove(game.glob_observers, pconn);
  } else if (pplayer == nullptr) {
    // Global observer
    bool already = false;
 
    fc_assert(observing);
 
    conn_list_iterate(game.glob_observers, pconn2)
    {
      if (pconn2 == pconn) {
        already = true;
        break;
      }
    }
    conn_list_iterate_end;
 
    if (!already) {
      conn_list_append(game.glob_observers, pconn);
    }
  }
 
  // We don't want the connection's username on another player.
  players_iterate(aplayer)
  {
    if (aplayer != pplayer
        && 0 == strncmp(aplayer->username, pconn->username, MAX_LEN_NAME)) {
      sz_strlcpy(aplayer->username, _(ANON_USER_NAME));
      aplayer->unassigned_user = true;
      send_player_info_c(aplayer, nullptr);
    }
  }
  players_iterate_end;
 
  pconn->observer = observing;
  pconn->playing = pplayer;
  if (pplayer) {
    conn_list_append(pplayer->connections, pconn);
  }
 
  restore_access_level(pconn);
 
  // Reset the delta-state.
  send_conn_info(pconn->self, game.est_connections); // Client side.
  conn_reset_delta_state(pconn);                     // Server side.
 
  /* Initial packets don't need to be resent.  See comment for
   * connecthand.c::establish_new_connection(). */
  switch (server_state()) {
  case S_S_INITIAL:
    send_pending_events(pconn, connecting);
    send_running_votes(pconn, !connecting);
    break;
 
  case S_S_RUNNING:
    conn_compression_freeze(pconn);
    send_all_info(pconn->self);
    if (game.info.is_edit_mode && can_conn_edit(pconn)) {
      edithand_send_initial_packets(pconn->self);
    }
    conn_compression_thaw(pconn);
    // Enter C_S_RUNNING client state.
    dsend_packet_start_phase(pconn, game.info.phase);
    // Must be after C_S_RUNNING client state to be effective.
    send_diplomatic_meetings(pconn);
    send_pending_events(pconn, connecting);
    send_running_votes(pconn, !connecting);
    break;
 
  case S_S_OVER:
    conn_compression_freeze(pconn);
    send_all_info(pconn->self);
    if (game.info.is_edit_mode && can_conn_edit(pconn)) {
      edithand_send_initial_packets(pconn->self);
    }
    conn_compression_thaw(pconn);
    report_final_scores(pconn->self);
    send_pending_events(pconn, connecting);
    send_running_votes(pconn, !connecting);
    if (!connecting) {
      // Send information about delegation(s).
      send_delegation_info(pconn);
    }
    break;
  }
 
  send_updated_vote_totals(nullptr);
 
  return true;
}
 
bool connection_attach(struct connection *pconn, struct player *pplayer,
                       bool observing)
{
  return connection_attach_real(pconn, pplayer, observing, false);
}
 
void connection_detach(struct connection *pconn, bool remove_unused_player)
{
  struct player *pplayer;
 
  fc_assert_ret(pconn != nullptr);
 
  if (nullptr != (pplayer = pconn->playing)) {
    bool was_connected = pplayer->is_connected;
 
    send_remove_team_votes(pconn);
    conn_list_remove(pplayer->connections, pconn);
    pconn->playing = nullptr;
    pconn->observer = false;
    restore_access_level(pconn);
    cancel_connection_votes(pconn);
    send_updated_vote_totals(nullptr);
    send_conn_info(pconn->self, game.est_connections);
 
    /* If any other (non-observing) conn is attached to this player, the
     * player is still connected. */
    pplayer->is_connected = false;
    conn_list_iterate(pplayer->connections, aconn)
    {
      if (!aconn->observer) {
        pplayer->is_connected = true;
        break;
      }
    }
    conn_list_iterate_end;
 
    if (was_connected && !pplayer->is_connected) {
      // Player just lost its controlling connection.
      if (remove_unused_player && !pplayer->was_created
          && !game_was_started()) {
        // Remove player.
        conn_list_iterate(pplayer->connections, aconn)
        {
          // Detach all.
          fc_assert_action(aconn != pconn, continue);
          notify_conn(aconn->self, nullptr, E_CONNECTION, ftc_server,
                      _("Detaching from %s."), player_name(pplayer));
          /* Recursive... but shouldn't be a problem, as this can only
           * be a non-controlling connection so can't get back here. */
          connection_detach(aconn, true);
        }
        conn_list_iterate_end;
 
        // Actually do the removal.
        server_remove_player(pplayer);
        (void) aifill(game.info.aifill);
        reset_all_start_commands(true);
      } else {
        // Aitoggle the player if no longer connected.
        if (game.server.auto_ai_toggle && is_human(pplayer)) {
          toggle_ai_player_direct(nullptr, pplayer);
          /* send_player_info_c() was formerly updated by
           * toggle_ai_player_direct(), so it must be safe to send here now?
           *
           * At other times, data from send_conn_info() is used by the
           * client to display player information.
           * See establish_new_connection().
           */
          qDebug("connection_detach() calls send_player_info_c()");
          send_player_info_c(pplayer, nullptr);
 
          reset_all_start_commands(true);
        } else {
          // is_connected has changed
          send_player_info_c(pplayer, nullptr);
        }
      }
    }
  } else {
    pconn->observer = false;
    restore_access_level(pconn);
    send_conn_info(pconn->self, game.est_connections);
  }
}
 
bool connection_delegate_take(struct connection *pconn,
                              struct player *dplayer)
{
  fc_assert_ret_val(pconn->server.delegation.status == false, false);
 
  /* Save the original player of this connection and the original username of
   * the player. */
  pconn->server.delegation.status = true;
  pconn->server.delegation.playing = conn_get_player(pconn);
  pconn->server.delegation.observer = pconn->observer;
  if (conn_controls_player(pconn)) {
    /* Setting orig_username in the player we're about to put aside is
     * a flag that no-one should be allowed to mess with it (e.g. /take). */
    struct player *oplayer = conn_get_player(pconn);
 
    fc_assert_ret_val(oplayer != dplayer, false);
    fc_assert_ret_val(strlen(oplayer->server.orig_username) == 0, false);
    sz_strlcpy(oplayer->server.orig_username, oplayer->username);
  }
  fc_assert_ret_val(strlen(dplayer->server.orig_username) == 0, false);
  sz_strlcpy(dplayer->server.orig_username, dplayer->username);
 
  // Detach the current connection.
  if (nullptr != pconn->playing || pconn->observer) {
    connection_detach(pconn, false);
  }
 
  // Try to attach to the new player
  if (!connection_attach(pconn, dplayer, false)) {
    // Restore original connection.
    bool success = connection_attach(pconn, pconn->server.delegation.playing,
                                     pconn->server.delegation.observer);
    fc_assert_ret_val(success, false);
 
    // Reset all changes done above.
    pconn->server.delegation.status = false;
    pconn->server.delegation.playing = nullptr;
    pconn->server.delegation.observer = false;
    if (conn_controls_player(pconn)) {
      struct player *oplayer = conn_get_player(pconn);
      oplayer->server.orig_username[0] = '\0';
    }
    dplayer->server.orig_username[0] = '\0';
 
    return false;
  }
 
  return true;
}
 
bool connection_delegate_restore(struct connection *pconn)
{
  struct player *dplayer;
 
  if (!pconn->server.delegation.status) {
    return false;
  }
 
  if (pconn->server.delegation.playing
      && !pconn->server.delegation.observer) {
    /* If restoring to controlling another player, and we're not the
     * original controller of that player, something's gone wrong. */
    fc_assert_ret_val(
        strcmp(pconn->server.delegation.playing->server.orig_username,
               pconn->username)
            == 0,
        false);
  }
 
  // Save the current (delegated) player.
  dplayer = conn_get_player(pconn);
 
  // There should be a delegated player connected to pconn.
  fc_assert_ret_val(dplayer, false);
 
  // Detach the current (delegate) connection from the delegated player.
  if (nullptr != pconn->playing || pconn->observer) {
    connection_detach(pconn, false);
  }
 
  // Try to attach to the delegate's original player
  if ((nullptr != pconn->server.delegation.playing
       || pconn->server.delegation.observer)
      && !connection_attach(pconn, pconn->server.delegation.playing,
                            pconn->server.delegation.observer)) {
    return false;
  }
 
  // Reset data.
  pconn->server.delegation.status = false;
  pconn->server.delegation.playing = nullptr;
  pconn->server.delegation.observer = false;
  if (conn_controls_player(pconn) && conn_get_player(pconn) != nullptr) {
    // Remove flag that we had 'put aside' our original player.
    struct player *oplayer = conn_get_player(pconn);
    fc_assert_ret_val(oplayer != dplayer, false);
    oplayer->server.orig_username[0] = '\0';
  }
 
  /* Restore the username of the original controller in the previously-
   * delegated player. */
  sz_strlcpy(dplayer->username, dplayer->server.orig_username);
  dplayer->server.orig_username[0] = '\0';
  // Send updated username to all connections.
  send_player_info_c(dplayer, nullptr);
 
  return true;
}
 
void connection_close_server(struct connection *pconn, const QString &reason)
{
  // Restore possible delegations before the connection is closed.
  connection_delegate_restore(pconn);
  connection_close(pconn, reason);
}