CVCMIServer.cpp 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253
  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 <boost/asio.hpp>
  12. #include "../lib/filesystem/Filesystem.h"
  13. #include "../lib/campaign/CampaignState.h"
  14. #include "../lib/CThreadHelper.h"
  15. #include "../lib/serializer/Connection.h"
  16. #include "../lib/CArtHandler.h"
  17. #include "../lib/CGeneralTextHandler.h"
  18. #include "../lib/CHeroHandler.h"
  19. #include "../lib/CTownHandler.h"
  20. #include "../lib/CBuildingHandler.h"
  21. #include "../lib/spells/CSpellHandler.h"
  22. #include "../lib/CCreatureHandler.h"
  23. #include "zlib.h"
  24. #include "CVCMIServer.h"
  25. #include "../lib/StartInfo.h"
  26. #include "../lib/mapping/CMapHeader.h"
  27. #include "../lib/rmg/CMapGenOptions.h"
  28. #include "LobbyNetPackVisitors.h"
  29. #ifdef VCMI_ANDROID
  30. #include <jni.h>
  31. #include <android/log.h>
  32. #include "lib/CAndroidVMHelper.h"
  33. #endif
  34. #include "../lib/VCMI_Lib.h"
  35. #include "../lib/VCMIDirs.h"
  36. #include "CGameHandler.h"
  37. #include "processors/PlayerMessageProcessor.h"
  38. #include "../lib/mapping/CMapInfo.h"
  39. #include "../lib/GameConstants.h"
  40. #include "../lib/logging/CBasicLogConfigurator.h"
  41. #include "../lib/CConfigHandler.h"
  42. #include "../lib/ScopeGuard.h"
  43. #include "../lib/serializer/CMemorySerializer.h"
  44. #include "../lib/serializer/Cast.h"
  45. #include "../lib/UnlockGuard.h"
  46. // for applier
  47. #include "../lib/registerTypes/RegisterTypesLobbyPacks.h"
  48. // UUID generation
  49. #include <boost/uuid/uuid.hpp>
  50. #include <boost/uuid/uuid_io.hpp>
  51. #include <boost/uuid/uuid_generators.hpp>
  52. #include "../lib/gameState/CGameState.h"
  53. template<typename T> class CApplyOnServer;
  54. class CBaseForServerApply
  55. {
  56. public:
  57. virtual bool applyOnServerBefore(CVCMIServer * srv, void * pack) const =0;
  58. virtual void applyOnServerAfter(CVCMIServer * srv, void * pack) const =0;
  59. virtual ~CBaseForServerApply() {}
  60. template<typename U> static CBaseForServerApply * getApplier(const U * t = nullptr)
  61. {
  62. return new CApplyOnServer<U>();
  63. }
  64. };
  65. template <typename T> class CApplyOnServer : public CBaseForServerApply
  66. {
  67. public:
  68. bool applyOnServerBefore(CVCMIServer * srv, void * pack) const override
  69. {
  70. T * ptr = static_cast<T *>(pack);
  71. ClientPermissionsCheckerNetPackVisitor checker(*srv);
  72. ptr->visit(checker);
  73. if(checker.getResult())
  74. {
  75. boost::unique_lock<boost::mutex> stateLock(srv->stateMutex);
  76. ApplyOnServerNetPackVisitor applier(*srv);
  77. ptr->visit(applier);
  78. return applier.getResult();
  79. }
  80. else
  81. return false;
  82. }
  83. void applyOnServerAfter(CVCMIServer * srv, void * pack) const override
  84. {
  85. T * ptr = static_cast<T *>(pack);
  86. ApplyOnServerAfterAnnounceNetPackVisitor applier(*srv);
  87. ptr->visit(applier);
  88. }
  89. };
  90. template <>
  91. class CApplyOnServer<CPack> : public CBaseForServerApply
  92. {
  93. public:
  94. bool applyOnServerBefore(CVCMIServer * srv, void * pack) const override
  95. {
  96. logGlobal->error("Cannot apply plain CPack!");
  97. assert(0);
  98. return false;
  99. }
  100. void applyOnServerAfter(CVCMIServer * srv, void * pack) const override
  101. {
  102. logGlobal->error("Cannot apply plain CPack!");
  103. assert(0);
  104. }
  105. };
  106. std::string SERVER_NAME_AFFIX = "server";
  107. std::string SERVER_NAME = GameConstants::VCMI_VERSION + std::string(" (") + SERVER_NAME_AFFIX + ')';
  108. CVCMIServer::CVCMIServer(boost::program_options::variables_map & opts)
  109. : port(3030), io(std::make_shared<boost::asio::io_service>()), state(EServerState::LOBBY), cmdLineOptions(opts), currentClientId(1), currentPlayerId(1), restartGameplay(false)
  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. if(cmdLineOptions.count("port"))
  116. port = cmdLineOptions["port"].as<ui16>();
  117. logNetwork->info("Port %d will be used", port);
  118. try
  119. {
  120. acceptor = std::make_shared<TAcceptor>(*io, boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), port));
  121. }
  122. catch(...)
  123. {
  124. logNetwork->info("Port %d is busy, trying to use random port instead", port);
  125. if(cmdLineOptions.count("run-by-client"))
  126. {
  127. logNetwork->error("Port must be specified when run-by-client is used!!");
  128. exit(0);
  129. }
  130. acceptor = std::make_shared<TAcceptor>(*io, boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), 0));
  131. port = acceptor->local_endpoint().port();
  132. }
  133. logNetwork->info("Listening for connections at port %d", port);
  134. }
  135. CVCMIServer::~CVCMIServer()
  136. {
  137. announceQueue.clear();
  138. if(announceLobbyThread)
  139. announceLobbyThread->join();
  140. }
  141. void CVCMIServer::setState(EServerState value)
  142. {
  143. state.store(value);
  144. }
  145. EServerState CVCMIServer::getState() const
  146. {
  147. return state.load();
  148. }
  149. void CVCMIServer::run()
  150. {
  151. if(!restartGameplay)
  152. {
  153. this->announceLobbyThread = std::make_unique<boost::thread>(&CVCMIServer::threadAnnounceLobby, this);
  154. startAsyncAccept();
  155. if(!remoteConnectionsThread && cmdLineOptions.count("lobby"))
  156. {
  157. remoteConnectionsThread = std::make_unique<boost::thread>(&CVCMIServer::establishRemoteConnections, this);
  158. }
  159. #if defined(VCMI_ANDROID)
  160. #ifndef SINGLE_PROCESS_APP
  161. CAndroidVMHelper vmHelper;
  162. vmHelper.callStaticVoidMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "onServerReady");
  163. #endif
  164. #endif
  165. }
  166. while(state == EServerState::LOBBY || state == EServerState::GAMEPLAY_STARTING)
  167. boost::this_thread::sleep_for(boost::chrono::milliseconds(50));
  168. logNetwork->info("Thread handling connections ended");
  169. if(state == EServerState::GAMEPLAY)
  170. {
  171. gh->run(si->mode == StartInfo::LOAD_GAME);
  172. }
  173. while(state == EServerState::GAMEPLAY_ENDED)
  174. boost::this_thread::sleep_for(boost::chrono::milliseconds(50));
  175. }
  176. void CVCMIServer::establishRemoteConnections()
  177. {
  178. setThreadName("establishConnection");
  179. //wait for host connection
  180. while(connections.empty())
  181. boost::this_thread::sleep_for(boost::chrono::milliseconds(50));
  182. uuid = cmdLineOptions["lobby-uuid"].as<std::string>();
  183. int numOfConnections = cmdLineOptions["connections"].as<ui16>();
  184. for(int i = 0; i < numOfConnections; ++i)
  185. connectToRemote();
  186. }
  187. void CVCMIServer::connectToRemote()
  188. {
  189. std::shared_ptr<CConnection> c;
  190. try
  191. {
  192. auto address = cmdLineOptions["lobby"].as<std::string>();
  193. int port = cmdLineOptions["lobby-port"].as<ui16>();
  194. logNetwork->info("Establishing connection to remote at %s:%d with uuid %s", address, port, uuid);
  195. c = std::make_shared<CConnection>(address, port, SERVER_NAME, uuid);
  196. }
  197. catch(...)
  198. {
  199. logNetwork->error("\nCannot establish remote connection!");
  200. }
  201. if(c)
  202. {
  203. connections.insert(c);
  204. remoteConnections.insert(c);
  205. c->handler = std::make_shared<boost::thread>(&CVCMIServer::threadHandleClient, this, c);
  206. }
  207. }
  208. void CVCMIServer::threadAnnounceLobby()
  209. {
  210. setThreadName("announceLobby");
  211. while(state != EServerState::SHUTDOWN)
  212. {
  213. {
  214. boost::unique_lock<boost::recursive_mutex> myLock(mx);
  215. while(!announceQueue.empty())
  216. {
  217. announcePack(std::move(announceQueue.front()));
  218. announceQueue.pop_front();
  219. }
  220. if(acceptor)
  221. {
  222. io->reset();
  223. io->poll();
  224. }
  225. }
  226. boost::this_thread::sleep_for(boost::chrono::milliseconds(50));
  227. }
  228. }
  229. void CVCMIServer::prepareToRestart()
  230. {
  231. if(state == EServerState::GAMEPLAY)
  232. {
  233. restartGameplay = true;
  234. * si = * gh->gs->initialOpts;
  235. si->seedToBeUsed = si->seedPostInit = 0;
  236. state = EServerState::LOBBY;
  237. if (si->campState)
  238. {
  239. assert(si->campState->currentScenario().has_value());
  240. campaignMap = si->campState->currentScenario().value_or(CampaignScenarioID(0));
  241. campaignBonus = si->campState->getBonusID(campaignMap).value_or(-1);
  242. }
  243. // FIXME: dirry hack to make sure old CGameHandler::run is finished
  244. boost::this_thread::sleep_for(boost::chrono::milliseconds(1000));
  245. }
  246. for(auto c : connections)
  247. {
  248. c->enterLobbyConnectionMode();
  249. c->disableStackSendingByID();
  250. }
  251. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  252. gh = nullptr;
  253. }
  254. bool CVCMIServer::prepareToStartGame()
  255. {
  256. Load::ProgressAccumulator progressTracking;
  257. Load::Progress current(1);
  258. progressTracking.include(current);
  259. Load::Type currentProgress = std::numeric_limits<Load::Type>::max();
  260. auto progressTrackingThread = boost::thread([this, &progressTracking, &currentProgress]()
  261. {
  262. while(!progressTracking.finished())
  263. {
  264. if(progressTracking.get() != currentProgress)
  265. {
  266. currentProgress = progressTracking.get();
  267. std::unique_ptr<LobbyLoadProgress> loadProgress(new LobbyLoadProgress);
  268. loadProgress->progress = currentProgress;
  269. addToAnnounceQueue(std::move(loadProgress));
  270. }
  271. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  272. }
  273. });
  274. gh = std::make_shared<CGameHandler>(this);
  275. switch(si->mode)
  276. {
  277. case StartInfo::CAMPAIGN:
  278. logNetwork->info("Preparing to start new campaign");
  279. si->startTimeIso8601 = vstd::getDateTimeISO8601Basic(std::time(nullptr));
  280. si->fileURI = mi->fileURI;
  281. si->campState->setCurrentMap(campaignMap);
  282. si->campState->setCurrentMapBonus(campaignBonus);
  283. gh->init(si.get(), progressTracking);
  284. break;
  285. case StartInfo::NEW_GAME:
  286. logNetwork->info("Preparing to start new game");
  287. si->startTimeIso8601 = vstd::getDateTimeISO8601Basic(std::time(nullptr));
  288. si->fileURI = mi->fileURI;
  289. gh->init(si.get(), progressTracking);
  290. break;
  291. case StartInfo::LOAD_GAME:
  292. logNetwork->info("Preparing to start loaded game");
  293. if(!gh->load(si->mapname))
  294. {
  295. current.finish();
  296. progressTrackingThread.join();
  297. return false;
  298. }
  299. break;
  300. default:
  301. logNetwork->error("Wrong mode in StartInfo!");
  302. assert(0);
  303. break;
  304. }
  305. current.finish();
  306. progressTrackingThread.join();
  307. return true;
  308. }
  309. void CVCMIServer::startGameImmidiately()
  310. {
  311. for(auto c : connections)
  312. c->enterGameplayConnectionMode(gh->gs);
  313. state = EServerState::GAMEPLAY;
  314. }
  315. void CVCMIServer::startAsyncAccept()
  316. {
  317. assert(!upcomingConnection);
  318. assert(acceptor);
  319. #if BOOST_VERSION >= 107000 // Boost version >= 1.70
  320. upcomingConnection = std::make_shared<TSocket>(acceptor->get_executor());
  321. #else
  322. upcomingConnection = std::make_shared<TSocket>(acceptor->get_io_service());
  323. #endif
  324. acceptor->async_accept(*upcomingConnection, std::bind(&CVCMIServer::connectionAccepted, this, _1));
  325. }
  326. void CVCMIServer::connectionAccepted(const boost::system::error_code & ec)
  327. {
  328. if(ec)
  329. {
  330. if(state != EServerState::SHUTDOWN)
  331. logNetwork->info("Something wrong during accepting: %s", ec.message());
  332. return;
  333. }
  334. try
  335. {
  336. if(state == EServerState::LOBBY || !hangingConnections.empty())
  337. {
  338. logNetwork->info("We got a new connection! :)");
  339. auto c = std::make_shared<CConnection>(upcomingConnection, SERVER_NAME, uuid);
  340. upcomingConnection.reset();
  341. connections.insert(c);
  342. c->handler = std::make_shared<boost::thread>(&CVCMIServer::threadHandleClient, this, c);
  343. }
  344. }
  345. catch(std::exception & e)
  346. {
  347. logNetwork->error("Failure processing new connection! %s", e.what());
  348. upcomingConnection.reset();
  349. }
  350. startAsyncAccept();
  351. }
  352. class CVCMIServerPackVisitor : public VCMI_LIB_WRAP_NAMESPACE(ICPackVisitor)
  353. {
  354. private:
  355. CVCMIServer & handler;
  356. std::shared_ptr<CGameHandler> gh;
  357. public:
  358. CVCMIServerPackVisitor(CVCMIServer & handler, std::shared_ptr<CGameHandler> gh)
  359. :handler(handler), gh(gh)
  360. {
  361. }
  362. virtual bool callTyped() override { return false; }
  363. virtual void visitForLobby(CPackForLobby & packForLobby) override
  364. {
  365. handler.handleReceivedPack(std::unique_ptr<CPackForLobby>(&packForLobby));
  366. }
  367. virtual void visitForServer(CPackForServer & serverPack) override
  368. {
  369. if (gh)
  370. gh->handleReceivedPack(&serverPack);
  371. else
  372. logNetwork->error("Received pack for game server while in lobby!");
  373. }
  374. virtual void visitForClient(CPackForClient & clientPack) override
  375. {
  376. }
  377. };
  378. void CVCMIServer::threadHandleClient(std::shared_ptr<CConnection> c)
  379. {
  380. setThreadName("handleClient");
  381. c->enterLobbyConnectionMode();
  382. while(c->connected)
  383. {
  384. CPack * pack;
  385. try
  386. {
  387. pack = c->retrievePack();
  388. pack->c = c;
  389. }
  390. catch(boost::system::system_error & e)
  391. {
  392. if (e.code() == boost::asio::error::eof)
  393. logNetwork->error("Network error receiving a pack. Connection has been closed");
  394. else
  395. logNetwork->error("Network error receiving a pack. Connection %s dies. What happened: %s", c->toString(), e.what());
  396. hangingConnections.insert(c);
  397. connections.erase(c);
  398. if(connections.empty() || hostClient == c)
  399. state = EServerState::SHUTDOWN;
  400. if(gh && state == EServerState::GAMEPLAY)
  401. {
  402. gh->handleClientDisconnection(c);
  403. }
  404. break;
  405. }
  406. CVCMIServerPackVisitor visitor(*this, this->gh);
  407. pack->visit(visitor);
  408. }
  409. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  410. if(c->connected)
  411. {
  412. auto lcd = std::make_unique<LobbyClientDisconnected>();
  413. lcd->c = c;
  414. lcd->clientId = c->connectionID;
  415. handleReceivedPack(std::move(lcd));
  416. }
  417. logNetwork->info("Thread listening for %s ended", c->toString());
  418. c->handler.reset();
  419. }
  420. void CVCMIServer::handleReceivedPack(std::unique_ptr<CPackForLobby> pack)
  421. {
  422. CBaseForServerApply * apply = applier->getApplier(CTypeList::getInstance().getTypeID(pack.get()));
  423. if(apply->applyOnServerBefore(this, pack.get()))
  424. addToAnnounceQueue(std::move(pack));
  425. }
  426. void CVCMIServer::announcePack(std::unique_ptr<CPackForLobby> pack)
  427. {
  428. for(auto c : connections)
  429. {
  430. // FIXME: we need to avoid sending something to client that not yet get answer for LobbyClientConnected
  431. // Until UUID set we only pass LobbyClientConnected to this client
  432. if(c->uuid == uuid && !dynamic_cast<LobbyClientConnected *>(pack.get()))
  433. continue;
  434. c->sendPack(pack.get());
  435. }
  436. applier->getApplier(CTypeList::getInstance().getTypeID(pack.get()))->applyOnServerAfter(this, pack.get());
  437. }
  438. void CVCMIServer::announceMessage(const std::string & txt)
  439. {
  440. logNetwork->info("Show message: %s", txt);
  441. auto cm = std::make_unique<LobbyShowMessage>();
  442. cm->message = txt;
  443. addToAnnounceQueue(std::move(cm));
  444. }
  445. void CVCMIServer::announceTxt(const std::string & txt, const std::string & playerName)
  446. {
  447. logNetwork->info("%s says: %s", playerName, txt);
  448. auto cm = std::make_unique<LobbyChatMessage>();
  449. cm->playerName = playerName;
  450. cm->message = txt;
  451. addToAnnounceQueue(std::move(cm));
  452. }
  453. void CVCMIServer::addToAnnounceQueue(std::unique_ptr<CPackForLobby> pack)
  454. {
  455. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  456. announceQueue.push_back(std::move(pack));
  457. }
  458. bool CVCMIServer::passHost(int toConnectionId)
  459. {
  460. for(auto c : connections)
  461. {
  462. if(isClientHost(c->connectionID))
  463. continue;
  464. if(c->connectionID != toConnectionId)
  465. continue;
  466. hostClient = c;
  467. hostClientId = c->connectionID;
  468. announceTxt(boost::str(boost::format("Pass host to connection %d") % toConnectionId));
  469. return true;
  470. }
  471. return false;
  472. }
  473. void CVCMIServer::clientConnected(std::shared_ptr<CConnection> c, std::vector<std::string> & names, std::string uuid, StartInfo::EMode mode)
  474. {
  475. if(state == EServerState::LOBBY)
  476. c->connectionID = currentClientId++;
  477. if(!hostClient)
  478. {
  479. hostClient = c;
  480. hostClientId = c->connectionID;
  481. si->mode = mode;
  482. }
  483. logNetwork->info("Connection with client %d established. UUID: %s", c->connectionID, c->uuid);
  484. if(state == EServerState::LOBBY)
  485. {
  486. for(auto & name : names)
  487. {
  488. logNetwork->info("Client %d player: %s", c->connectionID, name);
  489. ui8 id = currentPlayerId++;
  490. ClientPlayer cp;
  491. cp.connection = c->connectionID;
  492. cp.name = name;
  493. playerNames.insert(std::make_pair(id, cp));
  494. announceTxt(boost::str(boost::format("%s (pid %d cid %d) joins the game") % name % id % c->connectionID));
  495. //put new player in first slot with AI
  496. for(auto & elem : si->playerInfos)
  497. {
  498. if(elem.second.isControlledByAI() && !elem.second.compOnly)
  499. {
  500. setPlayerConnectedId(elem.second, id);
  501. break;
  502. }
  503. }
  504. }
  505. }
  506. }
  507. void CVCMIServer::clientDisconnected(std::shared_ptr<CConnection> c)
  508. {
  509. connections -= c;
  510. if(connections.empty() || hostClient == c)
  511. {
  512. state = EServerState::SHUTDOWN;
  513. return;
  514. }
  515. PlayerReinitInterface startAiPack;
  516. startAiPack.playerConnectionId = PlayerSettings::PLAYER_AI;
  517. for(auto it = playerNames.begin(); it != playerNames.end();)
  518. {
  519. if(it->second.connection != c->connectionID)
  520. {
  521. ++it;
  522. continue;
  523. }
  524. int id = it->first;
  525. std::string playerLeftMsgText = boost::str(boost::format("%s (pid %d cid %d) left the game") % id % playerNames[id].name % c->connectionID);
  526. announceTxt(playerLeftMsgText); //send lobby text, it will be ignored for non-lobby clients
  527. auto * playerSettings = si->getPlayersSettings(id);
  528. if(!playerSettings)
  529. {
  530. ++it;
  531. continue;
  532. }
  533. it = playerNames.erase(it);
  534. setPlayerConnectedId(*playerSettings, PlayerSettings::PLAYER_AI);
  535. if(gh && si && state == EServerState::GAMEPLAY)
  536. {
  537. gh->playerMessages->broadcastMessage(playerSettings->color, playerLeftMsgText);
  538. gh->connections[playerSettings->color].insert(hostClient);
  539. startAiPack.players.push_back(playerSettings->color);
  540. }
  541. }
  542. if(!startAiPack.players.empty())
  543. gh->sendAndApply(&startAiPack);
  544. }
  545. void CVCMIServer::reconnectPlayer(int connId)
  546. {
  547. PlayerReinitInterface startAiPack;
  548. startAiPack.playerConnectionId = connId;
  549. if(gh && si && state == EServerState::GAMEPLAY)
  550. {
  551. for(auto it = playerNames.begin(); it != playerNames.end(); ++it)
  552. {
  553. if(it->second.connection != connId)
  554. continue;
  555. int id = it->first;
  556. auto * playerSettings = si->getPlayersSettings(id);
  557. if(!playerSettings)
  558. continue;
  559. std::string messageText = boost::str(boost::format("%s (cid %d) is connected") % playerSettings->name % connId);
  560. gh->playerMessages->broadcastMessage(playerSettings->color, messageText);
  561. startAiPack.players.push_back(playerSettings->color);
  562. }
  563. if(!startAiPack.players.empty())
  564. gh->sendAndApply(&startAiPack);
  565. }
  566. }
  567. void CVCMIServer::setPlayerConnectedId(PlayerSettings & pset, ui8 player) const
  568. {
  569. if(vstd::contains(playerNames, player))
  570. pset.name = playerNames.find(player)->second.name;
  571. else
  572. pset.name = VLC->generaltexth->allTexts[468]; //Computer
  573. pset.connectedPlayerIDs.clear();
  574. if(player != PlayerSettings::PLAYER_AI)
  575. pset.connectedPlayerIDs.insert(player);
  576. }
  577. void CVCMIServer::updateStartInfoOnMapChange(std::shared_ptr<CMapInfo> mapInfo, std::shared_ptr<CMapGenOptions> mapGenOpts)
  578. {
  579. mi = mapInfo;
  580. if(!mi)
  581. return;
  582. auto namesIt = playerNames.cbegin();
  583. si->playerInfos.clear();
  584. if(mi->scenarioOptionsOfSave)
  585. {
  586. si = CMemorySerializer::deepCopy(*mi->scenarioOptionsOfSave);
  587. si->mode = StartInfo::LOAD_GAME;
  588. if(si->campState)
  589. campaignMap = si->campState->currentScenario().value();
  590. for(auto & ps : si->playerInfos)
  591. {
  592. if(!ps.second.compOnly && ps.second.connectedPlayerIDs.size() && namesIt != playerNames.cend())
  593. {
  594. setPlayerConnectedId(ps.second, namesIt++->first);
  595. }
  596. else
  597. {
  598. setPlayerConnectedId(ps.second, PlayerSettings::PLAYER_AI);
  599. }
  600. }
  601. }
  602. else if(si->mode == StartInfo::NEW_GAME || si->mode == StartInfo::CAMPAIGN)
  603. {
  604. if(mi->campaign)
  605. return;
  606. for(int i = 0; i < mi->mapHeader->players.size(); i++)
  607. {
  608. const PlayerInfo & pinfo = mi->mapHeader->players[i];
  609. //neither computer nor human can play - no player
  610. if(!(pinfo.canHumanPlay || pinfo.canComputerPlay))
  611. continue;
  612. PlayerSettings & pset = si->playerInfos[PlayerColor(i)];
  613. pset.color = PlayerColor(i);
  614. if(pinfo.canHumanPlay && namesIt != playerNames.cend())
  615. {
  616. setPlayerConnectedId(pset, namesIt++->first);
  617. }
  618. else
  619. {
  620. setPlayerConnectedId(pset, PlayerSettings::PLAYER_AI);
  621. if(!pinfo.canHumanPlay)
  622. {
  623. pset.compOnly = true;
  624. }
  625. }
  626. pset.castle = pinfo.defaultCastle();
  627. pset.hero = pinfo.defaultHero();
  628. if(pset.hero != HeroTypeID::RANDOM && pinfo.hasCustomMainHero())
  629. {
  630. pset.hero = pinfo.mainCustomHeroId;
  631. pset.heroNameTextId = pinfo.mainCustomHeroNameTextId;
  632. pset.heroPortrait = pinfo.mainCustomHeroPortrait;
  633. }
  634. pset.handicap = PlayerSettings::NO_HANDICAP;
  635. }
  636. if(mi->isRandomMap && mapGenOpts)
  637. si->mapGenOptions = std::shared_ptr<CMapGenOptions>(mapGenOpts);
  638. else
  639. si->mapGenOptions.reset();
  640. }
  641. si->mapname = mi->fileURI;
  642. }
  643. void CVCMIServer::updateAndPropagateLobbyState()
  644. {
  645. boost::unique_lock<boost::mutex> stateLock(stateMutex);
  646. // Update player settings for RMG
  647. // TODO: find appropriate location for this code
  648. if(si->mapGenOptions && si->mode == StartInfo::NEW_GAME)
  649. {
  650. for(const auto & psetPair : si->playerInfos)
  651. {
  652. const auto & pset = psetPair.second;
  653. si->mapGenOptions->setStartingTownForPlayer(pset.color, pset.castle);
  654. if(pset.isControlledByHuman())
  655. {
  656. si->mapGenOptions->setPlayerTypeForStandardPlayer(pset.color, EPlayerType::HUMAN);
  657. }
  658. }
  659. }
  660. auto lus = std::make_unique<LobbyUpdateState>();
  661. lus->state = *this;
  662. addToAnnounceQueue(std::move(lus));
  663. }
  664. void CVCMIServer::setPlayer(PlayerColor clickedColor)
  665. {
  666. struct PlayerToRestore
  667. {
  668. PlayerColor color;
  669. int id;
  670. void reset() { id = -1; color = PlayerColor::CANNOT_DETERMINE; }
  671. PlayerToRestore(){ reset(); }
  672. } playerToRestore;
  673. PlayerSettings & clicked = si->playerInfos[clickedColor];
  674. //identify clicked player
  675. int clickedNameID = 0; //number of player - zero means AI, assume it initially
  676. if(clicked.isControlledByHuman())
  677. clickedNameID = *(clicked.connectedPlayerIDs.begin()); //if not AI - set appropiate ID
  678. if(clickedNameID > 0 && playerToRestore.id == clickedNameID) //player to restore is about to being replaced -> put him back to the old place
  679. {
  680. PlayerSettings & restPos = si->playerInfos[playerToRestore.color];
  681. setPlayerConnectedId(restPos, playerToRestore.id);
  682. playerToRestore.reset();
  683. }
  684. int newPlayer; //which player will take clicked position
  685. //who will be put here?
  686. if(!clickedNameID) //AI player clicked -> if possible replace computer with unallocated player
  687. {
  688. newPlayer = getIdOfFirstUnallocatedPlayer();
  689. if(!newPlayer) //no "free" player -> get just first one
  690. newPlayer = playerNames.begin()->first;
  691. }
  692. else //human clicked -> take next
  693. {
  694. auto i = playerNames.find(clickedNameID); //clicked one
  695. i++; //player AFTER clicked one
  696. if(i != playerNames.end())
  697. newPlayer = i->first;
  698. else
  699. newPlayer = 0; //AI if we scrolled through all players
  700. }
  701. setPlayerConnectedId(clicked, newPlayer); //put player
  702. //if that player was somewhere else, we need to replace him with computer
  703. if(newPlayer) //not AI
  704. {
  705. for(auto i = si->playerInfos.begin(); i != si->playerInfos.end(); i++)
  706. {
  707. int curNameID = *(i->second.connectedPlayerIDs.begin());
  708. if(i->first != clickedColor && curNameID == newPlayer)
  709. {
  710. assert(i->second.connectedPlayerIDs.size());
  711. playerToRestore.color = i->first;
  712. playerToRestore.id = newPlayer;
  713. setPlayerConnectedId(i->second, PlayerSettings::PLAYER_AI); //set computer
  714. break;
  715. }
  716. }
  717. }
  718. }
  719. void CVCMIServer::setPlayerName(PlayerColor color, std::string name)
  720. {
  721. if(color == PlayerColor::CANNOT_DETERMINE)
  722. return;
  723. PlayerSettings & player = si->playerInfos.at(color);
  724. if(!player.isControlledByHuman())
  725. return;
  726. if(player.connectedPlayerIDs.empty())
  727. return;
  728. int nameID = *(player.connectedPlayerIDs.begin()); //if not AI - set appropiate ID
  729. playerNames[nameID].name = name;
  730. setPlayerConnectedId(player, nameID);
  731. }
  732. void CVCMIServer::optionNextCastle(PlayerColor player, int dir)
  733. {
  734. PlayerSettings & s = si->playerInfos[player];
  735. FactionID & cur = s.castle;
  736. auto & allowed = getPlayerInfo(player).allowedFactions;
  737. const bool allowRandomTown = getPlayerInfo(player).isFactionRandom;
  738. if(cur == FactionID::NONE) //no change
  739. return;
  740. if(cur == FactionID::RANDOM) //first/last available
  741. {
  742. if(dir > 0)
  743. cur = *allowed.begin(); //id of first town
  744. else
  745. cur = *allowed.rbegin(); //id of last town
  746. }
  747. else // next/previous available
  748. {
  749. if((cur == *allowed.begin() && dir < 0) || (cur == *allowed.rbegin() && dir > 0))
  750. {
  751. if(allowRandomTown)
  752. {
  753. cur = FactionID::RANDOM;
  754. }
  755. else
  756. {
  757. if(dir > 0)
  758. cur = *allowed.begin();
  759. else
  760. cur = *allowed.rbegin();
  761. }
  762. }
  763. else
  764. {
  765. assert(dir >= -1 && dir <= 1); //othervice std::advance may go out of range
  766. auto iter = allowed.find(cur);
  767. std::advance(iter, dir);
  768. cur = *iter;
  769. }
  770. }
  771. if(s.hero.isValid() && !getPlayerInfo(player).hasCustomMainHero()) // remove hero unless it set to fixed one in map editor
  772. {
  773. s.hero = HeroTypeID::RANDOM;
  774. }
  775. if(!cur.isValid() && s.bonus == PlayerStartingBonus::RESOURCE)
  776. s.bonus = PlayerStartingBonus::RANDOM;
  777. }
  778. void CVCMIServer::optionSetCastle(PlayerColor player, FactionID id)
  779. {
  780. PlayerSettings & s = si->playerInfos[player];
  781. FactionID & cur = s.castle;
  782. auto & allowed = getPlayerInfo(player).allowedFactions;
  783. if(cur == FactionID::NONE) //no change
  784. return;
  785. if(allowed.find(id) == allowed.end() && id != FactionID::RANDOM) // valid id
  786. return;
  787. cur = static_cast<FactionID>(id);
  788. if(s.hero.isValid() && !getPlayerInfo(player).hasCustomMainHero()) // remove hero unless it set to fixed one in map editor
  789. {
  790. s.hero = HeroTypeID::RANDOM;
  791. }
  792. if(!cur.isValid() && s.bonus == PlayerStartingBonus::RESOURCE)
  793. s.bonus = PlayerStartingBonus::RANDOM;
  794. }
  795. void CVCMIServer::setCampaignMap(CampaignScenarioID mapId)
  796. {
  797. campaignMap = mapId;
  798. si->difficulty = si->campState->scenario(mapId).difficulty;
  799. campaignBonus = -1;
  800. updateStartInfoOnMapChange(si->campState->getMapInfo(mapId));
  801. }
  802. void CVCMIServer::setCampaignBonus(int bonusId)
  803. {
  804. campaignBonus = bonusId;
  805. const CampaignScenario & scenario = si->campState->scenario(campaignMap);
  806. const std::vector<CampaignBonus> & bonDescs = scenario.travelOptions.bonusesToChoose;
  807. if(bonDescs[bonusId].type == CampaignBonusType::HERO)
  808. {
  809. for(auto & elem : si->playerInfos)
  810. {
  811. if(elem.first == PlayerColor(bonDescs[bonusId].info1))
  812. setPlayerConnectedId(elem.second, 1);
  813. else
  814. setPlayerConnectedId(elem.second, PlayerSettings::PLAYER_AI);
  815. }
  816. }
  817. }
  818. void CVCMIServer::optionNextHero(PlayerColor player, int dir)
  819. {
  820. PlayerSettings & s = si->playerInfos[player];
  821. if(!s.castle.isValid() || s.hero == HeroTypeID::NONE)
  822. return;
  823. if(s.hero == HeroTypeID::RANDOM) // first/last available
  824. {
  825. if (dir > 0)
  826. s.hero = nextAllowedHero(player, HeroTypeID(-1), dir);
  827. else
  828. s.hero = nextAllowedHero(player, HeroTypeID(VLC->heroh->size()), dir);
  829. }
  830. else
  831. {
  832. s.hero = nextAllowedHero(player, s.hero, dir);
  833. }
  834. }
  835. void CVCMIServer::optionSetHero(PlayerColor player, HeroTypeID id)
  836. {
  837. PlayerSettings & s = si->playerInfos[player];
  838. if(!s.castle.isValid() || s.hero == HeroTypeID::NONE)
  839. return;
  840. if(id == HeroTypeID::RANDOM)
  841. {
  842. s.hero = HeroTypeID::RANDOM;
  843. }
  844. if(canUseThisHero(player, id))
  845. s.hero = static_cast<HeroTypeID>(id);
  846. }
  847. HeroTypeID CVCMIServer::nextAllowedHero(PlayerColor player, HeroTypeID initial, int direction)
  848. {
  849. HeroTypeID first(initial.getNum() + direction);
  850. if(direction > 0)
  851. {
  852. for (auto i = first; i.getNum() < VLC->heroh->size(); ++i)
  853. if(canUseThisHero(player, i))
  854. return i;
  855. }
  856. else
  857. {
  858. for (auto i = first; i.getNum() >= 0; --i)
  859. if(canUseThisHero(player, i))
  860. return i;
  861. }
  862. return HeroTypeID::RANDOM;
  863. }
  864. void CVCMIServer::optionNextBonus(PlayerColor player, int dir)
  865. {
  866. PlayerSettings & s = si->playerInfos[player];
  867. PlayerStartingBonus & ret = s.bonus = static_cast<PlayerStartingBonus>(static_cast<int>(s.bonus) + dir);
  868. if(s.hero == HeroTypeID::NONE &&
  869. !getPlayerInfo(player).heroesNames.size() &&
  870. ret == PlayerStartingBonus::ARTIFACT) //no hero - can't be artifact
  871. {
  872. if(dir < 0)
  873. ret = PlayerStartingBonus::RANDOM;
  874. else
  875. ret = PlayerStartingBonus::GOLD;
  876. }
  877. if(ret > PlayerStartingBonus::RESOURCE)
  878. ret = PlayerStartingBonus::RANDOM;
  879. if(ret < PlayerStartingBonus::RANDOM)
  880. ret = PlayerStartingBonus::RESOURCE;
  881. if(s.castle == FactionID::RANDOM && ret == PlayerStartingBonus::RESOURCE) //random castle - can't be resource
  882. {
  883. if(dir < 0)
  884. ret = PlayerStartingBonus::GOLD;
  885. else
  886. ret = PlayerStartingBonus::RANDOM;
  887. }
  888. }
  889. void CVCMIServer::optionSetBonus(PlayerColor player, PlayerStartingBonus id)
  890. {
  891. PlayerSettings & s = si->playerInfos[player];
  892. if(s.hero == HeroTypeID::NONE &&
  893. !getPlayerInfo(player).heroesNames.size() &&
  894. id == PlayerStartingBonus::ARTIFACT) //no hero - can't be artifact
  895. return;
  896. if(id > PlayerStartingBonus::RESOURCE)
  897. return;
  898. if(id < PlayerStartingBonus::RANDOM)
  899. return;
  900. if(s.castle == FactionID::RANDOM && id == PlayerStartingBonus::RESOURCE) //random castle - can't be resource
  901. return;
  902. s.bonus = id;
  903. }
  904. bool CVCMIServer::canUseThisHero(PlayerColor player, HeroTypeID ID)
  905. {
  906. return VLC->heroh->size() > ID
  907. && si->playerInfos[player].castle == VLC->heroh->objects[ID]->heroClass->faction
  908. && !vstd::contains(getUsedHeroes(), ID)
  909. && mi->mapHeader->allowedHeroes.count(ID);
  910. }
  911. std::vector<HeroTypeID> CVCMIServer::getUsedHeroes()
  912. {
  913. std::vector<HeroTypeID> heroIds;
  914. for(auto & p : si->playerInfos)
  915. {
  916. const auto & heroes = getPlayerInfo(p.first).heroesNames;
  917. for(auto & hero : heroes)
  918. if(hero.heroId >= 0) //in VCMI map format heroId = -1 means random hero
  919. heroIds.push_back(hero.heroId);
  920. if(p.second.hero != HeroTypeID::RANDOM)
  921. heroIds.push_back(p.second.hero);
  922. }
  923. return heroIds;
  924. }
  925. ui8 CVCMIServer::getIdOfFirstUnallocatedPlayer() const
  926. {
  927. for(auto i = playerNames.cbegin(); i != playerNames.cend(); i++)
  928. {
  929. if(!si->getPlayersSettings(i->first))
  930. return i->first;
  931. }
  932. return 0;
  933. }
  934. static void handleCommandOptions(int argc, const char * argv[], boost::program_options::variables_map & options)
  935. {
  936. namespace po = boost::program_options;
  937. po::options_description opts("Allowed options");
  938. opts.add_options()
  939. ("help,h", "display help and exit")
  940. ("version,v", "display version information and exit")
  941. ("run-by-client", "indicate that server launched by client on same machine")
  942. ("uuid", po::value<std::string>(), "")
  943. ("port", po::value<ui16>(), "port at which server will listen to connections from client")
  944. ("lobby", po::value<std::string>(), "address to remote lobby")
  945. ("lobby-port", po::value<ui16>(), "port at which server connect to remote lobby")
  946. ("lobby-uuid", po::value<std::string>(), "")
  947. ("connections", po::value<ui16>(), "amount of connections to remote lobby");
  948. if(argc > 1)
  949. {
  950. try
  951. {
  952. po::store(po::parse_command_line(argc, argv, opts), options);
  953. }
  954. catch(boost::program_options::error & e)
  955. {
  956. std::cerr << "Failure during parsing command-line options:\n" << e.what() << std::endl;
  957. }
  958. }
  959. #ifdef SINGLE_PROCESS_APP
  960. options.emplace("run-by-client", po::variable_value{true, true});
  961. #endif
  962. po::notify(options);
  963. #ifndef SINGLE_PROCESS_APP
  964. if(options.count("help"))
  965. {
  966. auto time = std::time(nullptr);
  967. printf("%s - A Heroes of Might and Magic 3 clone\n", GameConstants::VCMI_VERSION.c_str());
  968. printf("Copyright (C) 2007-%d VCMI dev team - see AUTHORS file\n", std::localtime(&time)->tm_year + 1900);
  969. printf("This is free software; see the source for copying conditions. There is NO\n");
  970. printf("warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n");
  971. printf("\n");
  972. std::cout << opts;
  973. exit(0);
  974. }
  975. if(options.count("version"))
  976. {
  977. printf("%s\n", GameConstants::VCMI_VERSION.c_str());
  978. std::cout << VCMIDirs::get().genHelpString();
  979. exit(0);
  980. }
  981. #endif
  982. }
  983. #ifdef SINGLE_PROCESS_APP
  984. #define main server_main
  985. #endif
  986. #if VCMI_ANDROID_DUAL_PROCESS
  987. void CVCMIServer::create()
  988. {
  989. const int argc = 1;
  990. const char * argv[argc] = { "android-server" };
  991. #else
  992. int main(int argc, const char * argv[])
  993. {
  994. #endif
  995. #if !defined(VCMI_ANDROID) && !defined(SINGLE_PROCESS_APP)
  996. // Correct working dir executable folder (not bundle folder) so we can use executable relative paths
  997. boost::filesystem::current_path(boost::filesystem::system_complete(argv[0]).parent_path());
  998. #endif
  999. #ifndef VCMI_IOS
  1000. console = new CConsoleHandler();
  1001. #endif
  1002. CBasicLogConfigurator logConfig(VCMIDirs::get().userLogsPath() / "VCMI_Server_log.txt", console);
  1003. logConfig.configureDefault();
  1004. logGlobal->info(SERVER_NAME);
  1005. boost::program_options::variables_map opts;
  1006. handleCommandOptions(argc, argv, opts);
  1007. preinitDLL(console);
  1008. logConfig.configure();
  1009. loadDLLClasses();
  1010. srand((ui32)time(nullptr));
  1011. #ifdef SINGLE_PROCESS_APP
  1012. boost::condition_variable * cond = reinterpret_cast<boost::condition_variable *>(const_cast<char *>(argv[0]));
  1013. cond->notify_one();
  1014. #endif
  1015. try
  1016. {
  1017. boost::asio::io_service io_service;
  1018. CVCMIServer server(opts);
  1019. try
  1020. {
  1021. while(server.getState() != EServerState::SHUTDOWN)
  1022. {
  1023. server.run();
  1024. }
  1025. io_service.run();
  1026. }
  1027. catch(boost::system::system_error & e) //for boost errors just log, not crash - probably client shut down connection
  1028. {
  1029. logNetwork->error(e.what());
  1030. server.setState(EServerState::SHUTDOWN);
  1031. }
  1032. }
  1033. catch(boost::system::system_error & e)
  1034. {
  1035. logNetwork->error(e.what());
  1036. //catch any startup errors (e.g. can't access port) errors
  1037. //and return non-zero status so client can detect error
  1038. throw;
  1039. }
  1040. #if VCMI_ANDROID_DUAL_PROCESS
  1041. CAndroidVMHelper envHelper;
  1042. envHelper.callStaticVoidMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "killServer");
  1043. #endif
  1044. logConfig.deconfigure();
  1045. vstd::clear_pointer(VLC);
  1046. #if !VCMI_ANDROID_DUAL_PROCESS
  1047. return 0;
  1048. #endif
  1049. }
  1050. #if VCMI_ANDROID_DUAL_PROCESS
  1051. extern "C" JNIEXPORT void JNICALL Java_eu_vcmi_vcmi_NativeMethods_createServer(JNIEnv * env, jclass cls)
  1052. {
  1053. __android_log_write(ANDROID_LOG_INFO, "VCMI", "Got jni call to init server");
  1054. CAndroidVMHelper::cacheVM(env);
  1055. CVCMIServer::create();
  1056. }
  1057. extern "C" JNIEXPORT void JNICALL Java_eu_vcmi_vcmi_NativeMethods_initClassloader(JNIEnv * baseEnv, jclass cls)
  1058. {
  1059. CAndroidVMHelper::initClassloader(baseEnv);
  1060. }
  1061. #elif defined(SINGLE_PROCESS_APP)
  1062. void CVCMIServer::create(boost::condition_variable * cond, const std::vector<std::string> & args)
  1063. {
  1064. std::vector<const void *> argv = {cond};
  1065. for(auto & a : args)
  1066. argv.push_back(a.c_str());
  1067. main(argv.size(), reinterpret_cast<const char **>(&*argv.begin()));
  1068. }
  1069. #ifdef VCMI_ANDROID
  1070. void CVCMIServer::reuseClientJNIEnv(void * jniEnv)
  1071. {
  1072. CAndroidVMHelper::initClassloader(jniEnv);
  1073. CAndroidVMHelper::alwaysUseLoadedClass = true;
  1074. }
  1075. #endif // VCMI_ANDROID
  1076. #endif // VCMI_ANDROID_DUAL_PROCESS