CVCMIServer.cpp 30 KB

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