CVCMIServer.cpp 29 KB

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