CVCMIServer.cpp 27 KB

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