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 "util/mathconstants.h"
28 #include "network/connection.h"
29 #include "environment.h"
32 #include "serverobject.h" // TODO this is used for cleanup of only
36 const char *ClientInterface::statenames[] = {
51 std::string ClientInterface::state2Name(ClientState state)
53 return statenames[state];
56 void RemoteClient::ResendBlockIfOnWire(v3s16 p)
58 // if this block is on wire, mark it for sending again as soon as possible
59 if (m_blocks_sending.find(p) != m_blocks_sending.end()) {
64 void RemoteClient::GetNextBlocks (
65 ServerEnvironment *env,
66 EmergeManager * emerge,
68 std::vector<PrioritySortedBlockTransfer> &dest)
70 DSTACK(FUNCTION_NAME);
74 m_nothing_to_send_pause_timer -= dtime;
75 m_nearest_unsent_reset_timer += dtime;
77 if(m_nothing_to_send_pause_timer >= 0)
80 Player *player = env->getPlayer(peer_id);
81 // This can happen sometimes; clients and players are not in perfect sync.
85 // Won't send anything if already sending
86 if(m_blocks_sending.size() >= g_settings->getU16
87 ("max_simultaneous_block_sends_per_client"))
89 //infostream<<"Not sending any blocks, Queue full."<<std::endl;
93 v3f playerpos = player->getPosition();
94 v3f playerspeed = player->getSpeed();
95 v3f playerspeeddir(0,0,0);
96 if(playerspeed.getLength() > 1.0*BS)
97 playerspeeddir = playerspeed / playerspeed.getLength();
98 // Predict to next block
99 v3f playerpos_predicted = playerpos + playerspeeddir*MAP_BLOCKSIZE*BS;
101 v3s16 center_nodepos = floatToInt(playerpos_predicted, BS);
103 v3s16 center = getNodeBlockPos(center_nodepos);
105 // Camera position and direction
106 v3f camera_pos = player->getEyePosition();
107 v3f camera_dir = v3f(0,0,1);
108 camera_dir.rotateYZBy(player->getPitch());
109 camera_dir.rotateXZBy(player->getYaw());
111 /*infostream<<"camera_dir=("<<camera_dir.X<<","<<camera_dir.Y<<","
112 <<camera_dir.Z<<")"<<std::endl;*/
115 Get the starting value of the block finder radius.
118 if(m_last_center != center)
120 m_nearest_unsent_d = 0;
121 m_last_center = center;
124 /*infostream<<"m_nearest_unsent_reset_timer="
125 <<m_nearest_unsent_reset_timer<<std::endl;*/
127 // Reset periodically to workaround for some bugs or stuff
128 if(m_nearest_unsent_reset_timer > 20.0)
130 m_nearest_unsent_reset_timer = 0;
131 m_nearest_unsent_d = 0;
132 //infostream<<"Resetting m_nearest_unsent_d for "
133 // <<server->getPlayerName(peer_id)<<std::endl;
136 //s16 last_nearest_unsent_d = m_nearest_unsent_d;
137 s16 d_start = m_nearest_unsent_d;
139 //infostream<<"d_start="<<d_start<<std::endl;
141 u16 max_simul_sends_setting = g_settings->getU16
142 ("max_simultaneous_block_sends_per_client");
143 u16 max_simul_sends_usually = max_simul_sends_setting;
146 Check the time from last addNode/removeNode.
148 Decrease send rate if player is building stuff.
150 m_time_from_building += dtime;
151 if(m_time_from_building < g_settings->getFloat(
152 "full_block_send_enable_min_time_from_building"))
154 max_simul_sends_usually
155 = LIMITED_MAX_SIMULTANEOUS_BLOCK_SENDS;
159 Number of blocks sending + number of blocks selected for sending
161 u32 num_blocks_selected = m_blocks_sending.size();
164 next time d will be continued from the d from which the nearest
165 unsent block was found this time.
167 This is because not necessarily any of the blocks found this
168 time are actually sent.
170 s32 new_nearest_unsent_d = -1;
172 const s16 full_d_max = g_settings->getS16("max_block_send_distance");
173 s16 d_max = full_d_max;
174 s16 d_max_gen = g_settings->getS16("max_block_generate_distance");
176 // Don't loop very much at a time
177 s16 max_d_increment_at_time = 2;
178 if(d_max > d_start + max_d_increment_at_time)
179 d_max = d_start + max_d_increment_at_time;
181 s32 nearest_emerged_d = -1;
182 s32 nearest_emergefull_d = -1;
183 s32 nearest_sent_d = -1;
184 //bool queue_is_full = false;
187 for(d = d_start; d <= d_max; d++) {
189 Get the border/face dot coordinates of a "d-radiused"
192 std::vector<v3s16> list = FacePositionCache::getFacePositions(d);
194 std::vector<v3s16>::iterator li;
195 for(li = list.begin(); li != list.end(); ++li) {
196 v3s16 p = *li + center;
200 - Don't allow too many simultaneous transfers
201 - EXCEPT when the blocks are very close
203 Also, don't send blocks that are already flying.
206 // Start with the usual maximum
207 u16 max_simul_dynamic = max_simul_sends_usually;
209 // If block is very close, allow full maximum
210 if(d <= BLOCK_SEND_DISABLE_LIMITS_MAX_D)
211 max_simul_dynamic = max_simul_sends_setting;
213 // Don't select too many blocks for sending
214 if (num_blocks_selected >= max_simul_dynamic) {
215 //queue_is_full = true;
216 goto queue_full_break;
219 // Don't send blocks that are currently being transferred
220 if (m_blocks_sending.find(p) != m_blocks_sending.end())
226 if (blockpos_over_limit(p))
229 // If this is true, inexistent block will be made from scratch
230 bool generate = d <= d_max_gen;
233 /*// Limit the generating area vertically to 2/3
234 if(abs(p.Y - center.Y) > d_max_gen - d_max_gen / 3)
237 // Limit the send area vertically to 1/2
238 if (abs(p.Y - center.Y) > full_d_max / 2)
243 Don't generate or send if not in sight
244 FIXME This only works if the client uses a small enough
245 FOV setting. The default of 72 degrees is fine.
248 float camera_fov = (72.0*M_PI/180) * 4./3.;
249 if(isBlockInSight(p, camera_pos, camera_dir, camera_fov, 10000*BS) == false)
255 Don't send already sent blocks
258 if(m_blocks_sent.find(p) != m_blocks_sent.end())
265 Check if map has this block
267 MapBlock *block = env->getMap().getBlockNoCreateNoEx(p);
269 bool surely_not_found_on_disk = false;
270 bool block_is_invalid = false;
273 // Reset usage timer, this block will be of use in the future.
274 block->resetUsageTimer();
276 // Block is dummy if data doesn't exist.
277 // It means it has been not found from disk and not generated
280 surely_not_found_on_disk = true;
283 // Block is valid if lighting is up-to-date and data exists
284 if(block->isValid() == false)
286 block_is_invalid = 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)
307 If block has been marked to not exist on disk (dummy)
308 and generating new ones is not wanted, skip block.
310 if(generate == false && surely_not_found_on_disk == true)
317 Add inexistent block to emerge queue.
319 if(block == NULL || surely_not_found_on_disk || block_is_invalid)
321 if (emerge->enqueueBlockEmerge(peer_id, p, generate)) {
322 if (nearest_emerged_d == -1)
323 nearest_emerged_d = d;
325 if (nearest_emergefull_d == -1)
326 nearest_emergefull_d = d;
327 goto queue_full_break;
334 if(nearest_sent_d == -1)
338 Add block to send queue
340 PrioritySortedBlockTransfer q((float)d, p, peer_id);
344 num_blocks_selected += 1;
349 // If nothing was found for sending and nothing was queued for
350 // emerging, continue next time browsing from here
351 if(nearest_emerged_d != -1){
352 new_nearest_unsent_d = nearest_emerged_d;
353 } else if(nearest_emergefull_d != -1){
354 new_nearest_unsent_d = nearest_emergefull_d;
356 if(d > g_settings->getS16("max_block_send_distance")){
357 new_nearest_unsent_d = 0;
358 m_nothing_to_send_pause_timer = 2.0;
360 if(nearest_sent_d != -1)
361 new_nearest_unsent_d = nearest_sent_d;
363 new_nearest_unsent_d = d;
367 if(new_nearest_unsent_d != -1)
368 m_nearest_unsent_d = new_nearest_unsent_d;
371 void RemoteClient::GotBlock(v3s16 p)
373 if(m_blocks_sending.find(p) != m_blocks_sending.end())
374 m_blocks_sending.erase(p);
377 m_excess_gotblocks++;
379 m_blocks_sent.insert(p);
382 void RemoteClient::SentBlock(v3s16 p)
384 if(m_blocks_sending.find(p) == m_blocks_sending.end())
385 m_blocks_sending[p] = 0.0;
387 infostream<<"RemoteClient::SentBlock(): Sent block"
388 " already in m_blocks_sending"<<std::endl;
391 void RemoteClient::SetBlockNotSent(v3s16 p)
393 m_nearest_unsent_d = 0;
394 m_nothing_to_send_pause_timer = 0;
396 if(m_blocks_sending.find(p) != m_blocks_sending.end())
397 m_blocks_sending.erase(p);
398 if(m_blocks_sent.find(p) != m_blocks_sent.end())
399 m_blocks_sent.erase(p);
402 void RemoteClient::SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks)
404 m_nearest_unsent_d = 0;
405 m_nothing_to_send_pause_timer = 0;
407 for(std::map<v3s16, MapBlock*>::iterator
409 i != blocks.end(); ++i)
413 if(m_blocks_sending.find(p) != m_blocks_sending.end())
414 m_blocks_sending.erase(p);
415 if(m_blocks_sent.find(p) != m_blocks_sent.end())
416 m_blocks_sent.erase(p);
420 void RemoteClient::notifyEvent(ClientStateEvent event)
422 std::ostringstream myerror;
426 //intentionally do nothing
431 m_state = CS_HelloSent;
434 m_state = CS_AwaitingInit2;
437 m_state = CS_Disconnecting;
442 /* GotInit2 SetDefinitionsSent SetMediaSent */
444 myerror << "Created: Invalid client state transition! " << event;
445 throw ClientStateError(myerror.str());
449 /* don't do anything if in denied state */
455 m_state = CS_AwaitingInit2;
456 if ((chosen_mech == AUTH_MECHANISM_SRP)
457 || (chosen_mech == AUTH_MECHANISM_LEGACY_PASSWORD))
458 srp_verifier_delete((SRPVerifier *) auth_data);
459 chosen_mech = AUTH_MECHANISM_NONE;
462 m_state = CS_Disconnecting;
466 if ((chosen_mech == AUTH_MECHANISM_SRP)
467 || (chosen_mech == AUTH_MECHANISM_LEGACY_PASSWORD))
468 srp_verifier_delete((SRPVerifier *) auth_data);
469 chosen_mech = AUTH_MECHANISM_NONE;
472 myerror << "HelloSent: Invalid client state transition! " << event;
473 throw ClientStateError(myerror.str());
476 case CS_AwaitingInit2:
480 confirmSerializationVersion();
481 m_state = CS_InitDone;
484 m_state = CS_Disconnecting;
490 /* Init SetDefinitionsSent SetMediaSent */
492 myerror << "InitSent: Invalid client state transition! " << event;
493 throw ClientStateError(myerror.str());
500 case CSE_SetDefinitionsSent:
501 m_state = CS_DefinitionsSent;
504 m_state = CS_Disconnecting;
510 /* Init GotInit2 SetMediaSent */
512 myerror << "InitDone: Invalid client state transition! " << event;
513 throw ClientStateError(myerror.str());
516 case CS_DefinitionsSent:
519 case CSE_SetClientReady:
523 m_state = CS_Disconnecting;
528 /* Init GotInit2 SetDefinitionsSent */
530 myerror << "DefinitionsSent: Invalid client state transition! " << event;
531 throw ClientStateError(myerror.str());
541 m_state = CS_Disconnecting;
543 case CSE_SudoSuccess:
544 m_state = CS_SudoMode;
545 if ((chosen_mech == AUTH_MECHANISM_SRP)
546 || (chosen_mech == AUTH_MECHANISM_LEGACY_PASSWORD))
547 srp_verifier_delete((SRPVerifier *) auth_data);
548 chosen_mech = AUTH_MECHANISM_NONE;
550 /* Init GotInit2 SetDefinitionsSent SetMediaSent SetDenied */
552 myerror << "Active: Invalid client state transition! " << event;
553 throw ClientStateError(myerror.str());
564 m_state = CS_Disconnecting;
570 myerror << "Active: Invalid client state transition! " << event;
571 throw ClientStateError(myerror.str());
575 case CS_Disconnecting:
576 /* we are already disconnecting */
581 u32 RemoteClient::uptime()
583 return getTime(PRECISION_SECONDS) - m_connection_time;
586 ClientInterface::ClientInterface(con::Connection* con)
590 m_print_info_timer(0.0)
594 ClientInterface::~ClientInterface()
600 MutexAutoLock clientslock(m_clients_mutex);
602 for(std::map<u16, RemoteClient*>::iterator
603 i = m_clients.begin();
604 i != m_clients.end(); ++i)
613 std::vector<u16> ClientInterface::getClientIDs(ClientState min_state)
615 std::vector<u16> reply;
616 MutexAutoLock clientslock(m_clients_mutex);
618 for(std::map<u16, RemoteClient*>::iterator
619 i = m_clients.begin();
620 i != m_clients.end(); ++i)
622 if (i->second->getState() >= min_state)
623 reply.push_back(i->second->peer_id);
629 std::vector<std::string> ClientInterface::getPlayerNames()
631 return m_clients_names;
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()
649 std::vector<u16> clients = getClientIDs();
650 m_clients_names.clear();
654 infostream<<"Players:"<<std::endl;
656 for(std::vector<u16>::iterator
658 i != clients.end(); ++i) {
659 Player *player = m_env->getPlayer(*i);
664 infostream << "* " << player->getName() << "\t";
667 MutexAutoLock clientslock(m_clients_mutex);
668 RemoteClient* client = lockedGetClientNoEx(*i);
670 client->PrintInfo(infostream);
673 m_clients_names.push_back(player->getName());
678 void ClientInterface::send(u16 peer_id, u8 channelnum,
679 NetworkPacket* pkt, bool reliable)
681 m_con->Send(peer_id, channelnum, pkt, reliable);
684 void ClientInterface::sendToAll(u16 channelnum,
685 NetworkPacket* pkt, bool reliable)
687 MutexAutoLock clientslock(m_clients_mutex);
688 for(std::map<u16, RemoteClient*>::iterator
689 i = m_clients.begin();
690 i != m_clients.end(); ++i) {
691 RemoteClient *client = i->second;
693 if (client->net_proto_version != 0) {
694 m_con->Send(client->peer_id, channelnum, pkt, reliable);
699 RemoteClient* ClientInterface::getClientNoEx(u16 peer_id, ClientState state_min)
701 MutexAutoLock clientslock(m_clients_mutex);
702 std::map<u16, RemoteClient*>::iterator n;
703 n = m_clients.find(peer_id);
704 // The client may not exist; clients are immediately removed if their
705 // access is denied, and this event occurs later then.
706 if(n == m_clients.end())
709 if (n->second->getState() >= state_min)
715 RemoteClient* ClientInterface::lockedGetClientNoEx(u16 peer_id, ClientState state_min)
717 std::map<u16, RemoteClient*>::iterator n;
718 n = m_clients.find(peer_id);
719 // The client may not exist; clients are immediately removed if their
720 // access is denied, and this event occurs later then.
721 if(n == m_clients.end())
724 if (n->second->getState() >= state_min)
730 ClientState ClientInterface::getClientState(u16 peer_id)
732 MutexAutoLock clientslock(m_clients_mutex);
733 std::map<u16, RemoteClient*>::iterator n;
734 n = m_clients.find(peer_id);
735 // The client may not exist; clients are immediately removed if their
736 // access is denied, and this event occurs later then.
737 if(n == m_clients.end())
740 return n->second->getState();
743 void ClientInterface::setPlayerName(u16 peer_id,std::string name)
745 MutexAutoLock clientslock(m_clients_mutex);
746 std::map<u16, RemoteClient*>::iterator n;
747 n = m_clients.find(peer_id);
748 // The client may not exist; clients are immediately removed if their
749 // access is denied, and this event occurs later then.
750 if(n != m_clients.end())
751 n->second->setName(name);
754 void ClientInterface::DeleteClient(u16 peer_id)
756 MutexAutoLock conlock(m_clients_mutex);
759 std::map<u16, RemoteClient*>::iterator n;
760 n = m_clients.find(peer_id);
761 // The client may not exist; clients are immediately removed if their
762 // access is denied, and this event occurs later then.
763 if(n == m_clients.end())
767 Mark objects to be not known by the client
769 //TODO this should be done by client destructor!!!
770 RemoteClient *client = n->second;
772 for(std::set<u16>::iterator
773 i = client->m_known_objects.begin();
774 i != client->m_known_objects.end(); ++i)
778 ServerActiveObject* obj = m_env->getActiveObject(id);
780 if(obj && obj->m_known_by_count > 0)
781 obj->m_known_by_count--;
785 delete m_clients[peer_id];
786 m_clients.erase(peer_id);
789 void ClientInterface::CreateClient(u16 peer_id)
791 MutexAutoLock conlock(m_clients_mutex);
794 std::map<u16, RemoteClient*>::iterator n;
795 n = m_clients.find(peer_id);
796 // The client shouldn't already exist
797 if(n != m_clients.end()) return;
800 RemoteClient *client = new RemoteClient();
801 client->peer_id = peer_id;
802 m_clients[client->peer_id] = client;
805 void ClientInterface::event(u16 peer_id, ClientStateEvent event)
808 MutexAutoLock clientlock(m_clients_mutex);
811 std::map<u16, RemoteClient*>::iterator n;
812 n = m_clients.find(peer_id);
814 // No client to deliver event
815 if (n == m_clients.end())
817 n->second->notifyEvent(event);
820 if ((event == CSE_SetClientReady) ||
821 (event == CSE_Disconnect) ||
822 (event == CSE_SetDenied))
828 u16 ClientInterface::getProtocolVersion(u16 peer_id)
830 MutexAutoLock conlock(m_clients_mutex);
833 std::map<u16, RemoteClient*>::iterator n;
834 n = m_clients.find(peer_id);
836 // No client to get version
837 if (n == m_clients.end())
840 return n->second->net_proto_version;
843 void ClientInterface::setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full)
845 MutexAutoLock conlock(m_clients_mutex);
848 std::map<u16, RemoteClient*>::iterator n;
849 n = m_clients.find(peer_id);
851 // No client to set versions
852 if (n == m_clients.end())
855 n->second->setVersionInfo(major,minor,patch,full);