Freeciv-3.1
|
#include "fc_prehdrs.h"
#include <errno.h>
#include <string.h>
#include <time.h>
#include "fcintl.h"
#include "genhash.h"
#include "log.h"
#include "mem.h"
#include "netintf.h"
#include "support.h"
#include "game.h"
#include "packets.h"
#include "connection.h"
Go to the source code of this file.
Data Structures | |
struct | conn_pattern |
Functions | |
static void | default_conn_close_callback (struct connection *pconn) |
void | connections_set_close_callback (conn_close_fn_t func) |
void | connection_close (struct connection *pconn, const char *reason) |
static bool | buffer_ensure_free_extra_space (struct socket_packet_buffer *buf, int extra_space) |
int | read_socket_data (int sock, struct socket_packet_buffer *buffer) |
static int | write_socket_data (struct connection *pc, struct socket_packet_buffer *buf, int limit) |
void | flush_connection_send_buffer_all (struct connection *pc) |
static void | flush_connection_send_buffer_packets (struct connection *pc) |
static bool | add_connection_data (struct connection *pconn, const unsigned char *data, int len) |
bool | connection_send_data (struct connection *pconn, const unsigned char *data, int len) |
void | connection_do_buffer (struct connection *pc) |
void | connection_do_unbuffer (struct connection *pc) |
void | conn_list_do_buffer (struct conn_list *dest) |
void | conn_list_do_unbuffer (struct conn_list *dest) |
struct connection * | conn_by_user (const char *user_name) |
static const char * | connection_accessor (int i) |
struct connection * | conn_by_user_prefix (const char *user_name, enum m_pre_result *result) |
struct connection * | conn_by_number (int id) |
struct socket_packet_buffer * | new_socket_packet_buffer (void) |
static void | free_socket_packet_buffer (struct socket_packet_buffer *buf) |
const char * | conn_description (const struct connection *pconn) |
bool | can_conn_edit (const struct connection *pconn) |
bool | can_conn_enable_editing (const struct connection *pconn) |
int | get_next_request_id (int old_request_id) |
void | free_compression_queue (struct connection *pc) |
static void | init_packet_hashes (struct connection *pc) |
static void | free_packet_hashes (struct connection *pc) |
void | connection_common_init (struct connection *pconn) |
void | connection_common_close (struct connection *pconn) |
void | conn_set_capability (struct connection *pconn, const char *capability) |
void | conn_reset_delta_state (struct connection *pc) |
void | conn_compression_freeze (struct connection *pconn) |
bool | conn_compression_frozen (const struct connection *pconn) |
void | conn_list_compression_freeze (const struct conn_list *pconn_list) |
void | conn_list_compression_thaw (const struct conn_list *pconn_list) |
bool | conn_controls_player (const struct connection *pconn) |
bool | conn_is_global_observer (const struct connection *pconn) |
struct player * | conn_get_player (const struct connection *pconn) |
enum cmdlevel | conn_get_access (const struct connection *pconn) |
struct conn_pattern * | conn_pattern_new (enum conn_pattern_type type, const char *wildcard) |
void | conn_pattern_destroy (struct conn_pattern *ppattern) |
bool | conn_pattern_match (const struct conn_pattern *ppattern, const struct connection *pconn) |
bool | conn_pattern_list_match (const struct conn_pattern_list *plist, const struct connection *pconn) |
size_t | conn_pattern_to_string (const struct conn_pattern *ppattern, char *buf, size_t buf_len) |
struct conn_pattern * | conn_pattern_from_string (const char *pattern, enum conn_pattern_type prefer, char *error_buf, size_t error_buf_len) |
bool | conn_is_valid (const struct connection *pconn) |
Variables | |
const char | blank_addr_str [] = "---.---.---.---" |
static conn_close_fn_t | conn_close_callback = default_conn_close_callback |
|
static |
Add data to send to the connection.
Definition at line 259 of file connection.c.
Referenced by connection_send_data().
|
static |
Make sure that there is at least extra_space bytes free space in buffer, allocating more memory if needed.
Definition at line 104 of file connection.c.
Referenced by add_connection_data(), and read_socket_data().
bool can_conn_edit | ( | const struct connection * | pconn | ) |
Return TRUE iff the connection is currently allowed to edit.
Definition at line 510 of file connection.c.
Referenced by can_conn_edit_players_nation(), connection_attach_real(), edithand_send_initial_packets(), editor_is_active(), handle_edit_startpos(), handle_edit_startpos_full(), science_diagram_data(), and server_packet_input().
bool can_conn_enable_editing | ( | const struct connection * | pconn | ) |
Return TRUE iff the connection is allowed to start editing.
Definition at line 520 of file connection.c.
Referenced by can_conn_edit(), handle_edit_mode(), and real_menus_update().
struct connection * conn_by_number | ( | int | id | ) |
Find connection by id, from game.all_connections. Returns NULL if not found. Number of connections will always be relatively small given current implementation, so linear search should be fine.
Definition at line 420 of file connection.c.
Referenced by check_vote(), conn_list_selection(), connect_list_right_button(), connection_list_event(), handle_conn_info(), handle_conn_ping_info(), lsend_vote_new(), lsend_vote_update(), makeup_connection_name(), object_extract(), and vote_get_caller().
struct connection * conn_by_user | ( | const char * | user_name | ) |
Find connection by exact user name, from game.all_connections, case-insensitive. Returns NULL if not found.
Definition at line 376 of file connection.c.
Referenced by delegate_command(), establish_new_connection(), get_unique_guest_name(), is_allowed_city_name(), and makeup_connection_name().
struct connection * conn_by_user_prefix | ( | const char * | user_name, |
enum m_pre_result * | result | ||
) |
Definition at line 397 of file connection.c.
Referenced by cmdlevel_command(), cut_client_connection(), detach_command(), handle_chat_msg_req(), kick_command(), observe_command(), and take_command().
void conn_compression_freeze | ( | struct connection * | pconn | ) |
Freeze the connection. Then the packets sent to it won't be sent immediately, but later, using a compression method. See further details in common/networking/packets.[ch].
Definition at line 691 of file connection.c.
Referenced by conn_list_compression_freeze(), connection_attach_real(), establish_new_connection(), and start_processing_request().
bool conn_compression_frozen | ( | const struct connection * | pconn | ) |
Returns TRUE if the connection is frozen. See also conn_compression_freeze().
Definition at line 705 of file connection.c.
Referenced by send_packet_data().
bool conn_controls_player | ( | const struct connection * | pconn | ) |
Returns TRUE if the given connection is attached to a player which it also controls (i.e. not a player observer).
Definition at line 742 of file connection.c.
Referenced by away_command(), conn_can_vote(), connection_delegate_restore(), connection_delegate_take(), cut_client_connection(), delegate_command(), establish_new_connection(), kick_command(), lost_connection_to_client(), send_all_info(), and surrender_command().
const char * conn_description | ( | const struct connection * | pconn | ) |
Return pointer to static string containing a description for this connection, based on pconn->name, pconn->addr, and (if applicable) pconn->playing->name. (Also pconn->established and pconn->observer.)
Note that when pconn is client.conn (connection to server), pconn->name and pconn->addr contain empty string, and pconn->playing is NULL: in this case return string "server".
Definition at line 473 of file connection.c.
Referenced by conn_compression_thaw(), conn_list_select_conn(), connection_ping(), connection_send_data(), cut_lagging_connection(), default_conn_close_callback(), flush_packets(), handle_conn_pong(), handle_edit_mode(), handle_login_request(), handle_vote_submit(), lost_connection_to_client(), packet_check(), reject_new_connection(), send_packet_achievement_info(), send_packet_authentication_reply(), send_packet_authentication_req(), send_packet_begin_turn(), send_packet_calendar_info(), send_packet_chat_msg(), send_packet_chat_msg_req(), send_packet_city_buy(), send_packet_city_change(), send_packet_city_change_specialist(), send_packet_city_info(), send_packet_city_make_specialist(), send_packet_city_make_worker(), send_packet_city_name_suggestion_info(), send_packet_city_name_suggestion_req(), send_packet_city_nationalities(), send_packet_city_options_req(), send_packet_city_rally_point(), send_packet_city_refresh(), send_packet_city_remove(), send_packet_city_rename(), send_packet_city_sabotage_list(), send_packet_city_sell(), send_packet_city_short_info(), send_packet_city_worklist(), send_packet_client_heartbeat(), send_packet_client_info(), send_packet_conn_info(), send_packet_conn_ping(), send_packet_conn_ping_info(), send_packet_conn_pong(), send_packet_connect_msg(), send_packet_diplomacy_accept_treaty(), send_packet_diplomacy_accept_treaty_req(), send_packet_diplomacy_cancel_meeting(), send_packet_diplomacy_cancel_meeting_req(), send_packet_diplomacy_cancel_pact(), send_packet_diplomacy_create_clause(), send_packet_diplomacy_create_clause_req(), send_packet_diplomacy_init_meeting(), send_packet_diplomacy_init_meeting_req(), send_packet_diplomacy_remove_clause(), send_packet_diplomacy_remove_clause_req(), send_packet_early_chat_msg(), send_packet_edit_check_tiles(), send_packet_edit_city(), send_packet_edit_city_create(), send_packet_edit_city_remove(), send_packet_edit_game(), send_packet_edit_mode(), send_packet_edit_object_created(), send_packet_edit_player(), send_packet_edit_player_create(), send_packet_edit_player_remove(), send_packet_edit_player_vision(), send_packet_edit_recalculate_borders(), send_packet_edit_scenario_desc(), send_packet_edit_startpos(), send_packet_edit_startpos_full(), send_packet_edit_tile(), send_packet_edit_tile_extra(), send_packet_edit_tile_terrain(), send_packet_edit_toggle_fogofwar(), send_packet_edit_unit(), send_packet_edit_unit_create(), send_packet_edit_unit_remove(), send_packet_edit_unit_remove_by_id(), send_packet_end_phase(), send_packet_end_turn(), send_packet_endgame_player(), send_packet_endgame_report(), send_packet_freeze_client(), send_packet_game_info(), send_packet_game_load(), send_packet_investigate_finished(), send_packet_investigate_started(), send_packet_map_info(), send_packet_nation_availability(), send_packet_nation_select_req(), send_packet_new_year(), send_packet_nuke_tile_info(), send_packet_page_msg(), send_packet_page_msg_part(), send_packet_play_music(), send_packet_player_attribute_block(), send_packet_player_attribute_chunk(), send_packet_player_change_government(), send_packet_player_diplstate(), send_packet_player_info(), send_packet_player_multiplier(), send_packet_player_phase_done(), send_packet_player_place_infra(), send_packet_player_rates(), send_packet_player_ready(), send_packet_player_remove(), send_packet_player_research(), send_packet_player_tech_goal(), send_packet_processing_finished(), send_packet_processing_started(), send_packet_report_req(), send_packet_research_info(), send_packet_ruleset_achievement(), send_packet_ruleset_action(), send_packet_ruleset_action_auto(), send_packet_ruleset_action_enabler(), send_packet_ruleset_base(), send_packet_ruleset_building(), send_packet_ruleset_choices(), send_packet_ruleset_city(), send_packet_ruleset_clause(), send_packet_ruleset_control(), send_packet_ruleset_description_part(), send_packet_ruleset_disaster(), send_packet_ruleset_effect(), send_packet_ruleset_extra(), send_packet_ruleset_extra_flag(), send_packet_ruleset_game(), send_packet_ruleset_goods(), send_packet_ruleset_government(), send_packet_ruleset_government_ruler_title(), send_packet_ruleset_multiplier(), send_packet_ruleset_music(), send_packet_ruleset_nation(), send_packet_ruleset_nation_groups(), send_packet_ruleset_nation_sets(), send_packet_ruleset_resource(), send_packet_ruleset_road(), send_packet_ruleset_specialist(), send_packet_ruleset_style(), send_packet_ruleset_summary(), send_packet_ruleset_tech(), send_packet_ruleset_tech_class(), send_packet_ruleset_tech_flag(), send_packet_ruleset_terrain(), send_packet_ruleset_terrain_control(), send_packet_ruleset_terrain_flag(), send_packet_ruleset_trade(), send_packet_ruleset_unit(), send_packet_ruleset_unit_bonus(), send_packet_ruleset_unit_class(), send_packet_ruleset_unit_class_flag(), send_packet_ruleset_unit_flag(), send_packet_rulesets_ready(), send_packet_save_scenario(), send_packet_scenario_description(), send_packet_scenario_info(), send_packet_server_info(), send_packet_server_join_reply(), send_packet_server_join_req(), send_packet_server_setting_bitwise(), send_packet_server_setting_bool(), send_packet_server_setting_const(), send_packet_server_setting_control(), send_packet_server_setting_enum(), send_packet_server_setting_int(), send_packet_server_setting_str(), send_packet_server_shutdown(), send_packet_set_topology(), send_packet_single_want_hack_reply(), send_packet_single_want_hack_req(), send_packet_spaceship_info(), send_packet_spaceship_launch(), send_packet_spaceship_place(), send_packet_start_phase(), send_packet_team_name_info(), send_packet_thaw_client(), send_packet_tile_info(), send_packet_timeout_info(), send_packet_trade_route_info(), send_packet_unit_action_answer(), send_packet_unit_action_query(), send_packet_unit_actions(), send_packet_unit_change_activity(), send_packet_unit_combat_info(), send_packet_unit_do_action(), send_packet_unit_get_actions(), send_packet_unit_info(), send_packet_unit_orders(), send_packet_unit_remove(), send_packet_unit_server_side_agent_set(), send_packet_unit_short_info(), send_packet_unit_sscs_set(), send_packet_unit_type_upgrade(), send_packet_unknown_research(), send_packet_vote_new(), send_packet_vote_remove(), send_packet_vote_resolve(), send_packet_vote_submit(), send_packet_vote_update(), send_packet_web_city_info_addition(), send_packet_web_player_info_addition(), send_packet_web_ruleset_unit_addition(), send_packet_worker_task(), send_remove_team_votes(), send_running_votes(), server_packet_input(), server_sniff_all_input(), and show_connections().
enum cmdlevel conn_get_access | ( | const struct connection * | pconn | ) |
Returns the current access level of the given connection. NB: If 'pconn' is NULL, this function will return ALLOW_NONE.
Definition at line 772 of file connection.c.
Referenced by cancelvote_command(), cmdlevel_command(), conn_can_vote(), conn_set_access(), delegate_command(), handle_stdin_input_real(), kick_command(), and may_use_nothing().
struct player * conn_get_player | ( | const struct connection * | pconn | ) |
Returns the player that this connection is attached to, or NULL. Note that this will return the observed player for connections that are observing players.
Definition at line 760 of file connection.c.
Referenced by away_command(), cancelvote_command(), check_vote(), conn_can_see_vote(), conn_can_vote(), connection_delegate_restore(), connection_delegate_take(), delegate_command(), establish_new_connection(), handle_stdin_input_real(), really_close_connections(), send_city_turn_notifications(), send_pending_events(), send_remove_team_votes(), send_research_info(), send_running_votes(), send_unit_info(), surrender_command(), and unit_move().
bool conn_is_global_observer | ( | const struct connection * | pconn | ) |
Returns TRUE if the given connection is a global observer.
Definition at line 750 of file connection.c.
Referenced by broadcast_city_info(), chat_msg_to_global_observers(), conn_can_see_vote(), send_city_info_at_tile(), send_pending_events(), and server_remove_unit_full().
bool conn_is_valid | ( | const struct connection * | pconn | ) |
Returns TRUE if the connection is valid, i.e. not NULL, not closed, not closing, etc.
Definition at line 931 of file connection.c.
Referenced by api_auth_get_ipaddr(), and api_auth_get_username().
void conn_list_compression_freeze | ( | const struct conn_list * | pconn_list | ) |
Freeze a connection list.
Definition at line 717 of file connection.c.
Referenced by buffer_shared_vision(), load_command(), send_rulesets(), and srv_ready().
void conn_list_compression_thaw | ( | const struct conn_list * | pconn_list | ) |
Thaw a connection list.
Definition at line 729 of file connection.c.
Referenced by load_command(), send_rulesets(), srv_ready(), and unbuffer_shared_vision().
void conn_list_do_buffer | ( | struct conn_list * | dest | ) |
Convenience functions to buffer a list of connections.
Definition at line 355 of file connection.c.
Referenced by begin_phase(), buffer_shared_vision(), check_leaving_edit_mode(), city_refresh_for_player(), do_unit_establish_trade(), handle_edit_city(), handle_edit_city_create(), handle_edit_player_vision(), handle_edit_tile_extra(), handle_edit_tile_terrain(), handle_edit_toggle_fogofwar(), handle_edit_unit_create(), handle_unit_type_upgrade(), really_handle_city_buy(), remove_player_from_maps(), send_all_known_cities(), send_all_known_tiles(), send_all_known_units(), send_updated_vote_totals(), srv_running(), transform_unit(), unit_do_help_build(), unit_move(), and upgrade_all_city_extras().
void conn_list_do_unbuffer | ( | struct conn_list * | dest | ) |
Convenience functions to unbuffer a list of connections.
Definition at line 365 of file connection.c.
Referenced by begin_phase(), check_leaving_edit_mode(), city_refresh_for_player(), do_unit_establish_trade(), handle_edit_city(), handle_edit_city_create(), handle_edit_player_vision(), handle_edit_tile_extra(), handle_edit_tile_terrain(), handle_edit_toggle_fogofwar(), handle_edit_unit_create(), handle_unit_type_upgrade(), really_handle_city_buy(), remove_player_from_maps(), send_all_known_cities(), send_all_known_tiles(), send_all_known_units(), send_updated_vote_totals(), srv_running(), transform_unit(), unbuffer_shared_vision(), unit_do_help_build(), unit_move(), and upgrade_all_city_extras().
void conn_pattern_destroy | ( | struct conn_pattern * | ppattern | ) |
Free a connection pattern.
Definition at line 806 of file connection.c.
Referenced by ignore_command(), and server_make_connection().
struct conn_pattern * conn_pattern_from_string | ( | const char * | pattern, |
enum conn_pattern_type | prefer, | ||
char * | error_buf, | ||
size_t | error_buf_len | ||
) |
Creates a new connection pattern from the string. If the type is not specified in 'pattern', then 'prefer' type will be used. If the type is needed, then pass conn_pattern_type_invalid() for 'prefer'.
Definition at line 875 of file connection.c.
Referenced by ignore_command().
bool conn_pattern_list_match | ( | const struct conn_pattern_list * | plist, |
const struct connection * | pconn | ||
) |
Returns TRUE whether the connection fits one of the connection patterns.
Definition at line 847 of file connection.c.
Referenced by conn_is_ignored().
bool conn_pattern_match | ( | const struct conn_pattern * | ppattern, |
const struct connection * | pconn | ||
) |
Returns TRUE whether the connection fits the connection pattern.
Definition at line 816 of file connection.c.
Referenced by conn_pattern_list_match().
struct conn_pattern * conn_pattern_new | ( | enum conn_pattern_type | type, |
const char * | wildcard | ||
) |
Creates a new connection pattern.
Definition at line 792 of file connection.c.
Referenced by conn_pattern_from_string().
size_t conn_pattern_to_string | ( | const struct conn_pattern * | ppattern, |
char * | buf, | ||
size_t | buf_len | ||
) |
Put a string representation of the pattern in 'buf'.
Definition at line 862 of file connection.c.
Referenced by ignore_command(), show_ignore(), and unignore_command().
void conn_reset_delta_state | ( | struct connection * | pc | ) |
Remove all is-game-info cached packets from the connection. This resets the delta-state partially.
Definition at line 670 of file connection.c.
Referenced by connection_attach_real(), and set_client_state().
void conn_set_capability | ( | struct connection * | pconn, |
const char * | capability | ||
) |
Set the network capability string for 'pconn'.
Definition at line 658 of file connection.c.
Referenced by handle_login_request(), and handle_server_join_reply().
|
static |
Like conn_by_username(), but allow unambiguous prefix (i.e. abbreviation). Returns NULL if could not match, or if ambiguous or other problem, and fills *result with characterisation of match/non-match (see "utility/shared.[ch]").
Definition at line 393 of file connection.c.
Referenced by conn_by_user_prefix().
void connection_close | ( | struct connection * | pconn, |
const char * | reason | ||
) |
Call the conn_close_callback.
Definition at line 88 of file connection.c.
Referenced by add_connection_data(), connection_close_server(), get_packet_from_connection_raw(), input_from_server(), input_from_server_till_request_got_processed(), and write_socket_data().
void connection_common_close | ( | struct connection * | pconn | ) |
Connection closing part common to server and client.
Definition at line 627 of file connection.c.
Referenced by close_connection(), and close_socket_nomessage().
void connection_common_init | ( | struct connection * | pconn | ) |
Initialize common part of connection structure. This is used by both server and client.
Definition at line 602 of file connection.c.
Referenced by make_connection(), manual_command(), and server_make_connection().
void connection_do_buffer | ( | struct connection * | pc | ) |
Turn on buffering, using a counter so that calls may be nested.
Definition at line 323 of file connection.c.
Referenced by apply_result_on_server(), buy_production_in_selected_cities(), city_clear_worklist_callback(), city_clear_worklist_callback(), client_change_all(), clipboard_paste_production(), conn_list_do_buffer(), edit_buffer_paste(), editor_apply_tool_to_selection(), incoming_client_packets(), property_page_destroy_objects(), property_page_send_values(), select_impr_or_unit_callback(), select_impr_or_unit_callback(), send_attribute_block(), send_remove_team_votes(), and send_running_votes().
void connection_do_unbuffer | ( | struct connection * | pc | ) |
Turn off buffering if internal counter of number of times buffering was turned on falls to zero, to handle nested buffer/unbuffer pairs. When counter is zero, flush any pending data.
Definition at line 335 of file connection.c.
Referenced by apply_result_on_server(), buy_production_in_selected_cities(), city_clear_worklist_callback(), city_clear_worklist_callback(), client_change_all(), clipboard_paste_production(), conn_list_do_unbuffer(), edit_buffer_paste(), editor_apply_tool_to_selection(), incoming_client_packets(), property_page_destroy_objects(), property_page_send_values(), select_impr_or_unit_callback(), select_impr_or_unit_callback(), send_attribute_block(), send_remove_team_votes(), and send_running_votes().
bool connection_send_data | ( | struct connection * | pconn, |
const unsigned char * | data, | ||
int | len | ||
) |
Write data to socket. Return TRUE on success.
Definition at line 286 of file connection.c.
Referenced by conn_compression_flush(), send_packet_data(), and server_packet_input().
void connections_set_close_callback | ( | conn_close_fn_t | func | ) |
Register the close_callback.
Definition at line 80 of file connection.c.
Referenced by server_open_socket(), and try_to_connect().
|
static |
Default 'conn_close_fn_t' to close a connection.
Definition at line 70 of file connection.c.
Referenced by default_conn_close_callback().
void flush_connection_send_buffer_all | ( | struct connection * | pc | ) |
Flush'em
Definition at line 229 of file connection.c.
Referenced by connection_do_unbuffer(), connection_send_data(), flush_packets(), read_from_connection(), reject_new_connection(), and server_sniff_all_input().
|
static |
void free_compression_queue | ( | struct connection * | pc | ) |
Free compression queue for given connection.
Definition at line 546 of file connection.c.
Referenced by connection_common_close().
|
static |
Free packet hash resources from given connection.
Definition at line 573 of file connection.c.
Referenced by connection_common_close().
|
static |
Free malloced struct
Definition at line 454 of file connection.c.
Referenced by connection_common_close().
int get_next_request_id | ( | int | old_request_id | ) |
Get next request id. Takes wrapping of the 16 bit wide unsigned int into account.
Definition at line 529 of file connection.c.
Referenced by handle_processing_started(), incoming_client_packets(), and send_packet_data().
|
static |
Allocate and initialize packet hashes for given connection.
Definition at line 556 of file connection.c.
Referenced by connection_common_init().
struct socket_packet_buffer * new_socket_packet_buffer | ( | void | ) |
Return malloced struct, appropriately initialized.
Definition at line 438 of file connection.c.
Referenced by connection_common_init().
int read_socket_data | ( | int | sock, |
struct socket_packet_buffer * | buffer | ||
) |
Read data from socket, and check if a packet is ready. Returns: -1 : an error occurred - you should close the socket -2 : the connection was closed >0 : number of bytes read =0 : non-blocking sockets only; no data read, would block
Definition at line 129 of file connection.c.
Referenced by read_from_connection(), and server_sniff_all_input().
|
static |
Write wrapper function -vasc
Definition at line 164 of file connection.c.
Referenced by flush_connection_send_buffer_all(), and flush_connection_send_buffer_packets().
const char blank_addr_str[] = "---.---.---.---" |
Definition at line 55 of file connection.c.
Referenced by player_addr_hack().
|
static |
Definition at line 65 of file connection.c.
Referenced by connections_set_close_callback(), and default_conn_close_callback().