CVCMIServer.cpp 29 KB

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