CVCMIServer.cpp 30 KB

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