CVCMIServer.cpp 33 KB

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