CVCMIServer.cpp 32 KB

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