CVCMIServer.cpp 33 KB

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