3 Copyright (C) 2010-2014 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "clientiface.h"
23 #include "util/numeric.h"
24 #include "remoteplayer.h"
27 #include "network/connection.h"
28 #include "serverenvironment.h"
31 #include "content_sao.h" // TODO this is used for cleanup of only
35 const char *ClientInterface::statenames[] = {
50 std::string ClientInterface::state2Name(ClientState state)
52 return statenames[state];
55 void RemoteClient::ResendBlockIfOnWire(v3s16 p)
57 // if this block is on wire, mark it for sending again as soon as possible
58 if (m_blocks_sending.find(p) != m_blocks_sending.end()) {
63 void RemoteClient::GetNextBlocks (
64 ServerEnvironment *env,
65 EmergeManager * emerge,
67 std::vector<PrioritySortedBlockTransfer> &dest)
69 DSTACK(FUNCTION_NAME);
73 m_nothing_to_send_pause_timer -= dtime;
74 m_nearest_unsent_reset_timer += dtime;
76 if(m_nothing_to_send_pause_timer >= 0)
79 RemotePlayer *player = env->getPlayer(peer_id);
80 // This can happen sometimes; clients and players are not in perfect sync.
84 PlayerSAO *sao = player->getPlayerSAO();
88 // Won't send anything if already sending
89 if(m_blocks_sending.size() >= g_settings->getU16
90 ("max_simultaneous_block_sends_per_client"))
92 //infostream<<"Not sending any blocks, Queue full."<<std::endl;
96 v3f playerpos = sao->getBasePosition();
97 v3f playerspeed = player->getSpeed();
98 v3f playerspeeddir(0,0,0);
99 if(playerspeed.getLength() > 1.0*BS)
100 playerspeeddir = playerspeed / playerspeed.getLength();
101 // Predict to next block
102 v3f playerpos_predicted = playerpos + playerspeeddir*MAP_BLOCKSIZE*BS;
104 v3s16 center_nodepos = floatToInt(playerpos_predicted, BS);
106 v3s16 center = getNodeBlockPos(center_nodepos);
108 // Camera position and direction
109 v3f camera_pos = sao->getEyePosition();
110 v3f camera_dir = v3f(0,0,1);
111 camera_dir.rotateYZBy(sao->getPitch());
112 camera_dir.rotateXZBy(sao->getYaw());
114 /*infostream<<"camera_dir=("<<camera_dir.X<<","<<camera_dir.Y<<","
115 <<camera_dir.Z<<")"<<std::endl;*/
118 Get the starting value of the block finder radius.
121 if(m_last_center != center)
123 m_nearest_unsent_d = 0;
124 m_last_center = center;
127 /*infostream<<"m_nearest_unsent_reset_timer="
128 <<m_nearest_unsent_reset_timer<<std::endl;*/
130 // Reset periodically to workaround for some bugs or stuff
131 if(m_nearest_unsent_reset_timer > 20.0)
133 m_nearest_unsent_reset_timer = 0;
134 m_nearest_unsent_d = 0;
135 //infostream<<"Resetting m_nearest_unsent_d for "
136 // <<server->getPlayerName(peer_id)<<std::endl;
139 //s16 last_nearest_unsent_d = m_nearest_unsent_d;
140 s16 d_start = m_nearest_unsent_d;
142 //infostream<<"d_start="<<d_start<<std::endl;
144 u16 max_simul_sends_setting = g_settings->getU16
145 ("max_simultaneous_block_sends_per_client");
146 u16 max_simul_sends_usually = max_simul_sends_setting;
149 Check the time from last addNode/removeNode.
151 Decrease send rate if player is building stuff.
153 m_time_from_building += dtime;
154 if(m_time_from_building < g_settings->getFloat(
155 "full_block_send_enable_min_time_from_building"))
157 max_simul_sends_usually
158 = LIMITED_MAX_SIMULTANEOUS_BLOCK_SENDS;
162 Number of blocks sending + number of blocks selected for sending
164 u32 num_blocks_selected = m_blocks_sending.size();
167 next time d will be continued from the d from which the nearest
168 unsent block was found this time.
170 This is because not necessarily any of the blocks found this
171 time are actually sent.
173 s32 new_nearest_unsent_d = -1;
175 // get view range and camera fov from the client
176 s16 wanted_range = sao->getWantedRange();
177 float camera_fov = sao->getFov();
178 // if FOV, wanted_range are not available (old client), fall back to old default
179 if (wanted_range <= 0) wanted_range = 1000;
180 if (camera_fov <= 0) camera_fov = (72.0*M_PI/180) * 4./3.;
182 const s16 full_d_max = MYMIN(g_settings->getS16("max_block_send_distance"), wanted_range);
183 const s16 d_opt = MYMIN(g_settings->getS16("block_send_optimize_distance"), wanted_range);
184 const s16 d_blocks_in_sight = full_d_max * BS * MAP_BLOCKSIZE;
185 //infostream << "Fov from client " << camera_fov << " full_d_max " << full_d_max << std::endl;
187 s16 d_max = full_d_max;
188 s16 d_max_gen = MYMIN(g_settings->getS16("max_block_generate_distance"), wanted_range);
190 // Don't loop very much at a time
191 s16 max_d_increment_at_time = 2;
192 if(d_max > d_start + max_d_increment_at_time)
193 d_max = d_start + max_d_increment_at_time;
195 s32 nearest_emerged_d = -1;
196 s32 nearest_emergefull_d = -1;
197 s32 nearest_sent_d = -1;
198 //bool queue_is_full = false;
200 const v3s16 cam_pos_nodes = floatToInt(camera_pos, BS);
201 const bool occ_cull = g_settings->getBool("server_side_occlusion_culling");
204 for(d = d_start; d <= d_max; d++) {
206 Get the border/face dot coordinates of a "d-radiused"
209 std::vector<v3s16> list = FacePositionCache::getFacePositions(d);
211 std::vector<v3s16>::iterator li;
212 for(li = list.begin(); li != list.end(); ++li) {
213 v3s16 p = *li + center;
217 - Don't allow too many simultaneous transfers
218 - EXCEPT when the blocks are very close
220 Also, don't send blocks that are already flying.
223 // Start with the usual maximum
224 u16 max_simul_dynamic = max_simul_sends_usually;
226 // If block is very close, allow full maximum
227 if(d <= BLOCK_SEND_DISABLE_LIMITS_MAX_D)
228 max_simul_dynamic = max_simul_sends_setting;
230 // Don't select too many blocks for sending
231 if (num_blocks_selected >= max_simul_dynamic) {
232 //queue_is_full = true;
233 goto queue_full_break;
236 // Don't send blocks that are currently being transferred
237 if (m_blocks_sending.find(p) != m_blocks_sending.end())
243 if (blockpos_over_limit(p))
246 // If this is true, inexistent block will be made from scratch
247 bool generate = d <= d_max_gen;
250 Don't generate or send if not in sight
251 FIXME This only works if the client uses a small enough
252 FOV setting. The default of 72 degrees is fine.
255 if(isBlockInSight(p, camera_pos, camera_dir, camera_fov, d_blocks_in_sight) == false)
261 Don't send already sent blocks
264 if(m_blocks_sent.find(p) != m_blocks_sent.end())
271 Check if map has this block
273 MapBlock *block = env->getMap().getBlockNoCreateNoEx(p);
275 bool surely_not_found_on_disk = false;
276 bool block_is_invalid = false;
279 // Reset usage timer, this block will be of use in the future.
280 block->resetUsageTimer();
282 // Block is dummy if data doesn't exist.
283 // It means it has been not found from disk and not generated
286 surely_not_found_on_disk = true;
289 if(block->isGenerated() == false)
290 block_is_invalid = true;
293 If block is not close, don't send it unless it is near
296 Block is near ground level if night-time mesh
297 differs from day-time mesh.
301 if(block->getDayNightDiff() == false)
305 if (occ_cull && !block_is_invalid &&
306 env->getMap().isBlockOccluded(block, cam_pos_nodes)) {
312 If block has been marked to not exist on disk (dummy)
313 and generating new ones is not wanted, skip block.
315 if(generate == false && surely_not_found_on_disk == true)
322 Add inexistent block to emerge queue.
324 if(block == NULL || surely_not_found_on_disk || block_is_invalid)
326 if (emerge->enqueueBlockEmerge(peer_id, p, generate)) {
327 if (nearest_emerged_d == -1)
328 nearest_emerged_d = d;
330 if (nearest_emergefull_d == -1)
331 nearest_emergefull_d = d;
332 goto queue_full_break;
339 if(nearest_sent_d == -1)
343 Add block to send queue
345 PrioritySortedBlockTransfer q((float)d, p, peer_id);
349 num_blocks_selected += 1;
354 // If nothing was found for sending and nothing was queued for
355 // emerging, continue next time browsing from here
356 if(nearest_emerged_d != -1){
357 new_nearest_unsent_d = nearest_emerged_d;
358 } else if(nearest_emergefull_d != -1){
359 new_nearest_unsent_d = nearest_emergefull_d;
362 new_nearest_unsent_d = 0;
363 m_nothing_to_send_pause_timer = 2.0;
365 if(nearest_sent_d != -1)
366 new_nearest_unsent_d = nearest_sent_d;
368 new_nearest_unsent_d = d;
372 if(new_nearest_unsent_d != -1)
373 m_nearest_unsent_d = new_nearest_unsent_d;
376 void RemoteClient::GotBlock(v3s16 p)
378 if (m_blocks_modified.find(p) == m_blocks_modified.end()) {
379 if (m_blocks_sending.find(p) != m_blocks_sending.end())
380 m_blocks_sending.erase(p);
382 m_excess_gotblocks++;
384 m_blocks_sent.insert(p);
388 void RemoteClient::SentBlock(v3s16 p)
390 if (m_blocks_modified.find(p) != m_blocks_modified.end())
391 m_blocks_modified.erase(p);
393 if(m_blocks_sending.find(p) == m_blocks_sending.end())
394 m_blocks_sending[p] = 0.0;
396 infostream<<"RemoteClient::SentBlock(): Sent block"
397 " already in m_blocks_sending"<<std::endl;
400 void RemoteClient::SetBlockNotSent(v3s16 p)
402 m_nearest_unsent_d = 0;
403 m_nothing_to_send_pause_timer = 0;
405 if(m_blocks_sending.find(p) != m_blocks_sending.end())
406 m_blocks_sending.erase(p);
407 if(m_blocks_sent.find(p) != m_blocks_sent.end())
408 m_blocks_sent.erase(p);
409 m_blocks_modified.insert(p);
412 void RemoteClient::SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks)
414 m_nearest_unsent_d = 0;
415 m_nothing_to_send_pause_timer = 0;
417 for(std::map<v3s16, MapBlock*>::iterator
419 i != blocks.end(); ++i)
422 m_blocks_modified.insert(p);
424 if(m_blocks_sending.find(p) != m_blocks_sending.end())
425 m_blocks_sending.erase(p);
426 if(m_blocks_sent.find(p) != m_blocks_sent.end())
427 m_blocks_sent.erase(p);
431 void RemoteClient::notifyEvent(ClientStateEvent event)
433 std::ostringstream myerror;
437 //intentionally do nothing
442 m_state = CS_HelloSent;
445 m_state = CS_AwaitingInit2;
448 m_state = CS_Disconnecting;
453 /* GotInit2 SetDefinitionsSent SetMediaSent */
455 myerror << "Created: Invalid client state transition! " << event;
456 throw ClientStateError(myerror.str());
460 /* don't do anything if in denied state */
466 m_state = CS_AwaitingInit2;
467 if ((chosen_mech == AUTH_MECHANISM_SRP)
468 || (chosen_mech == AUTH_MECHANISM_LEGACY_PASSWORD))
469 srp_verifier_delete((SRPVerifier *) auth_data);
470 chosen_mech = AUTH_MECHANISM_NONE;
473 m_state = CS_Disconnecting;
477 if ((chosen_mech == AUTH_MECHANISM_SRP)
478 || (chosen_mech == AUTH_MECHANISM_LEGACY_PASSWORD))
479 srp_verifier_delete((SRPVerifier *) auth_data);
480 chosen_mech = AUTH_MECHANISM_NONE;
483 myerror << "HelloSent: Invalid client state transition! " << event;
484 throw ClientStateError(myerror.str());
487 case CS_AwaitingInit2:
491 confirmSerializationVersion();
492 m_state = CS_InitDone;
495 m_state = CS_Disconnecting;
501 /* Init SetDefinitionsSent SetMediaSent */
503 myerror << "InitSent: Invalid client state transition! " << event;
504 throw ClientStateError(myerror.str());
511 case CSE_SetDefinitionsSent:
512 m_state = CS_DefinitionsSent;
515 m_state = CS_Disconnecting;
521 /* Init GotInit2 SetMediaSent */
523 myerror << "InitDone: Invalid client state transition! " << event;
524 throw ClientStateError(myerror.str());
527 case CS_DefinitionsSent:
530 case CSE_SetClientReady:
534 m_state = CS_Disconnecting;
539 /* Init GotInit2 SetDefinitionsSent */
541 myerror << "DefinitionsSent: Invalid client state transition! " << event;
542 throw ClientStateError(myerror.str());
552 m_state = CS_Disconnecting;
554 case CSE_SudoSuccess:
555 m_state = CS_SudoMode;
556 if ((chosen_mech == AUTH_MECHANISM_SRP)
557 || (chosen_mech == AUTH_MECHANISM_LEGACY_PASSWORD))
558 srp_verifier_delete((SRPVerifier *) auth_data);
559 chosen_mech = AUTH_MECHANISM_NONE;
561 /* Init GotInit2 SetDefinitionsSent SetMediaSent SetDenied */
563 myerror << "Active: Invalid client state transition! " << event;
564 throw ClientStateError(myerror.str());
575 m_state = CS_Disconnecting;
581 myerror << "Active: Invalid client state transition! " << event;
582 throw ClientStateError(myerror.str());
586 case CS_Disconnecting:
587 /* we are already disconnecting */
592 u32 RemoteClient::uptime()
594 return getTime(PRECISION_SECONDS) - m_connection_time;
597 ClientInterface::ClientInterface(con::Connection* con)
601 m_print_info_timer(0.0)
605 ClientInterface::~ClientInterface()
611 MutexAutoLock clientslock(m_clients_mutex);
613 for (UNORDERED_MAP<u16, RemoteClient*>::iterator i = m_clients.begin();
614 i != m_clients.end(); ++i) {
621 std::vector<u16> ClientInterface::getClientIDs(ClientState min_state)
623 std::vector<u16> reply;
624 MutexAutoLock clientslock(m_clients_mutex);
626 for(UNORDERED_MAP<u16, RemoteClient*>::iterator i = m_clients.begin();
627 i != m_clients.end(); ++i) {
628 if (i->second->getState() >= min_state)
629 reply.push_back(i->second->peer_id);
635 void ClientInterface::step(float dtime)
637 m_print_info_timer += dtime;
638 if(m_print_info_timer >= 30.0)
640 m_print_info_timer = 0.0;
645 void ClientInterface::UpdatePlayerList()
648 std::vector<u16> clients = getClientIDs();
649 m_clients_names.clear();
653 infostream<<"Players:"<<std::endl;
655 for (std::vector<u16>::iterator i = clients.begin(); i != clients.end(); ++i) {
656 RemotePlayer *player = m_env->getPlayer(*i);
661 infostream << "* " << player->getName() << "\t";
664 MutexAutoLock clientslock(m_clients_mutex);
665 RemoteClient* client = lockedGetClientNoEx(*i);
667 client->PrintInfo(infostream);
670 m_clients_names.push_back(player->getName());
675 void ClientInterface::send(u16 peer_id, u8 channelnum,
676 NetworkPacket* pkt, bool reliable)
678 m_con->Send(peer_id, channelnum, pkt, reliable);
681 void ClientInterface::sendToAll(u16 channelnum,
682 NetworkPacket* pkt, bool reliable)
684 MutexAutoLock clientslock(m_clients_mutex);
685 for(UNORDERED_MAP<u16, RemoteClient*>::iterator i = m_clients.begin();
686 i != m_clients.end(); ++i) {
687 RemoteClient *client = i->second;
689 if (client->net_proto_version != 0) {
690 m_con->Send(client->peer_id, channelnum, pkt, reliable);
695 RemoteClient* ClientInterface::getClientNoEx(u16 peer_id, ClientState state_min)
697 MutexAutoLock clientslock(m_clients_mutex);
698 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
699 // The client may not exist; clients are immediately removed if their
700 // access is denied, and this event occurs later then.
701 if (n == m_clients.end())
704 if (n->second->getState() >= state_min)
710 RemoteClient* ClientInterface::lockedGetClientNoEx(u16 peer_id, ClientState state_min)
712 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
713 // The client may not exist; clients are immediately removed if their
714 // access is denied, and this event occurs later then.
715 if (n == m_clients.end())
718 if (n->second->getState() >= state_min)
724 ClientState ClientInterface::getClientState(u16 peer_id)
726 MutexAutoLock clientslock(m_clients_mutex);
727 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
728 // The client may not exist; clients are immediately removed if their
729 // access is denied, and this event occurs later then.
730 if (n == m_clients.end())
733 return n->second->getState();
736 void ClientInterface::setPlayerName(u16 peer_id,std::string name)
738 MutexAutoLock clientslock(m_clients_mutex);
739 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
740 // The client may not exist; clients are immediately removed if their
741 // access is denied, and this event occurs later then.
742 if (n != m_clients.end())
743 n->second->setName(name);
746 void ClientInterface::DeleteClient(u16 peer_id)
748 MutexAutoLock conlock(m_clients_mutex);
751 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
752 // The client may not exist; clients are immediately removed if their
753 // access is denied, and this event occurs later then.
754 if (n == m_clients.end())
758 Mark objects to be not known by the client
760 //TODO this should be done by client destructor!!!
761 RemoteClient *client = n->second;
763 for(std::set<u16>::iterator
764 i = client->m_known_objects.begin();
765 i != client->m_known_objects.end(); ++i)
769 ServerActiveObject* obj = m_env->getActiveObject(id);
771 if(obj && obj->m_known_by_count > 0)
772 obj->m_known_by_count--;
776 delete m_clients[peer_id];
777 m_clients.erase(peer_id);
780 void ClientInterface::CreateClient(u16 peer_id)
782 MutexAutoLock conlock(m_clients_mutex);
785 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
786 // The client shouldn't already exist
787 if (n != m_clients.end()) return;
790 RemoteClient *client = new RemoteClient();
791 client->peer_id = peer_id;
792 m_clients[client->peer_id] = client;
795 void ClientInterface::event(u16 peer_id, ClientStateEvent event)
798 MutexAutoLock clientlock(m_clients_mutex);
801 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
803 // No client to deliver event
804 if (n == m_clients.end())
806 n->second->notifyEvent(event);
809 if ((event == CSE_SetClientReady) ||
810 (event == CSE_Disconnect) ||
811 (event == CSE_SetDenied))
817 u16 ClientInterface::getProtocolVersion(u16 peer_id)
819 MutexAutoLock conlock(m_clients_mutex);
822 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
824 // No client to get version
825 if (n == m_clients.end())
828 return n->second->net_proto_version;
831 void ClientInterface::setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full)
833 MutexAutoLock conlock(m_clients_mutex);
836 UNORDERED_MAP<u16, RemoteClient*>::iterator n = m_clients.find(peer_id);
838 // No client to set versions
839 if (n == m_clients.end())
842 n->second->setVersionInfo(major,minor,patch,full);