CVCMIServer.cpp 29 KB

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