CVCMIServer.cpp 28 KB

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