CVCMIServer.cpp 32 KB

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