CVCMIServer.cpp 30 KB

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