CVCMIServer.cpp 31 KB

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