CVCMIServer.cpp 30 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135
  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/campaign/CampaignState.h"
  14. #include "../lib/CThreadHelper.h"
  15. #include "../lib/serializer/Connection.h"
  16. #include "../lib/CArtHandler.h"
  17. #include "../lib/CGeneralTextHandler.h"
  18. #include "../lib/CHeroHandler.h"
  19. #include "../lib/CTownHandler.h"
  20. #include "../lib/CBuildingHandler.h"
  21. #include "../lib/spells/CSpellHandler.h"
  22. #include "../lib/CCreatureHandler.h"
  23. #include "zlib.h"
  24. #include "CVCMIServer.h"
  25. #include "../lib/StartInfo.h"
  26. #include "../lib/mapping/CMapHeader.h"
  27. #include "../lib/rmg/CMapGenOptions.h"
  28. #include "../lib/NetPackVisitor.h"
  29. #include "LobbyNetPackVisitors.h"
  30. #ifdef VCMI_ANDROID
  31. #include <jni.h>
  32. #include <android/log.h>
  33. #include "lib/CAndroidVMHelper.h"
  34. #endif
  35. #include "../lib/VCMI_Lib.h"
  36. #include "../lib/VCMIDirs.h"
  37. #include "CGameHandler.h"
  38. #include "PlayerMessageProcessor.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/gameState/CGameState.h"
  54. template<typename T> class CApplyOnServer;
  55. class CBaseForServerApply
  56. {
  57. public:
  58. virtual bool applyOnServerBefore(CVCMIServer * srv, void * pack) const =0;
  59. virtual void applyOnServerAfter(CVCMIServer * srv, void * pack) const =0;
  60. virtual ~CBaseForServerApply() {}
  61. template<typename U> static CBaseForServerApply * getApplier(const U * t = nullptr)
  62. {
  63. return new CApplyOnServer<U>();
  64. }
  65. };
  66. template <typename T> class CApplyOnServer : public CBaseForServerApply
  67. {
  68. public:
  69. bool applyOnServerBefore(CVCMIServer * srv, void * pack) const override
  70. {
  71. T * ptr = static_cast<T *>(pack);
  72. ClientPermissionsCheckerNetPackVisitor checker(*srv);
  73. ptr->visit(checker);
  74. if(checker.getResult())
  75. {
  76. boost::unique_lock<boost::mutex> stateLock(srv->stateMutex);
  77. ApplyOnServerNetPackVisitor applier(*srv);
  78. ptr->visit(applier);
  79. return applier.getResult();
  80. }
  81. else
  82. return false;
  83. }
  84. void applyOnServerAfter(CVCMIServer * srv, void * pack) const override
  85. {
  86. T * ptr = static_cast<T *>(pack);
  87. ApplyOnServerAfterAnnounceNetPackVisitor applier(*srv);
  88. ptr->visit(applier);
  89. }
  90. };
  91. template <>
  92. class CApplyOnServer<CPack> : public CBaseForServerApply
  93. {
  94. public:
  95. bool applyOnServerBefore(CVCMIServer * srv, void * pack) const override
  96. {
  97. logGlobal->error("Cannot apply plain CPack!");
  98. assert(0);
  99. return false;
  100. }
  101. void applyOnServerAfter(CVCMIServer * srv, void * pack) const override
  102. {
  103. logGlobal->error("Cannot apply plain CPack!");
  104. assert(0);
  105. }
  106. };
  107. std::string SERVER_NAME_AFFIX = "server";
  108. std::string SERVER_NAME = GameConstants::VCMI_VERSION + std::string(" (") + SERVER_NAME_AFFIX + ')';
  109. CVCMIServer::CVCMIServer(boost::program_options::variables_map & opts)
  110. : port(3030), io(std::make_shared<boost::asio::io_service>()), state(EServerState::LOBBY), cmdLineOptions(opts), currentClientId(1), currentPlayerId(1), restartGameplay(false)
  111. {
  112. uuid = boost::uuids::to_string(boost::uuids::random_generator()());
  113. logNetwork->trace("CVCMIServer created! UUID: %s", uuid);
  114. applier = std::make_shared<CApplier<CBaseForServerApply>>();
  115. registerTypesLobbyPacks(*applier);
  116. if(cmdLineOptions.count("port"))
  117. port = cmdLineOptions["port"].as<ui16>();
  118. logNetwork->info("Port %d will be used", port);
  119. try
  120. {
  121. acceptor = std::make_shared<TAcceptor>(*io, boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), port));
  122. }
  123. catch(...)
  124. {
  125. logNetwork->info("Port %d is busy, trying to use random port instead", port);
  126. if(cmdLineOptions.count("run-by-client"))
  127. {
  128. logNetwork->error("Port must be specified when run-by-client is used!!");
  129. exit(0);
  130. }
  131. acceptor = std::make_shared<TAcceptor>(*io, boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), 0));
  132. port = acceptor->local_endpoint().port();
  133. }
  134. logNetwork->info("Listening for connections at port %d", port);
  135. }
  136. CVCMIServer::~CVCMIServer()
  137. {
  138. announceQueue.clear();
  139. if(announceLobbyThread)
  140. announceLobbyThread->join();
  141. }
  142. void CVCMIServer::run()
  143. {
  144. if(!restartGameplay)
  145. {
  146. this->announceLobbyThread = std::make_unique<boost::thread>(&CVCMIServer::threadAnnounceLobby, this);
  147. startAsyncAccept();
  148. if(!remoteConnectionsThread && cmdLineOptions.count("lobby"))
  149. {
  150. remoteConnectionsThread = std::make_unique<boost::thread>(&CVCMIServer::establishRemoteConnections, this);
  151. }
  152. #if defined(VCMI_ANDROID)
  153. #ifndef SINGLE_PROCESS_APP
  154. CAndroidVMHelper vmHelper;
  155. vmHelper.callStaticVoidMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "onServerReady");
  156. #endif
  157. #endif
  158. }
  159. while(state == EServerState::LOBBY || state == EServerState::GAMEPLAY_STARTING)
  160. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  161. logNetwork->info("Thread handling connections ended");
  162. if(state == EServerState::GAMEPLAY)
  163. {
  164. gh->run(si->mode == StartInfo::LOAD_GAME);
  165. }
  166. while(state == EServerState::GAMEPLAY_ENDED)
  167. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  168. }
  169. void CVCMIServer::establishRemoteConnections()
  170. {
  171. //wait for host connection
  172. while(connections.empty())
  173. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  174. uuid = cmdLineOptions["lobby-uuid"].as<std::string>();
  175. int numOfConnections = cmdLineOptions["connections"].as<ui16>();
  176. auto address = cmdLineOptions["lobby"].as<std::string>();
  177. int port = cmdLineOptions["lobby-port"].as<ui16>();
  178. logGlobal->info("Server is connecting to remote at %s:%d with uuid %s %d times", address, port, uuid, numOfConnections);
  179. for(int i = 0; i < numOfConnections; ++i)
  180. connectToRemote(address, port);
  181. }
  182. void CVCMIServer::connectToRemote(const std::string & addr, int port)
  183. {
  184. std::shared_ptr<CConnection> c;
  185. try
  186. {
  187. logNetwork->info("Establishing connection...");
  188. c = std::make_shared<CConnection>(addr, port, SERVER_NAME, uuid);
  189. }
  190. catch(...)
  191. {
  192. logNetwork->error("\nCannot establish remote connection!");
  193. }
  194. if(c)
  195. {
  196. connections.insert(c);
  197. c->handler = std::make_shared<boost::thread>(&CVCMIServer::threadHandleClient, this, c);
  198. }
  199. }
  200. void CVCMIServer::threadAnnounceLobby()
  201. {
  202. while(state != EServerState::SHUTDOWN)
  203. {
  204. {
  205. boost::unique_lock<boost::recursive_mutex> myLock(mx);
  206. while(!announceQueue.empty())
  207. {
  208. announcePack(std::move(announceQueue.front()));
  209. announceQueue.pop_front();
  210. }
  211. if(acceptor)
  212. {
  213. io->reset();
  214. io->poll();
  215. }
  216. }
  217. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  218. }
  219. }
  220. void CVCMIServer::prepareToRestart()
  221. {
  222. if(state == EServerState::GAMEPLAY)
  223. {
  224. restartGameplay = true;
  225. * si = * gh->gs->initialOpts;
  226. si->seedToBeUsed = si->seedPostInit = 0;
  227. state = EServerState::LOBBY;
  228. if (si->campState)
  229. {
  230. assert(si->campState->currentScenario().has_value());
  231. campaignMap = si->campState->currentScenario().value_or(CampaignScenarioID(0));
  232. campaignBonus = si->campState->getBonusID(campaignMap).value_or(-1);
  233. }
  234. // FIXME: dirry hack to make sure old CGameHandler::run is finished
  235. boost::this_thread::sleep(boost::posix_time::milliseconds(1000));
  236. }
  237. for(auto c : connections)
  238. {
  239. c->enterLobbyConnectionMode();
  240. c->disableStackSendingByID();
  241. }
  242. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  243. gh = nullptr;
  244. }
  245. bool CVCMIServer::prepareToStartGame()
  246. {
  247. gh = std::make_shared<CGameHandler>(this);
  248. switch(si->mode)
  249. {
  250. case StartInfo::CAMPAIGN:
  251. logNetwork->info("Preparing to start new campaign");
  252. si->campState->setCurrentMap(campaignMap);
  253. si->campState->setCurrentMapBonus(campaignBonus);
  254. gh->init(si.get());
  255. break;
  256. case StartInfo::NEW_GAME:
  257. logNetwork->info("Preparing to start new game");
  258. gh->init(si.get());
  259. break;
  260. case StartInfo::LOAD_GAME:
  261. logNetwork->info("Preparing to start loaded game");
  262. if(!gh->load(si->mapname))
  263. return false;
  264. break;
  265. default:
  266. logNetwork->error("Wrong mode in StartInfo!");
  267. assert(0);
  268. break;
  269. }
  270. state = EServerState::GAMEPLAY_STARTING;
  271. return true;
  272. }
  273. void CVCMIServer::startGameImmidiately()
  274. {
  275. for(auto c : connections)
  276. c->enterGameplayConnectionMode(gh->gs);
  277. state = EServerState::GAMEPLAY;
  278. }
  279. void CVCMIServer::startAsyncAccept()
  280. {
  281. assert(!upcomingConnection);
  282. assert(acceptor);
  283. #if BOOST_VERSION >= 107000 // Boost version >= 1.70
  284. upcomingConnection = std::make_shared<TSocket>(acceptor->get_executor());
  285. #else
  286. upcomingConnection = std::make_shared<TSocket>(acceptor->get_io_service());
  287. #endif
  288. acceptor->async_accept(*upcomingConnection, std::bind(&CVCMIServer::connectionAccepted, this, _1));
  289. }
  290. void CVCMIServer::connectionAccepted(const boost::system::error_code & ec)
  291. {
  292. if(ec)
  293. {
  294. if(state != EServerState::SHUTDOWN)
  295. logNetwork->info("Something wrong during accepting: %s", ec.message());
  296. return;
  297. }
  298. try
  299. {
  300. if(state == EServerState::LOBBY || !hangingConnections.empty())
  301. {
  302. logNetwork->info("We got a new connection! :)");
  303. auto c = std::make_shared<CConnection>(upcomingConnection, SERVER_NAME, uuid);
  304. upcomingConnection.reset();
  305. connections.insert(c);
  306. c->handler = std::make_shared<boost::thread>(&CVCMIServer::threadHandleClient, this, c);
  307. }
  308. }
  309. catch(std::exception & e)
  310. {
  311. logNetwork->error("Failure processing new connection! %s", e.what());
  312. upcomingConnection.reset();
  313. }
  314. startAsyncAccept();
  315. }
  316. class CVCMIServerPackVisitor : public VCMI_LIB_WRAP_NAMESPACE(ICPackVisitor)
  317. {
  318. private:
  319. CVCMIServer & handler;
  320. std::shared_ptr<CGameHandler> gh;
  321. public:
  322. CVCMIServerPackVisitor(CVCMIServer & handler, std::shared_ptr<CGameHandler> gh)
  323. :handler(handler), gh(gh)
  324. {
  325. }
  326. virtual bool callTyped() override { return false; }
  327. virtual void visitForLobby(CPackForLobby & packForLobby) override
  328. {
  329. handler.handleReceivedPack(std::unique_ptr<CPackForLobby>(&packForLobby));
  330. }
  331. virtual void visitForServer(CPackForServer & serverPack) override
  332. {
  333. if (gh)
  334. gh->handleReceivedPack(&serverPack);
  335. else
  336. logNetwork->error("Received pack for game server while in lobby!");
  337. }
  338. virtual void visitForClient(CPackForClient & clientPack) override
  339. {
  340. }
  341. };
  342. void CVCMIServer::threadHandleClient(std::shared_ptr<CConnection> c)
  343. {
  344. setThreadName("CVCMIServer::handleConnection");
  345. c->enterLobbyConnectionMode();
  346. while(c->connected)
  347. {
  348. CPack * pack;
  349. try
  350. {
  351. pack = c->retrievePack();
  352. }
  353. catch(boost::system::system_error & e)
  354. {
  355. if (e.code() == boost::asio::error::eof)
  356. logNetwork->error("Network error receiving a pack. Connection has been closed");
  357. else
  358. logNetwork->error("Network error receiving a pack. Connection %s dies. What happened: %s", c->toString(), e.what());
  359. hangingConnections.insert(c);
  360. connections.erase(c);
  361. if(connections.empty() || hostClient == c)
  362. state = EServerState::SHUTDOWN;
  363. if(gh && state == EServerState::GAMEPLAY)
  364. {
  365. gh->handleClientDisconnection(c);
  366. }
  367. break;
  368. }
  369. CVCMIServerPackVisitor visitor(*this, this->gh);
  370. pack->visit(visitor);
  371. }
  372. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  373. if(c->connected)
  374. {
  375. auto lcd = std::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 = std::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 = std::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->playerMessages->broadcastMessage(playerSettings->color, playerLeftMsgText);
  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->playerMessages->broadcastMessage(playerSettings->color, messageText);
  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->currentScenario().value();
  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->campaign)
  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 = std::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. FactionID & 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(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(CampaignScenarioID mapId)
  729. {
  730. campaignMap = mapId;
  731. si->difficulty = si->campState->scenario(mapId).difficulty;
  732. campaignBonus = -1;
  733. updateStartInfoOnMapChange(si->campState->getMapInfo(mapId));
  734. }
  735. void CVCMIServer::setCampaignBonus(int bonusId)
  736. {
  737. campaignBonus = bonusId;
  738. const CampaignScenario & scenario = si->campState->scenario(campaignMap);
  739. const std::vector<CampaignBonus> & bonDescs = scenario.travelOptions.bonusesToChoose;
  740. if(bonDescs[bonusId].type == CampaignBonusType::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. static void handleCommandOptions(int argc, const char * argv[], boost::program_options::variables_map & options)
  842. {
  843. namespace po = boost::program_options;
  844. po::options_description opts("Allowed options");
  845. opts.add_options()
  846. ("help,h", "display help and exit")
  847. ("version,v", "display version information and exit")
  848. ("run-by-client", "indicate that server launched by client on same machine")
  849. ("uuid", po::value<std::string>(), "")
  850. ("port", po::value<ui16>(), "port at which server will listen to connections from client")
  851. ("lobby", po::value<std::string>(), "address to remote lobby")
  852. ("lobby-port", po::value<ui16>(), "port at which server connect to remote lobby")
  853. ("lobby-uuid", po::value<std::string>(), "")
  854. ("connections", po::value<ui16>(), "amount of connections to remote lobby");
  855. if(argc > 1)
  856. {
  857. try
  858. {
  859. po::store(po::parse_command_line(argc, argv, opts), options);
  860. }
  861. catch(boost::program_options::error & e)
  862. {
  863. std::cerr << "Failure during parsing command-line options:\n" << e.what() << std::endl;
  864. }
  865. }
  866. #ifdef SINGLE_PROCESS_APP
  867. options.emplace("run-by-client", po::variable_value{true, true});
  868. #endif
  869. po::notify(options);
  870. #ifndef SINGLE_PROCESS_APP
  871. if(options.count("help"))
  872. {
  873. auto time = std::time(0);
  874. printf("%s - A Heroes of Might and Magic 3 clone\n", GameConstants::VCMI_VERSION.c_str());
  875. printf("Copyright (C) 2007-%d VCMI dev team - see AUTHORS file\n", std::localtime(&time)->tm_year + 1900);
  876. printf("This is free software; see the source for copying conditions. There is NO\n");
  877. printf("warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n");
  878. printf("\n");
  879. std::cout << opts;
  880. exit(0);
  881. }
  882. if(options.count("version"))
  883. {
  884. printf("%s\n", GameConstants::VCMI_VERSION.c_str());
  885. std::cout << VCMIDirs::get().genHelpString();
  886. exit(0);
  887. }
  888. #endif
  889. }
  890. #ifdef SINGLE_PROCESS_APP
  891. #define main server_main
  892. #endif
  893. #if VCMI_ANDROID_DUAL_PROCESS
  894. void CVCMIServer::create()
  895. {
  896. const int argc = 1;
  897. const char * argv[argc] = { "android-server" };
  898. #else
  899. int main(int argc, const char * argv[])
  900. {
  901. #endif
  902. #if !defined(VCMI_ANDROID) && !defined(SINGLE_PROCESS_APP)
  903. // Correct working dir executable folder (not bundle folder) so we can use executable relative paths
  904. boost::filesystem::current_path(boost::filesystem::system_complete(argv[0]).parent_path());
  905. #endif
  906. #ifndef VCMI_IOS
  907. console = new CConsoleHandler();
  908. #endif
  909. CBasicLogConfigurator logConfig(VCMIDirs::get().userLogsPath() / "VCMI_Server_log.txt", console);
  910. logConfig.configureDefault();
  911. logGlobal->info(SERVER_NAME);
  912. boost::program_options::variables_map opts;
  913. handleCommandOptions(argc, argv, opts);
  914. preinitDLL(console);
  915. logConfig.configure();
  916. loadDLLClasses();
  917. srand((ui32)time(nullptr));
  918. #ifdef SINGLE_PROCESS_APP
  919. boost::condition_variable * cond = reinterpret_cast<boost::condition_variable *>(const_cast<char *>(argv[0]));
  920. cond->notify_one();
  921. #endif
  922. try
  923. {
  924. boost::asio::io_service io_service;
  925. CVCMIServer server(opts);
  926. try
  927. {
  928. while(server.state != EServerState::SHUTDOWN)
  929. {
  930. server.run();
  931. }
  932. io_service.run();
  933. }
  934. catch(boost::system::system_error & e) //for boost errors just log, not crash - probably client shut down connection
  935. {
  936. logNetwork->error(e.what());
  937. server.state = EServerState::SHUTDOWN;
  938. }
  939. }
  940. catch(boost::system::system_error & e)
  941. {
  942. logNetwork->error(e.what());
  943. //catch any startup errors (e.g. can't access port) errors
  944. //and return non-zero status so client can detect error
  945. throw;
  946. }
  947. #if VCMI_ANDROID_DUAL_PROCESS
  948. CAndroidVMHelper envHelper;
  949. envHelper.callStaticVoidMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "killServer");
  950. #endif
  951. logConfig.deconfigure();
  952. vstd::clear_pointer(VLC);
  953. #if !VCMI_ANDROID_DUAL_PROCESS
  954. return 0;
  955. #endif
  956. }
  957. #if VCMI_ANDROID_DUAL_PROCESS
  958. extern "C" JNIEXPORT void JNICALL Java_eu_vcmi_vcmi_NativeMethods_createServer(JNIEnv * env, jclass cls)
  959. {
  960. __android_log_write(ANDROID_LOG_INFO, "VCMI", "Got jni call to init server");
  961. CAndroidVMHelper::cacheVM(env);
  962. CVCMIServer::create();
  963. }
  964. extern "C" JNIEXPORT void JNICALL Java_eu_vcmi_vcmi_NativeMethods_initClassloader(JNIEnv * baseEnv, jclass cls)
  965. {
  966. CAndroidVMHelper::initClassloader(baseEnv);
  967. }
  968. #elif defined(SINGLE_PROCESS_APP)
  969. void CVCMIServer::create(boost::condition_variable * cond, const std::vector<std::string> & args)
  970. {
  971. std::vector<const void *> argv = {cond};
  972. for(auto & a : args)
  973. argv.push_back(a.c_str());
  974. main(argv.size(), reinterpret_cast<const char **>(&*argv.begin()));
  975. }
  976. #ifdef VCMI_ANDROID
  977. void CVCMIServer::reuseClientJNIEnv(void * jniEnv)
  978. {
  979. CAndroidVMHelper::initClassloader(jniEnv);
  980. CAndroidVMHelper::alwaysUseLoadedClass = true;
  981. }
  982. #endif // VCMI_ANDROID
  983. #endif // VCMI_ANDROID_DUAL_PROCESS