2
0

CVCMIServer.cpp 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124
  1. /*
  2. * CVCMIServer.cpp, part of VCMI engine
  3. *
  4. * Authors: listed in file AUTHORS in main folder
  5. *
  6. * License: GNU General Public License v2.0 or later
  7. * Full text of license available in license.txt file, in main folder
  8. *
  9. */
  10. #include "StdInc.h"
  11. #include "CVCMIServer.h"
  12. #include "CGameHandler.h"
  13. #include "GlobalLobbyProcessor.h"
  14. #include "LobbyNetPackVisitors.h"
  15. #include "processors/PlayerMessageProcessor.h"
  16. #include "../lib/CHeroHandler.h"
  17. #include "../lib/CPlayerState.h"
  18. #include "../lib/registerTypes/RegisterTypesLobbyPacks.h"
  19. #include "../lib/serializer/CMemorySerializer.h"
  20. #include "../lib/serializer/Connection.h"
  21. #include "../lib/texts/CGeneralTextHandler.h"
  22. // UUID generation
  23. #include <boost/uuid/uuid.hpp>
  24. #include <boost/uuid/uuid_io.hpp>
  25. #include <boost/uuid/uuid_generators.hpp>
  26. #include <boost/program_options.hpp>
  27. template<typename T> class CApplyOnServer;
  28. class CBaseForServerApply
  29. {
  30. public:
  31. virtual bool applyOnServerBefore(CVCMIServer * srv, CPack * pack) const =0;
  32. virtual void applyOnServerAfter(CVCMIServer * srv, CPack * pack) const =0;
  33. virtual ~CBaseForServerApply() {}
  34. template<typename U> static CBaseForServerApply * getApplier(const U * t = nullptr)
  35. {
  36. return new CApplyOnServer<U>();
  37. }
  38. };
  39. template <typename T> class CApplyOnServer : public CBaseForServerApply
  40. {
  41. public:
  42. bool applyOnServerBefore(CVCMIServer * srv, CPack * pack) const override
  43. {
  44. T * ptr = static_cast<T *>(pack);
  45. ClientPermissionsCheckerNetPackVisitor checker(*srv);
  46. ptr->visit(checker);
  47. if(checker.getResult())
  48. {
  49. ApplyOnServerNetPackVisitor applier(*srv);
  50. ptr->visit(applier);
  51. return applier.getResult();
  52. }
  53. else
  54. return false;
  55. }
  56. void applyOnServerAfter(CVCMIServer * srv, CPack * pack) const override
  57. {
  58. T * ptr = static_cast<T *>(pack);
  59. ApplyOnServerAfterAnnounceNetPackVisitor applier(*srv);
  60. ptr->visit(applier);
  61. }
  62. };
  63. template <>
  64. class CApplyOnServer<CPack> : public CBaseForServerApply
  65. {
  66. public:
  67. bool applyOnServerBefore(CVCMIServer * srv, CPack * pack) const override
  68. {
  69. logGlobal->error("Cannot apply plain CPack!");
  70. assert(0);
  71. return false;
  72. }
  73. void applyOnServerAfter(CVCMIServer * srv, CPack * pack) const override
  74. {
  75. logGlobal->error("Cannot apply plain CPack!");
  76. assert(0);
  77. }
  78. };
  79. class CVCMIServerPackVisitor : public VCMI_LIB_WRAP_NAMESPACE(ICPackVisitor)
  80. {
  81. private:
  82. CVCMIServer & handler;
  83. std::shared_ptr<CGameHandler> gh;
  84. public:
  85. CVCMIServerPackVisitor(CVCMIServer & handler, std::shared_ptr<CGameHandler> gh)
  86. :handler(handler), gh(gh)
  87. {
  88. }
  89. bool callTyped() override { return false; }
  90. void visitForLobby(CPackForLobby & packForLobby) override
  91. {
  92. handler.handleReceivedPack(std::unique_ptr<CPackForLobby>(&packForLobby));
  93. }
  94. void visitForServer(CPackForServer & serverPack) override
  95. {
  96. if (gh)
  97. gh->handleReceivedPack(&serverPack);
  98. else
  99. logNetwork->error("Received pack for game server while in lobby!");
  100. }
  101. void visitForClient(CPackForClient & clientPack) override
  102. {
  103. }
  104. };
  105. CVCMIServer::CVCMIServer(uint16_t port, bool runByClient)
  106. : currentClientId(1)
  107. , currentPlayerId(1)
  108. , port(port)
  109. , runByClient(runByClient)
  110. {
  111. uuid = boost::uuids::to_string(boost::uuids::random_generator()());
  112. logNetwork->trace("CVCMIServer created! UUID: %s", uuid);
  113. applier = std::make_shared<CApplier<CBaseForServerApply>>();
  114. registerTypesLobbyPacks(*applier);
  115. networkHandler = INetworkHandler::createHandler();
  116. }
  117. CVCMIServer::~CVCMIServer() = default;
  118. uint16_t CVCMIServer::prepare(bool connectToLobby) {
  119. if(connectToLobby) {
  120. lobbyProcessor = std::make_unique<GlobalLobbyProcessor>(*this);
  121. return 0;
  122. } else {
  123. return startAcceptingIncomingConnections();
  124. }
  125. }
  126. uint16_t CVCMIServer::startAcceptingIncomingConnections()
  127. {
  128. port
  129. ? logNetwork->info("Port %d will be used", port)
  130. : logNetwork->info("Randomly assigned port will be used");
  131. // config port may be 0 => srvport will contain the OS-assigned port value
  132. networkServer = networkHandler->createServerTCP(*this);
  133. auto srvport = networkServer->start(port);
  134. logNetwork->info("Listening for connections at port %d", srvport);
  135. return srvport;
  136. }
  137. void CVCMIServer::onNewConnection(const std::shared_ptr<INetworkConnection> & connection)
  138. {
  139. if(getState() == EServerState::LOBBY)
  140. {
  141. activeConnections.push_back(std::make_shared<CConnection>(connection));
  142. activeConnections.back()->enterLobbyConnectionMode();
  143. }
  144. else
  145. {
  146. // TODO: reconnection support
  147. connection->close();
  148. }
  149. }
  150. void CVCMIServer::onPacketReceived(const std::shared_ptr<INetworkConnection> & connection, const std::vector<std::byte> & message)
  151. {
  152. std::shared_ptr<CConnection> c = findConnection(connection);
  153. if (c == nullptr)
  154. throw std::out_of_range("Unknown connection received in CVCMIServer::findConnection");
  155. auto pack = c->retrievePack(message);
  156. pack->c = c;
  157. CVCMIServerPackVisitor visitor(*this, this->gh);
  158. pack->visit(visitor);
  159. }
  160. void CVCMIServer::setState(EServerState value)
  161. {
  162. if (value == EServerState::SHUTDOWN && state == EServerState::SHUTDOWN)
  163. logGlobal->warn("Attempt to shutdown already shutdown server!");
  164. // do not attempt to restart dying server
  165. assert(state != EServerState::SHUTDOWN || state == value);
  166. state = value;
  167. if (state == EServerState::SHUTDOWN)
  168. networkHandler->stop();
  169. }
  170. EServerState CVCMIServer::getState() const
  171. {
  172. return state;
  173. }
  174. std::shared_ptr<CConnection> CVCMIServer::findConnection(const std::shared_ptr<INetworkConnection> & netConnection)
  175. {
  176. for(const auto & gameConnection : activeConnections)
  177. {
  178. if (gameConnection->isMyConnection(netConnection))
  179. return gameConnection;
  180. }
  181. return nullptr;
  182. }
  183. bool CVCMIServer::wasStartedByClient() const
  184. {
  185. return runByClient;
  186. }
  187. void CVCMIServer::run()
  188. {
  189. networkHandler->run();
  190. }
  191. void CVCMIServer::onTimer()
  192. {
  193. // we might receive onTimer call after transitioning from GAMEPLAY to LOBBY state, e.g. on game restart
  194. if (getState() != EServerState::GAMEPLAY)
  195. return;
  196. static const auto serverUpdateInterval = std::chrono::milliseconds(100);
  197. auto timeNow = std::chrono::steady_clock::now();
  198. auto timePassedBefore = lastTimerUpdateTime - gameplayStartTime;
  199. auto timePassedNow = timeNow - gameplayStartTime;
  200. lastTimerUpdateTime = timeNow;
  201. auto msPassedBefore = std::chrono::duration_cast<std::chrono::milliseconds>(timePassedBefore);
  202. auto msPassedNow = std::chrono::duration_cast<std::chrono::milliseconds>(timePassedNow);
  203. auto msDelta = msPassedNow - msPassedBefore;
  204. if (msDelta.count())
  205. gh->tick(msDelta.count());
  206. networkHandler->createTimer(*this, serverUpdateInterval);
  207. }
  208. void CVCMIServer::prepareToRestart()
  209. {
  210. if(getState() != EServerState::GAMEPLAY)
  211. {
  212. assert(0);
  213. return;
  214. }
  215. * si = * gh->gs->initialOpts;
  216. setState(EServerState::LOBBY);
  217. if (si->campState)
  218. {
  219. assert(si->campState->currentScenario().has_value());
  220. campaignMap = si->campState->currentScenario().value_or(CampaignScenarioID(0));
  221. campaignBonus = si->campState->getBonusID(campaignMap).value_or(-1);
  222. }
  223. for(auto activeConnection : activeConnections)
  224. activeConnection->enterLobbyConnectionMode();
  225. gh = nullptr;
  226. }
  227. bool CVCMIServer::prepareToStartGame()
  228. {
  229. Load::ProgressAccumulator progressTracking;
  230. Load::Progress current(1);
  231. progressTracking.include(current);
  232. if (lobbyProcessor)
  233. lobbyProcessor->sendGameStarted();
  234. auto progressTrackingThread = boost::thread([this, &progressTracking]()
  235. {
  236. auto currentProgress = std::numeric_limits<Load::Type>::max();
  237. while(!progressTracking.finished())
  238. {
  239. if(progressTracking.get() != currentProgress)
  240. {
  241. //FIXME: UNGUARDED MULTITHREADED ACCESS!!!
  242. currentProgress = progressTracking.get();
  243. std::unique_ptr<LobbyLoadProgress> loadProgress(new LobbyLoadProgress);
  244. loadProgress->progress = currentProgress;
  245. announcePack(std::move(loadProgress));
  246. }
  247. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  248. }
  249. });
  250. gh = std::make_shared<CGameHandler>(this);
  251. switch(si->mode)
  252. {
  253. case EStartMode::CAMPAIGN:
  254. logNetwork->info("Preparing to start new campaign");
  255. si->startTimeIso8601 = vstd::getDateTimeISO8601Basic(std::time(nullptr));
  256. si->fileURI = mi->fileURI;
  257. si->campState->setCurrentMap(campaignMap);
  258. si->campState->setCurrentMapBonus(campaignBonus);
  259. gh->init(si.get(), progressTracking);
  260. break;
  261. case EStartMode::NEW_GAME:
  262. logNetwork->info("Preparing to start new game");
  263. si->startTimeIso8601 = vstd::getDateTimeISO8601Basic(std::time(nullptr));
  264. si->fileURI = mi->fileURI;
  265. gh->init(si.get(), progressTracking);
  266. break;
  267. case EStartMode::LOAD_GAME:
  268. logNetwork->info("Preparing to start loaded game");
  269. if(!gh->load(si->mapname))
  270. {
  271. current.finish();
  272. progressTrackingThread.join();
  273. return false;
  274. }
  275. break;
  276. default:
  277. logNetwork->error("Wrong mode in StartInfo!");
  278. assert(0);
  279. break;
  280. }
  281. current.finish();
  282. progressTrackingThread.join();
  283. return true;
  284. }
  285. void CVCMIServer::startGameImmediately()
  286. {
  287. for(auto activeConnection : activeConnections)
  288. activeConnection->enterGameplayConnectionMode(gh->gs);
  289. gh->start(si->mode == EStartMode::LOAD_GAME);
  290. setState(EServerState::GAMEPLAY);
  291. lastTimerUpdateTime = gameplayStartTime = std::chrono::steady_clock::now();
  292. onTimer();
  293. multiplayerWelcomeMessage();
  294. }
  295. void CVCMIServer::onDisconnected(const std::shared_ptr<INetworkConnection> & connection, const std::string & errorMessage)
  296. {
  297. logNetwork->error("Network error receiving a pack. Connection has been closed");
  298. std::shared_ptr<CConnection> c = findConnection(connection);
  299. if (!c)
  300. return; // player have already disconnected via clientDisconnected call
  301. vstd::erase(activeConnections, c);
  302. if(activeConnections.empty() || hostClientId == c->connectionID)
  303. {
  304. setState(EServerState::SHUTDOWN);
  305. return;
  306. }
  307. if(gh && getState() == EServerState::GAMEPLAY)
  308. {
  309. gh->handleClientDisconnection(c);
  310. auto lcd = std::make_unique<LobbyClientDisconnected>();
  311. lcd->c = c;
  312. lcd->clientId = c->connectionID;
  313. handleReceivedPack(std::move(lcd));
  314. }
  315. }
  316. void CVCMIServer::handleReceivedPack(std::unique_ptr<CPackForLobby> pack)
  317. {
  318. CBaseForServerApply * apply = applier->getApplier(CTypeList::getInstance().getTypeID(pack.get()));
  319. if(apply->applyOnServerBefore(this, pack.get()))
  320. announcePack(std::move(pack));
  321. }
  322. void CVCMIServer::announcePack(std::unique_ptr<CPackForLobby> pack)
  323. {
  324. for(auto activeConnection : activeConnections)
  325. {
  326. // FIXME: we need to avoid sending something to client that not yet get answer for LobbyClientConnected
  327. // Until UUID set we only pass LobbyClientConnected to this client
  328. //if(c->uuid == uuid && !dynamic_cast<LobbyClientConnected *>(pack.get()))
  329. // continue;
  330. activeConnection->sendPack(pack.get());
  331. }
  332. applier->getApplier(CTypeList::getInstance().getTypeID(pack.get()))->applyOnServerAfter(this, pack.get());
  333. }
  334. void CVCMIServer::announceMessage(const MetaString & txt)
  335. {
  336. logNetwork->info("Show message: %s", txt.toString());
  337. auto cm = std::make_unique<LobbyShowMessage>();
  338. cm->message = txt;
  339. announcePack(std::move(cm));
  340. }
  341. void CVCMIServer::announceMessage(const std::string & txt)
  342. {
  343. MetaString str;
  344. str.appendRawString(txt);
  345. announceMessage(str);
  346. }
  347. void CVCMIServer::announceTxt(const MetaString & txt, const std::string & playerName)
  348. {
  349. logNetwork->info("%s says: %s", playerName, txt.toString());
  350. auto cm = std::make_unique<LobbyChatMessage>();
  351. cm->playerName = playerName;
  352. cm->message = txt;
  353. announcePack(std::move(cm));
  354. }
  355. void CVCMIServer::announceTxt(const std::string & txt, const std::string & playerName)
  356. {
  357. MetaString str;
  358. str.appendRawString(txt);
  359. announceTxt(str, playerName);
  360. }
  361. bool CVCMIServer::passHost(int toConnectionId)
  362. {
  363. for(auto activeConnection : activeConnections)
  364. {
  365. if(isClientHost(activeConnection->connectionID))
  366. continue;
  367. if(activeConnection->connectionID != toConnectionId)
  368. continue;
  369. hostClientId = activeConnection->connectionID;
  370. announceTxt(boost::str(boost::format("Pass host to connection %d") % toConnectionId));
  371. return true;
  372. }
  373. return false;
  374. }
  375. void CVCMIServer::clientConnected(std::shared_ptr<CConnection> c, std::vector<std::string> & names, const std::string & uuid, EStartMode mode)
  376. {
  377. assert(getState() == EServerState::LOBBY);
  378. c->connectionID = currentClientId++;
  379. if(hostClientId == -1)
  380. {
  381. hostClientId = c->connectionID;
  382. si->mode = mode;
  383. }
  384. logNetwork->info("Connection with client %d established. UUID: %s", c->connectionID, c->uuid);
  385. for(auto & name : names)
  386. {
  387. logNetwork->info("Client %d player: %s", c->connectionID, name);
  388. ui8 id = currentPlayerId++;
  389. ClientPlayer cp;
  390. cp.connection = c->connectionID;
  391. cp.name = name;
  392. playerNames.insert(std::make_pair(id, cp));
  393. announceTxt(boost::str(boost::format("%s (pid %d cid %d) joins the game") % name % id % c->connectionID));
  394. //put new player in first slot with AI
  395. for(auto & elem : si->playerInfos)
  396. {
  397. if(elem.second.isControlledByAI() && !elem.second.compOnly)
  398. {
  399. setPlayerConnectedId(elem.second, id);
  400. break;
  401. }
  402. }
  403. }
  404. }
  405. void CVCMIServer::clientDisconnected(std::shared_ptr<CConnection> connection)
  406. {
  407. connection->getConnection()->close();
  408. vstd::erase(activeConnections, connection);
  409. // PlayerReinitInterface startAiPack;
  410. // startAiPack.playerConnectionId = PlayerSettings::PLAYER_AI;
  411. //
  412. // for(auto it = playerNames.begin(); it != playerNames.end();)
  413. // {
  414. // if(it->second.connection != c->connectionID)
  415. // {
  416. // ++it;
  417. // continue;
  418. // }
  419. //
  420. // int id = it->first;
  421. // std::string playerLeftMsgText = boost::str(boost::format("%s (pid %d cid %d) left the game") % id % playerNames[id].name % c->connectionID);
  422. // announceTxt(playerLeftMsgText); //send lobby text, it will be ignored for non-lobby clients
  423. // auto * playerSettings = si->getPlayersSettings(id);
  424. // if(!playerSettings)
  425. // {
  426. // ++it;
  427. // continue;
  428. // }
  429. //
  430. // it = playerNames.erase(it);
  431. // setPlayerConnectedId(*playerSettings, PlayerSettings::PLAYER_AI);
  432. //
  433. // if(gh && si && state == EServerState::GAMEPLAY)
  434. // {
  435. // gh->playerMessages->broadcastMessage(playerSettings->color, playerLeftMsgText);
  436. // // gh->connections[playerSettings->color].insert(hostClient);
  437. // startAiPack.players.push_back(playerSettings->color);
  438. // }
  439. // }
  440. //
  441. // if(!startAiPack.players.empty())
  442. // gh->sendAndApply(&startAiPack);
  443. }
  444. void CVCMIServer::reconnectPlayer(int connId)
  445. {
  446. PlayerReinitInterface startAiPack;
  447. startAiPack.playerConnectionId = connId;
  448. if(gh && si && getState() == EServerState::GAMEPLAY)
  449. {
  450. for(auto it = playerNames.begin(); it != playerNames.end(); ++it)
  451. {
  452. if(it->second.connection != connId)
  453. continue;
  454. int id = it->first;
  455. auto * playerSettings = si->getPlayersSettings(id);
  456. if(!playerSettings)
  457. continue;
  458. std::string messageText = boost::str(boost::format("%s (cid %d) is connected") % playerSettings->name % connId);
  459. gh->playerMessages->broadcastMessage(playerSettings->color, messageText);
  460. startAiPack.players.push_back(playerSettings->color);
  461. }
  462. if(!startAiPack.players.empty())
  463. gh->sendAndApply(&startAiPack);
  464. }
  465. }
  466. void CVCMIServer::setPlayerConnectedId(PlayerSettings & pset, ui8 player) const
  467. {
  468. if(vstd::contains(playerNames, player))
  469. pset.name = playerNames.find(player)->second.name;
  470. else
  471. pset.name = VLC->generaltexth->allTexts[468]; //Computer
  472. pset.connectedPlayerIDs.clear();
  473. if(player != PlayerSettings::PLAYER_AI)
  474. pset.connectedPlayerIDs.insert(player);
  475. }
  476. void CVCMIServer::updateStartInfoOnMapChange(std::shared_ptr<CMapInfo> mapInfo, std::shared_ptr<CMapGenOptions> mapGenOpts)
  477. {
  478. mi = mapInfo;
  479. if(!mi)
  480. return;
  481. auto namesIt = playerNames.cbegin();
  482. si->playerInfos.clear();
  483. if(mi->scenarioOptionsOfSave)
  484. {
  485. si = CMemorySerializer::deepCopy(*mi->scenarioOptionsOfSave);
  486. si->mode = EStartMode::LOAD_GAME;
  487. if(si->campState)
  488. campaignMap = si->campState->currentScenario().value();
  489. for(auto & ps : si->playerInfos)
  490. {
  491. if(!ps.second.compOnly && ps.second.connectedPlayerIDs.size() && namesIt != playerNames.cend())
  492. {
  493. setPlayerConnectedId(ps.second, namesIt++->first);
  494. }
  495. else
  496. {
  497. setPlayerConnectedId(ps.second, PlayerSettings::PLAYER_AI);
  498. }
  499. }
  500. }
  501. else if(si->mode == EStartMode::NEW_GAME || si->mode == EStartMode::CAMPAIGN)
  502. {
  503. if(mi->campaign)
  504. return;
  505. for(int i = 0; i < mi->mapHeader->players.size(); i++)
  506. {
  507. const PlayerInfo & pinfo = mi->mapHeader->players[i];
  508. //neither computer nor human can play - no player
  509. if(!(pinfo.canHumanPlay || pinfo.canComputerPlay))
  510. continue;
  511. PlayerSettings & pset = si->playerInfos[PlayerColor(i)];
  512. pset.color = PlayerColor(i);
  513. if(pinfo.canHumanPlay && namesIt != playerNames.cend())
  514. {
  515. setPlayerConnectedId(pset, namesIt++->first);
  516. }
  517. else
  518. {
  519. setPlayerConnectedId(pset, PlayerSettings::PLAYER_AI);
  520. if(!pinfo.canHumanPlay)
  521. {
  522. pset.compOnly = true;
  523. }
  524. }
  525. pset.castle = pinfo.defaultCastle();
  526. pset.hero = pinfo.defaultHero();
  527. if(pset.hero != HeroTypeID::RANDOM && pinfo.hasCustomMainHero())
  528. {
  529. pset.hero = pinfo.mainCustomHeroId;
  530. pset.heroNameTextId = pinfo.mainCustomHeroNameTextId;
  531. pset.heroPortrait = pinfo.mainCustomHeroPortrait;
  532. }
  533. }
  534. if(mi->isRandomMap && mapGenOpts)
  535. si->mapGenOptions = std::shared_ptr<CMapGenOptions>(mapGenOpts);
  536. else
  537. si->mapGenOptions.reset();
  538. }
  539. if (lobbyProcessor)
  540. {
  541. std::string roomDescription;
  542. if (si->mapGenOptions)
  543. {
  544. if (si->mapGenOptions->getMapTemplate())
  545. roomDescription = si->mapGenOptions->getMapTemplate()->getName();
  546. // else - no template selected.
  547. // TODO: handle this somehow?
  548. }
  549. else
  550. roomDescription = mi->getNameTranslated();
  551. lobbyProcessor->sendChangeRoomDescription(roomDescription);
  552. }
  553. si->mapname = mi->fileURI;
  554. }
  555. void CVCMIServer::updateAndPropagateLobbyState()
  556. {
  557. // Update player settings for RMG
  558. // TODO: find appropriate location for this code
  559. if(si->mapGenOptions && si->mode == EStartMode::NEW_GAME)
  560. {
  561. for(const auto & psetPair : si->playerInfos)
  562. {
  563. const auto & pset = psetPair.second;
  564. si->mapGenOptions->setStartingTownForPlayer(pset.color, pset.castle);
  565. si->mapGenOptions->setStartingHeroForPlayer(pset.color, pset.hero);
  566. if(pset.isControlledByHuman())
  567. {
  568. si->mapGenOptions->setPlayerTypeForStandardPlayer(pset.color, EPlayerType::HUMAN);
  569. }
  570. else
  571. {
  572. si->mapGenOptions->setPlayerTypeForStandardPlayer(pset.color, EPlayerType::AI);
  573. }
  574. }
  575. }
  576. auto lus = std::make_unique<LobbyUpdateState>();
  577. lus->state = *this;
  578. announcePack(std::move(lus));
  579. }
  580. void CVCMIServer::setPlayer(PlayerColor clickedColor)
  581. {
  582. struct PlayerToRestore
  583. {
  584. PlayerColor color;
  585. int id;
  586. void reset() { id = -1; color = PlayerColor::CANNOT_DETERMINE; }
  587. PlayerToRestore(){ reset(); }
  588. } playerToRestore;
  589. PlayerSettings & clicked = si->playerInfos[clickedColor];
  590. //identify clicked player
  591. int clickedNameID = 0; //number of player - zero means AI, assume it initially
  592. if(clicked.isControlledByHuman())
  593. clickedNameID = *(clicked.connectedPlayerIDs.begin()); //if not AI - set appropriate ID
  594. if(clickedNameID > 0 && playerToRestore.id == clickedNameID) //player to restore is about to being replaced -> put him back to the old place
  595. {
  596. PlayerSettings & restPos = si->playerInfos[playerToRestore.color];
  597. setPlayerConnectedId(restPos, playerToRestore.id);
  598. playerToRestore.reset();
  599. }
  600. int newPlayer; //which player will take clicked position
  601. //who will be put here?
  602. if(!clickedNameID) //AI player clicked -> if possible replace computer with unallocated player
  603. {
  604. newPlayer = getIdOfFirstUnallocatedPlayer();
  605. if(!newPlayer) //no "free" player -> get just first one
  606. newPlayer = playerNames.begin()->first;
  607. }
  608. else //human clicked -> take next
  609. {
  610. auto i = playerNames.find(clickedNameID); //clicked one
  611. i++; //player AFTER clicked one
  612. if(i != playerNames.end())
  613. newPlayer = i->first;
  614. else
  615. newPlayer = 0; //AI if we scrolled through all players
  616. }
  617. setPlayerConnectedId(clicked, newPlayer); //put player
  618. //if that player was somewhere else, we need to replace him with computer
  619. if(newPlayer) //not AI
  620. {
  621. for(auto i = si->playerInfos.begin(); i != si->playerInfos.end(); i++)
  622. {
  623. int curNameID = *(i->second.connectedPlayerIDs.begin());
  624. if(i->first != clickedColor && curNameID == newPlayer)
  625. {
  626. assert(i->second.connectedPlayerIDs.size());
  627. playerToRestore.color = i->first;
  628. playerToRestore.id = newPlayer;
  629. setPlayerConnectedId(i->second, PlayerSettings::PLAYER_AI); //set computer
  630. break;
  631. }
  632. }
  633. }
  634. }
  635. void CVCMIServer::setPlayerName(PlayerColor color, std::string name)
  636. {
  637. if(color == PlayerColor::CANNOT_DETERMINE)
  638. return;
  639. PlayerSettings & player = si->playerInfos.at(color);
  640. if(!player.isControlledByHuman())
  641. return;
  642. if(player.connectedPlayerIDs.empty())
  643. return;
  644. int nameID = *(player.connectedPlayerIDs.begin()); //if not AI - set appropriate ID
  645. playerNames[nameID].name = name;
  646. setPlayerConnectedId(player, nameID);
  647. }
  648. void CVCMIServer::setPlayerHandicap(PlayerColor color, Handicap handicap)
  649. {
  650. if(color == PlayerColor::CANNOT_DETERMINE)
  651. return;
  652. si->playerInfos[color].handicap = handicap;
  653. int humanPlayer = 0;
  654. for (const auto & pi : si->playerInfos)
  655. if(pi.second.isControlledByHuman())
  656. humanPlayer++;
  657. if(humanPlayer < 2) // Singleplayer
  658. return;
  659. MetaString str;
  660. str.appendTextID("vcmi.lobby.handicap");
  661. str.appendRawString(" ");
  662. str.appendName(color);
  663. str.appendRawString(":");
  664. if(handicap.startBonus.empty() && handicap.percentIncome == 100 && handicap.percentGrowth == 100)
  665. {
  666. str.appendRawString(" ");
  667. str.appendTextID("core.genrltxt.523");
  668. announceTxt(str);
  669. return;
  670. }
  671. for(auto & res : EGameResID::ALL_RESOURCES())
  672. if(handicap.startBonus[res] != 0)
  673. {
  674. str.appendRawString(" ");
  675. str.appendName(res);
  676. str.appendRawString(":");
  677. str.appendRawString(std::to_string(handicap.startBonus[res]));
  678. }
  679. if(handicap.percentIncome != 100)
  680. {
  681. str.appendRawString(" ");
  682. str.appendTextID("core.jktext.32");
  683. str.appendRawString(":");
  684. str.appendRawString(std::to_string(handicap.percentIncome) + "%");
  685. }
  686. if(handicap.percentGrowth != 100)
  687. {
  688. str.appendRawString(" ");
  689. str.appendTextID("core.genrltxt.194");
  690. str.appendRawString(":");
  691. str.appendRawString(std::to_string(handicap.percentGrowth) + "%");
  692. }
  693. announceTxt(str);
  694. }
  695. void CVCMIServer::optionNextCastle(PlayerColor player, int dir)
  696. {
  697. PlayerSettings & s = si->playerInfos[player];
  698. FactionID & cur = s.castle;
  699. auto & allowed = getPlayerInfo(player).allowedFactions;
  700. const bool allowRandomTown = getPlayerInfo(player).isFactionRandom;
  701. if(cur == FactionID::NONE) //no change
  702. return;
  703. if(cur == FactionID::RANDOM) //first/last available
  704. {
  705. if(dir > 0)
  706. cur = *allowed.begin(); //id of first town
  707. else
  708. cur = *allowed.rbegin(); //id of last town
  709. }
  710. else // next/previous available
  711. {
  712. if((cur == *allowed.begin() && dir < 0) || (cur == *allowed.rbegin() && dir > 0))
  713. {
  714. if(allowRandomTown)
  715. {
  716. cur = FactionID::RANDOM;
  717. }
  718. else
  719. {
  720. if(dir > 0)
  721. cur = *allowed.begin();
  722. else
  723. cur = *allowed.rbegin();
  724. }
  725. }
  726. else
  727. {
  728. assert(dir >= -1 && dir <= 1); //othervice std::advance may go out of range
  729. auto iter = allowed.find(cur);
  730. std::advance(iter, dir);
  731. cur = *iter;
  732. }
  733. }
  734. if(s.hero.isValid() && !getPlayerInfo(player).hasCustomMainHero()) // remove hero unless it set to fixed one in map editor
  735. {
  736. s.hero = HeroTypeID::RANDOM;
  737. }
  738. if(!cur.isValid() && s.bonus == PlayerStartingBonus::RESOURCE)
  739. s.bonus = PlayerStartingBonus::RANDOM;
  740. }
  741. void CVCMIServer::optionSetCastle(PlayerColor player, FactionID id)
  742. {
  743. PlayerSettings & s = si->playerInfos[player];
  744. FactionID & cur = s.castle;
  745. auto & allowed = getPlayerInfo(player).allowedFactions;
  746. if(cur == FactionID::NONE) //no change
  747. return;
  748. if(allowed.find(id) == allowed.end() && id != FactionID::RANDOM) // valid id
  749. return;
  750. cur = static_cast<FactionID>(id);
  751. if(s.hero.isValid() && !getPlayerInfo(player).hasCustomMainHero()) // remove hero unless it set to fixed one in map editor
  752. {
  753. s.hero = HeroTypeID::RANDOM;
  754. }
  755. if(!cur.isValid() && s.bonus == PlayerStartingBonus::RESOURCE)
  756. s.bonus = PlayerStartingBonus::RANDOM;
  757. }
  758. void CVCMIServer::setCampaignMap(CampaignScenarioID mapId)
  759. {
  760. campaignMap = mapId;
  761. si->difficulty = si->campState->scenario(mapId).difficulty;
  762. campaignBonus = -1;
  763. updateStartInfoOnMapChange(si->campState->getMapInfo(mapId));
  764. }
  765. void CVCMIServer::setCampaignBonus(int bonusId)
  766. {
  767. campaignBonus = bonusId;
  768. const CampaignScenario & scenario = si->campState->scenario(campaignMap);
  769. const std::vector<CampaignBonus> & bonDescs = scenario.travelOptions.bonusesToChoose;
  770. if(bonDescs[bonusId].type == CampaignBonusType::HERO)
  771. {
  772. for(auto & elem : si->playerInfos)
  773. {
  774. if(elem.first == PlayerColor(bonDescs[bonusId].info1))
  775. setPlayerConnectedId(elem.second, 1);
  776. else
  777. setPlayerConnectedId(elem.second, PlayerSettings::PLAYER_AI);
  778. }
  779. }
  780. }
  781. void CVCMIServer::optionNextHero(PlayerColor player, int dir)
  782. {
  783. PlayerSettings & s = si->playerInfos[player];
  784. if(!s.castle.isValid() || s.hero == HeroTypeID::NONE)
  785. return;
  786. if(s.hero == HeroTypeID::RANDOM) // first/last available
  787. {
  788. if (dir > 0)
  789. s.hero = nextAllowedHero(player, HeroTypeID(-1), dir);
  790. else
  791. s.hero = nextAllowedHero(player, HeroTypeID(VLC->heroh->size()), dir);
  792. }
  793. else
  794. {
  795. s.hero = nextAllowedHero(player, s.hero, dir);
  796. }
  797. }
  798. void CVCMIServer::optionSetHero(PlayerColor player, HeroTypeID id)
  799. {
  800. PlayerSettings & s = si->playerInfos[player];
  801. if(!s.castle.isValid() || s.hero == HeroTypeID::NONE)
  802. return;
  803. if(id == HeroTypeID::RANDOM)
  804. {
  805. s.hero = HeroTypeID::RANDOM;
  806. }
  807. if(canUseThisHero(player, id))
  808. s.hero = static_cast<HeroTypeID>(id);
  809. }
  810. HeroTypeID CVCMIServer::nextAllowedHero(PlayerColor player, HeroTypeID initial, int direction)
  811. {
  812. HeroTypeID first(initial.getNum() + direction);
  813. if(direction > 0)
  814. {
  815. for (auto i = first; i.getNum() < VLC->heroh->size(); ++i)
  816. if(canUseThisHero(player, i))
  817. return i;
  818. }
  819. else
  820. {
  821. for (auto i = first; i.getNum() >= 0; --i)
  822. if(canUseThisHero(player, i))
  823. return i;
  824. }
  825. return HeroTypeID::RANDOM;
  826. }
  827. void CVCMIServer::optionNextBonus(PlayerColor player, int dir)
  828. {
  829. PlayerSettings & s = si->playerInfos[player];
  830. PlayerStartingBonus & ret = s.bonus = static_cast<PlayerStartingBonus>(static_cast<int>(s.bonus) + dir);
  831. if(s.hero == HeroTypeID::NONE &&
  832. !getPlayerInfo(player).heroesNames.size() &&
  833. ret == PlayerStartingBonus::ARTIFACT) //no hero - can't be artifact
  834. {
  835. if(dir < 0)
  836. ret = PlayerStartingBonus::RANDOM;
  837. else
  838. ret = PlayerStartingBonus::GOLD;
  839. }
  840. if(ret > PlayerStartingBonus::RESOURCE)
  841. ret = PlayerStartingBonus::RANDOM;
  842. if(ret < PlayerStartingBonus::RANDOM)
  843. ret = PlayerStartingBonus::RESOURCE;
  844. if(s.castle == FactionID::RANDOM && ret == PlayerStartingBonus::RESOURCE) //random castle - can't be resource
  845. {
  846. if(dir < 0)
  847. ret = PlayerStartingBonus::GOLD;
  848. else
  849. ret = PlayerStartingBonus::RANDOM;
  850. }
  851. }
  852. void CVCMIServer::optionSetBonus(PlayerColor player, PlayerStartingBonus id)
  853. {
  854. PlayerSettings & s = si->playerInfos[player];
  855. if(s.hero == HeroTypeID::NONE &&
  856. !getPlayerInfo(player).heroesNames.size() &&
  857. id == PlayerStartingBonus::ARTIFACT) //no hero - can't be artifact
  858. return;
  859. if(id > PlayerStartingBonus::RESOURCE)
  860. return;
  861. if(id < PlayerStartingBonus::RANDOM)
  862. return;
  863. if(s.castle == FactionID::RANDOM && id == PlayerStartingBonus::RESOURCE) //random castle - can't be resource
  864. return;
  865. s.bonus = id;
  866. }
  867. bool CVCMIServer::canUseThisHero(PlayerColor player, HeroTypeID ID)
  868. {
  869. return VLC->heroh->size() > ID
  870. && si->playerInfos[player].castle == VLC->heroh->objects[ID]->heroClass->faction
  871. && !vstd::contains(getUsedHeroes(), ID)
  872. && mi->mapHeader->allowedHeroes.count(ID);
  873. }
  874. std::vector<HeroTypeID> CVCMIServer::getUsedHeroes()
  875. {
  876. std::vector<HeroTypeID> heroIds;
  877. for(auto & p : si->playerInfos)
  878. {
  879. const auto & heroes = getPlayerInfo(p.first).heroesNames;
  880. for(auto & hero : heroes)
  881. if(hero.heroId >= 0) //in VCMI map format heroId = -1 means random hero
  882. heroIds.push_back(hero.heroId);
  883. if(p.second.hero != HeroTypeID::RANDOM)
  884. heroIds.push_back(p.second.hero);
  885. }
  886. return heroIds;
  887. }
  888. ui8 CVCMIServer::getIdOfFirstUnallocatedPlayer() const
  889. {
  890. for(auto i = playerNames.cbegin(); i != playerNames.cend(); i++)
  891. {
  892. if(!si->getPlayersSettings(i->first))
  893. return i->first;
  894. }
  895. return 0;
  896. }
  897. void CVCMIServer::multiplayerWelcomeMessage()
  898. {
  899. int humanPlayer = 0;
  900. for (const auto & pi : si->playerInfos)
  901. if(pi.second.isControlledByHuman())
  902. humanPlayer++;
  903. if(humanPlayer < 2) // Singleplayer
  904. return;
  905. gh->playerMessages->broadcastSystemMessage("Use '!help' to list available commands");
  906. for (const auto & pi : si->playerInfos)
  907. if(!pi.second.handicap.startBonus.empty() || pi.second.handicap.percentIncome != 100 || pi.second.handicap.percentGrowth != 100)
  908. {
  909. MetaString str;
  910. str.appendTextID("vcmi.lobby.handicap");
  911. str.appendRawString(" ");
  912. str.appendName(pi.first);
  913. str.appendRawString(":");
  914. for(auto & res : EGameResID::ALL_RESOURCES())
  915. if(pi.second.handicap.startBonus[res] != 0)
  916. {
  917. str.appendRawString(" ");
  918. str.appendName(res);
  919. str.appendRawString(":");
  920. str.appendRawString(std::to_string(pi.second.handicap.startBonus[res]));
  921. }
  922. if(pi.second.handicap.percentIncome != 100)
  923. {
  924. str.appendRawString(" ");
  925. str.appendTextID("core.jktext.32");
  926. str.appendRawString(":");
  927. str.appendRawString(std::to_string(pi.second.handicap.percentIncome) + "%");
  928. }
  929. if(pi.second.handicap.percentGrowth != 100)
  930. {
  931. str.appendRawString(" ");
  932. str.appendTextID("core.genrltxt.194");
  933. str.appendRawString(":");
  934. str.appendRawString(std::to_string(pi.second.handicap.percentGrowth) + "%");
  935. }
  936. gh->playerMessages->broadcastSystemMessage(str);
  937. }
  938. std::vector<std::string> optionIds;
  939. if(si->extraOptionsInfo.cheatsAllowed)
  940. optionIds.emplace_back("vcmi.optionsTab.cheatAllowed.hover");
  941. if(si->extraOptionsInfo.unlimitedReplay)
  942. optionIds.emplace_back("vcmi.optionsTab.unlimitedReplay.hover");
  943. if(!optionIds.size()) // No settings to publish
  944. return;
  945. MetaString str;
  946. str.appendTextID("vcmi.optionsTab.extraOptions.hover");
  947. str.appendRawString(": ");
  948. for(int i = 0; i < optionIds.size(); i++)
  949. {
  950. str.appendTextID(optionIds[i]);
  951. if(i < optionIds.size() - 1)
  952. str.appendRawString(", ");
  953. }
  954. gh->playerMessages->broadcastSystemMessage(str);
  955. }
  956. INetworkHandler & CVCMIServer::getNetworkHandler()
  957. {
  958. return *networkHandler;
  959. }