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