CVCMIServer.cpp 27 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025
  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 !defined(VCMI_ANDROID) && !defined(VCMI_IOS)
  156. if(shm)
  157. {
  158. shm->sr->setToReadyAndNotify(port);
  159. }
  160. #endif
  161. }
  162. while(state == EServerState::LOBBY || state == EServerState::GAMEPLAY_STARTING)
  163. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  164. logNetwork->info("Thread handling connections ended");
  165. if(state == EServerState::GAMEPLAY)
  166. {
  167. gh->run(si->mode == StartInfo::LOAD_GAME);
  168. }
  169. while(state == EServerState::GAMEPLAY_ENDED)
  170. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  171. }
  172. void CVCMIServer::threadAnnounceLobby()
  173. {
  174. while(state != EServerState::SHUTDOWN)
  175. {
  176. {
  177. boost::unique_lock<boost::recursive_mutex> myLock(mx);
  178. while(!announceQueue.empty())
  179. {
  180. announcePack(std::move(announceQueue.front()));
  181. announceQueue.pop_front();
  182. }
  183. if(state != EServerState::LOBBY)
  184. {
  185. if(acceptor)
  186. acceptor->close();
  187. }
  188. if(acceptor)
  189. {
  190. io->reset();
  191. io->poll();
  192. }
  193. }
  194. boost::this_thread::sleep(boost::posix_time::milliseconds(50));
  195. }
  196. }
  197. bool CVCMIServer::prepareToStartGame()
  198. {
  199. if(state == EServerState::GAMEPLAY)
  200. {
  201. restartGameplay = true;
  202. * si = * gh->gs->initialOpts;
  203. si->seedToBeUsed = si->seedPostInit = 0;
  204. state = EServerState::LOBBY;
  205. // FIXME: dirry hack to make sure old CGameHandler::run is finished
  206. boost::this_thread::sleep(boost::posix_time::milliseconds(1000));
  207. }
  208. if(!gh)
  209. gh = std::make_shared<CGameHandler>(this);
  210. switch(si->mode)
  211. {
  212. case StartInfo::CAMPAIGN:
  213. logNetwork->info("Preparing to start new campaign");
  214. si->campState->currentMap = boost::make_optional(campaignMap);
  215. si->campState->chosenCampaignBonuses[campaignMap] = campaignBonus;
  216. gh->init(si.get());
  217. break;
  218. case StartInfo::NEW_GAME:
  219. logNetwork->info("Preparing to start new game");
  220. gh->init(si.get());
  221. break;
  222. case StartInfo::LOAD_GAME:
  223. logNetwork->info("Preparing to start loaded game");
  224. if(!gh->load(si->mapname))
  225. return false;
  226. break;
  227. default:
  228. logNetwork->error("Wrong mode in StartInfo!");
  229. assert(0);
  230. break;
  231. }
  232. state = EServerState::GAMEPLAY_STARTING;
  233. return true;
  234. }
  235. void CVCMIServer::startGameImmidiately()
  236. {
  237. for(auto c : connections)
  238. c->enterGameplayConnectionMode(gh->gs);
  239. state = EServerState::GAMEPLAY;
  240. }
  241. void CVCMIServer::startAsyncAccept()
  242. {
  243. assert(!upcomingConnection);
  244. assert(acceptor);
  245. #if BOOST_VERSION >= 107000 // Boost version >= 1.70
  246. upcomingConnection = std::make_shared<TSocket>(acceptor->get_executor());
  247. #else
  248. upcomingConnection = std::make_shared<TSocket>(acceptor->get_io_service());
  249. #endif
  250. acceptor->async_accept(*upcomingConnection, std::bind(&CVCMIServer::connectionAccepted, this, _1));
  251. }
  252. void CVCMIServer::connectionAccepted(const boost::system::error_code & ec)
  253. {
  254. if(ec)
  255. {
  256. if(state != EServerState::SHUTDOWN)
  257. logNetwork->info("Something wrong during accepting: %s", ec.message());
  258. return;
  259. }
  260. try
  261. {
  262. logNetwork->info("We got a new connection! :)");
  263. auto c = std::make_shared<CConnection>(upcomingConnection, SERVER_NAME, uuid);
  264. upcomingConnection.reset();
  265. connections.insert(c);
  266. c->handler = std::make_shared<boost::thread>(&CVCMIServer::threadHandleClient, this, c);
  267. }
  268. catch(std::exception & e)
  269. {
  270. logNetwork->error("Failure processing new connection! %s", e.what());
  271. upcomingConnection.reset();
  272. }
  273. startAsyncAccept();
  274. }
  275. void CVCMIServer::threadHandleClient(std::shared_ptr<CConnection> c)
  276. {
  277. setThreadName("CVCMIServer::handleConnection");
  278. c->enterLobbyConnectionMode();
  279. #ifndef _MSC_VER
  280. try
  281. {
  282. #endif
  283. while(c->connected)
  284. {
  285. CPack * pack;
  286. try
  287. {
  288. pack = c->retrievePack();
  289. }
  290. catch(boost::system::system_error & e)
  291. {
  292. logNetwork->error("Network error receiving a pack. Connection %s dies. What happened: %s", c->toString(), e.what());
  293. if(state != EServerState::LOBBY)
  294. gh->handleClientDisconnection(c);
  295. break;
  296. }
  297. if(auto lobbyPack = dynamic_ptr_cast<CPackForLobby>(pack))
  298. {
  299. handleReceivedPack(std::unique_ptr<CPackForLobby>(lobbyPack));
  300. }
  301. else if(auto serverPack = dynamic_ptr_cast<CPackForServer>(pack))
  302. {
  303. gh->handleReceivedPack(serverPack);
  304. }
  305. }
  306. #ifndef _MSC_VER
  307. }
  308. catch(const std::exception & e)
  309. {
  310. (void)e;
  311. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  312. logNetwork->error("%s dies... \nWhat happened: %s", c->toString(), e.what());
  313. }
  314. catch(...)
  315. {
  316. state = EServerState::SHUTDOWN;
  317. handleException();
  318. throw;
  319. }
  320. #endif
  321. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  322. // if(state != ENDING_AND_STARTING_GAME)
  323. if(c->connected)
  324. {
  325. auto lcd = vstd::make_unique<LobbyClientDisconnected>();
  326. lcd->c = c;
  327. lcd->clientId = c->connectionID;
  328. handleReceivedPack(std::move(lcd));
  329. }
  330. logNetwork->info("Thread listening for %s ended", c->toString());
  331. c->handler.reset();
  332. }
  333. void CVCMIServer::handleReceivedPack(std::unique_ptr<CPackForLobby> pack)
  334. {
  335. CBaseForServerApply * apply = applier->getApplier(typeList.getTypeID(pack.get()));
  336. if(apply->applyOnServerBefore(this, pack.get()))
  337. addToAnnounceQueue(std::move(pack));
  338. }
  339. void CVCMIServer::announcePack(std::unique_ptr<CPackForLobby> pack)
  340. {
  341. for(auto c : connections)
  342. {
  343. // FIXME: we need to avoid sending something to client that not yet get answer for LobbyClientConnected
  344. // Until UUID set we only pass LobbyClientConnected to this client
  345. if(c->uuid == uuid && !dynamic_cast<LobbyClientConnected *>(pack.get()))
  346. continue;
  347. c->sendPack(pack.get());
  348. }
  349. applier->getApplier(typeList.getTypeID(pack.get()))->applyOnServerAfter(this, pack.get());
  350. }
  351. void CVCMIServer::announceMessage(const std::string & txt)
  352. {
  353. logNetwork->info("Show message: %s", txt);
  354. auto cm = vstd::make_unique<LobbyShowMessage>();
  355. cm->message = txt;
  356. addToAnnounceQueue(std::move(cm));
  357. }
  358. void CVCMIServer::announceTxt(const std::string & txt, const std::string & playerName)
  359. {
  360. logNetwork->info("%s says: %s", playerName, txt);
  361. auto cm = vstd::make_unique<LobbyChatMessage>();
  362. cm->playerName = playerName;
  363. cm->message = txt;
  364. addToAnnounceQueue(std::move(cm));
  365. }
  366. void CVCMIServer::addToAnnounceQueue(std::unique_ptr<CPackForLobby> pack)
  367. {
  368. boost::unique_lock<boost::recursive_mutex> queueLock(mx);
  369. announceQueue.push_back(std::move(pack));
  370. }
  371. bool CVCMIServer::passHost(int toConnectionId)
  372. {
  373. for(auto c : connections)
  374. {
  375. if(isClientHost(c->connectionID))
  376. continue;
  377. if(c->connectionID != toConnectionId)
  378. continue;
  379. hostClient = c;
  380. hostClientId = c->connectionID;
  381. announceTxt(boost::str(boost::format("Pass host to connection %d") % toConnectionId));
  382. return true;
  383. }
  384. return false;
  385. }
  386. void CVCMIServer::clientConnected(std::shared_ptr<CConnection> c, std::vector<std::string> & names, std::string uuid, StartInfo::EMode mode)
  387. {
  388. c->connectionID = currentClientId++;
  389. if(!hostClient)
  390. {
  391. hostClient = c;
  392. hostClientId = c->connectionID;
  393. si->mode = mode;
  394. }
  395. logNetwork->info("Connection with client %d established. UUID: %s", c->connectionID, c->uuid);
  396. for(auto & name : names)
  397. {
  398. logNetwork->info("Client %d player: %s", c->connectionID, name);
  399. ui8 id = currentPlayerId++;
  400. ClientPlayer cp;
  401. cp.connection = c->connectionID;
  402. cp.name = name;
  403. playerNames.insert(std::make_pair(id, cp));
  404. announceTxt(boost::str(boost::format("%s (pid %d cid %d) joins the game") % name % id % c->connectionID));
  405. //put new player in first slot with AI
  406. for(auto & elem : si->playerInfos)
  407. {
  408. if(elem.second.isControlledByAI() && !elem.second.compOnly)
  409. {
  410. setPlayerConnectedId(elem.second, id);
  411. break;
  412. }
  413. }
  414. }
  415. }
  416. void CVCMIServer::clientDisconnected(std::shared_ptr<CConnection> c)
  417. {
  418. connections -= c;
  419. for(auto it = playerNames.begin(); it != playerNames.end();)
  420. {
  421. if(it->second.connection != c->connectionID)
  422. {
  423. it++;
  424. continue;
  425. }
  426. int id = it->first;
  427. announceTxt(boost::str(boost::format("%s (pid %d cid %d) left the game") % id % playerNames[id].name % c->connectionID));
  428. playerNames.erase(it++);
  429. // Reset in-game players client used back to AI
  430. if(PlayerSettings * s = si->getPlayersSettings(id))
  431. {
  432. setPlayerConnectedId(*s, PlayerSettings::PLAYER_AI);
  433. }
  434. }
  435. }
  436. void CVCMIServer::setPlayerConnectedId(PlayerSettings & pset, ui8 player) const
  437. {
  438. if(vstd::contains(playerNames, player))
  439. pset.name = playerNames.find(player)->second.name;
  440. else
  441. pset.name = VLC->generaltexth->allTexts[468]; //Computer
  442. pset.connectedPlayerIDs.clear();
  443. if(player != PlayerSettings::PLAYER_AI)
  444. pset.connectedPlayerIDs.insert(player);
  445. }
  446. void CVCMIServer::updateStartInfoOnMapChange(std::shared_ptr<CMapInfo> mapInfo, std::shared_ptr<CMapGenOptions> mapGenOpts)
  447. {
  448. mi = mapInfo;
  449. if(!mi)
  450. return;
  451. auto namesIt = playerNames.cbegin();
  452. si->playerInfos.clear();
  453. if(mi->scenarioOptionsOfSave)
  454. {
  455. si = CMemorySerializer::deepCopy(*mi->scenarioOptionsOfSave);
  456. si->mode = StartInfo::LOAD_GAME;
  457. if(si->campState)
  458. campaignMap = si->campState->currentMap.get();
  459. for(auto & ps : si->playerInfos)
  460. {
  461. if(!ps.second.compOnly && ps.second.connectedPlayerIDs.size() && namesIt != playerNames.cend())
  462. {
  463. setPlayerConnectedId(ps.second, namesIt++->first);
  464. }
  465. else
  466. {
  467. setPlayerConnectedId(ps.second, PlayerSettings::PLAYER_AI);
  468. }
  469. }
  470. }
  471. else if(si->mode == StartInfo::NEW_GAME || si->mode == StartInfo::CAMPAIGN)
  472. {
  473. if(mi->campaignHeader)
  474. return;
  475. for(int i = 0; i < mi->mapHeader->players.size(); i++)
  476. {
  477. const PlayerInfo & pinfo = mi->mapHeader->players[i];
  478. //neither computer nor human can play - no player
  479. if(!(pinfo.canHumanPlay || pinfo.canComputerPlay))
  480. continue;
  481. PlayerSettings & pset = si->playerInfos[PlayerColor(i)];
  482. pset.color = PlayerColor(i);
  483. if(pinfo.canHumanPlay && namesIt != playerNames.cend())
  484. {
  485. setPlayerConnectedId(pset, namesIt++->first);
  486. }
  487. else
  488. {
  489. setPlayerConnectedId(pset, PlayerSettings::PLAYER_AI);
  490. if(!pinfo.canHumanPlay)
  491. {
  492. pset.compOnly = true;
  493. }
  494. }
  495. pset.castle = pinfo.defaultCastle();
  496. pset.hero = pinfo.defaultHero();
  497. if(pset.hero != PlayerSettings::RANDOM && pinfo.hasCustomMainHero())
  498. {
  499. pset.hero = pinfo.mainCustomHeroId;
  500. pset.heroName = pinfo.mainCustomHeroName;
  501. pset.heroPortrait = pinfo.mainCustomHeroPortrait;
  502. }
  503. pset.handicap = PlayerSettings::NO_HANDICAP;
  504. }
  505. if(mi->isRandomMap && mapGenOpts)
  506. si->mapGenOptions = std::shared_ptr<CMapGenOptions>(mapGenOpts);
  507. else
  508. si->mapGenOptions.reset();
  509. }
  510. si->mapname = mi->fileURI;
  511. }
  512. void CVCMIServer::updateAndPropagateLobbyState()
  513. {
  514. boost::unique_lock<boost::mutex> stateLock(stateMutex);
  515. // Update player settings for RMG
  516. // TODO: find appropriate location for this code
  517. if(si->mapGenOptions && si->mode == StartInfo::NEW_GAME)
  518. {
  519. for(const auto & psetPair : si->playerInfos)
  520. {
  521. const auto & pset = psetPair.second;
  522. si->mapGenOptions->setStartingTownForPlayer(pset.color, pset.castle);
  523. if(pset.isControlledByHuman())
  524. {
  525. si->mapGenOptions->setPlayerTypeForStandardPlayer(pset.color, EPlayerType::HUMAN);
  526. }
  527. }
  528. }
  529. auto lus = vstd::make_unique<LobbyUpdateState>();
  530. lus->state = *this;
  531. addToAnnounceQueue(std::move(lus));
  532. }
  533. void CVCMIServer::setPlayer(PlayerColor clickedColor)
  534. {
  535. struct PlayerToRestore
  536. {
  537. PlayerColor color;
  538. int id;
  539. void reset() { id = -1; color = PlayerColor::CANNOT_DETERMINE; }
  540. PlayerToRestore(){ reset(); }
  541. } playerToRestore;
  542. PlayerSettings & clicked = si->playerInfos[clickedColor];
  543. //identify clicked player
  544. int clickedNameID = 0; //number of player - zero means AI, assume it initially
  545. if(clicked.isControlledByHuman())
  546. clickedNameID = *(clicked.connectedPlayerIDs.begin()); //if not AI - set appropiate ID
  547. if(clickedNameID > 0 && playerToRestore.id == clickedNameID) //player to restore is about to being replaced -> put him back to the old place
  548. {
  549. PlayerSettings & restPos = si->playerInfos[playerToRestore.color];
  550. setPlayerConnectedId(restPos, playerToRestore.id);
  551. playerToRestore.reset();
  552. }
  553. int newPlayer; //which player will take clicked position
  554. //who will be put here?
  555. if(!clickedNameID) //AI player clicked -> if possible replace computer with unallocated player
  556. {
  557. newPlayer = getIdOfFirstUnallocatedPlayer();
  558. if(!newPlayer) //no "free" player -> get just first one
  559. newPlayer = playerNames.begin()->first;
  560. }
  561. else //human clicked -> take next
  562. {
  563. auto i = playerNames.find(clickedNameID); //clicked one
  564. i++; //player AFTER clicked one
  565. if(i != playerNames.end())
  566. newPlayer = i->first;
  567. else
  568. newPlayer = 0; //AI if we scrolled through all players
  569. }
  570. setPlayerConnectedId(clicked, newPlayer); //put player
  571. //if that player was somewhere else, we need to replace him with computer
  572. if(newPlayer) //not AI
  573. {
  574. for(auto i = si->playerInfos.begin(); i != si->playerInfos.end(); i++)
  575. {
  576. int curNameID = *(i->second.connectedPlayerIDs.begin());
  577. if(i->first != clickedColor && curNameID == newPlayer)
  578. {
  579. assert(i->second.connectedPlayerIDs.size());
  580. playerToRestore.color = i->first;
  581. playerToRestore.id = newPlayer;
  582. setPlayerConnectedId(i->second, PlayerSettings::PLAYER_AI); //set computer
  583. break;
  584. }
  585. }
  586. }
  587. }
  588. void CVCMIServer::optionNextCastle(PlayerColor player, int dir)
  589. {
  590. PlayerSettings & s = si->playerInfos[player];
  591. si16 & cur = s.castle;
  592. auto & allowed = getPlayerInfo(player.getNum()).allowedFactions;
  593. const bool allowRandomTown = getPlayerInfo(player.getNum()).isFactionRandom;
  594. if(cur == PlayerSettings::NONE) //no change
  595. return;
  596. if(cur == PlayerSettings::RANDOM) //first/last available
  597. {
  598. if(dir > 0)
  599. cur = *allowed.begin(); //id of first town
  600. else
  601. cur = *allowed.rbegin(); //id of last town
  602. }
  603. else // next/previous available
  604. {
  605. if((cur == *allowed.begin() && dir < 0) || (cur == *allowed.rbegin() && dir > 0))
  606. {
  607. if(allowRandomTown)
  608. {
  609. cur = PlayerSettings::RANDOM;
  610. }
  611. else
  612. {
  613. if(dir > 0)
  614. cur = *allowed.begin();
  615. else
  616. cur = *allowed.rbegin();
  617. }
  618. }
  619. else
  620. {
  621. assert(dir >= -1 && dir <= 1); //othervice std::advance may go out of range
  622. auto iter = allowed.find((ui8)cur);
  623. std::advance(iter, dir);
  624. cur = *iter;
  625. }
  626. }
  627. if(s.hero >= 0 && !getPlayerInfo(player.getNum()).hasCustomMainHero()) // remove hero unless it set to fixed one in map editor
  628. {
  629. s.hero = PlayerSettings::RANDOM;
  630. }
  631. if(cur < 0 && s.bonus == PlayerSettings::RESOURCE)
  632. s.bonus = PlayerSettings::RANDOM;
  633. }
  634. void CVCMIServer::setCampaignMap(int mapId)
  635. {
  636. campaignMap = mapId;
  637. si->difficulty = si->campState->camp->scenarios[mapId].difficulty;
  638. campaignBonus = -1;
  639. updateStartInfoOnMapChange(si->campState->getMapInfo(mapId));
  640. }
  641. void CVCMIServer::setCampaignBonus(int bonusId)
  642. {
  643. campaignBonus = bonusId;
  644. const CCampaignScenario & scenario = si->campState->camp->scenarios[campaignMap];
  645. const std::vector<CScenarioTravel::STravelBonus> & bonDescs = scenario.travelOptions.bonusesToChoose;
  646. if(bonDescs[bonusId].type == CScenarioTravel::STravelBonus::HERO)
  647. {
  648. for(auto & elem : si->playerInfos)
  649. {
  650. if(elem.first == PlayerColor(bonDescs[bonusId].info1))
  651. setPlayerConnectedId(elem.second, 1);
  652. else
  653. setPlayerConnectedId(elem.second, PlayerSettings::PLAYER_AI);
  654. }
  655. }
  656. }
  657. void CVCMIServer::optionNextHero(PlayerColor player, int dir)
  658. {
  659. PlayerSettings & s = si->playerInfos[player];
  660. if(s.castle < 0 || s.hero == PlayerSettings::NONE)
  661. return;
  662. if(s.hero == PlayerSettings::RANDOM) // first/last available
  663. {
  664. int max = static_cast<int>(VLC->heroh->size()),
  665. min = 0;
  666. s.hero = nextAllowedHero(player, min, max, 0, dir);
  667. }
  668. else
  669. {
  670. if(dir > 0)
  671. s.hero = nextAllowedHero(player, s.hero, (int)VLC->heroh->size(), 1, dir);
  672. else
  673. s.hero = nextAllowedHero(player, -1, s.hero, 1, dir); // min needs to be -1 -- hero at index 0 would be skipped otherwise
  674. }
  675. }
  676. int CVCMIServer::nextAllowedHero(PlayerColor player, int min, int max, int incl, int dir)
  677. {
  678. if(dir > 0)
  679. {
  680. for(int i = min + incl; i <= max - incl; i++)
  681. if(canUseThisHero(player, i))
  682. return i;
  683. }
  684. else
  685. {
  686. for(int i = max - incl; i >= min + incl; i--)
  687. if(canUseThisHero(player, i))
  688. return i;
  689. }
  690. return -1;
  691. }
  692. void CVCMIServer::optionNextBonus(PlayerColor player, int dir)
  693. {
  694. PlayerSettings & s = si->playerInfos[player];
  695. PlayerSettings::Ebonus & ret = s.bonus = static_cast<PlayerSettings::Ebonus>(static_cast<int>(s.bonus) + dir);
  696. if(s.hero == PlayerSettings::NONE &&
  697. !getPlayerInfo(player.getNum()).heroesNames.size() &&
  698. ret == PlayerSettings::ARTIFACT) //no hero - can't be artifact
  699. {
  700. if(dir < 0)
  701. ret = PlayerSettings::RANDOM;
  702. else
  703. ret = PlayerSettings::GOLD;
  704. }
  705. if(ret > PlayerSettings::RESOURCE)
  706. ret = PlayerSettings::RANDOM;
  707. if(ret < PlayerSettings::RANDOM)
  708. ret = PlayerSettings::RESOURCE;
  709. if(s.castle == PlayerSettings::RANDOM && ret == PlayerSettings::RESOURCE) //random castle - can't be resource
  710. {
  711. if(dir < 0)
  712. ret = PlayerSettings::GOLD;
  713. else
  714. ret = PlayerSettings::RANDOM;
  715. }
  716. }
  717. bool CVCMIServer::canUseThisHero(PlayerColor player, int ID)
  718. {
  719. return VLC->heroh->size() > ID
  720. && si->playerInfos[player].castle == VLC->heroh->objects[ID]->heroClass->faction
  721. && !vstd::contains(getUsedHeroes(), ID)
  722. && mi->mapHeader->allowedHeroes[ID];
  723. }
  724. std::vector<int> CVCMIServer::getUsedHeroes()
  725. {
  726. std::vector<int> heroIds;
  727. for(auto & p : si->playerInfos)
  728. {
  729. const auto & heroes = getPlayerInfo(p.first.getNum()).heroesNames;
  730. for(auto & hero : heroes)
  731. if(hero.heroId >= 0) //in VCMI map format heroId = -1 means random hero
  732. heroIds.push_back(hero.heroId);
  733. if(p.second.hero != PlayerSettings::RANDOM)
  734. heroIds.push_back(p.second.hero);
  735. }
  736. return heroIds;
  737. }
  738. ui8 CVCMIServer::getIdOfFirstUnallocatedPlayer() const
  739. {
  740. for(auto i = playerNames.cbegin(); i != playerNames.cend(); i++)
  741. {
  742. if(!si->getPlayersSettings(i->first))
  743. return i->first;
  744. }
  745. return 0;
  746. }
  747. #if defined(__GNUC__) && !defined(__MINGW32__) && !defined(VCMI_ANDROID) && !defined(VCMI_IOS)
  748. void handleLinuxSignal(int sig)
  749. {
  750. const int STACKTRACE_SIZE = 100;
  751. void * buffer[STACKTRACE_SIZE];
  752. int ptrCount = backtrace(buffer, STACKTRACE_SIZE);
  753. char * * strings;
  754. logGlobal->error("Error: signal %d :", sig);
  755. strings = backtrace_symbols(buffer, ptrCount);
  756. if(strings == nullptr)
  757. {
  758. logGlobal->error("There are no symbols.");
  759. }
  760. else
  761. {
  762. for(int i = 0; i < ptrCount; ++i)
  763. {
  764. logGlobal->error(strings[i]);
  765. }
  766. free(strings);
  767. }
  768. _exit(EXIT_FAILURE);
  769. }
  770. #endif
  771. static void handleCommandOptions(int argc, char * argv[], boost::program_options::variables_map & options)
  772. {
  773. namespace po = boost::program_options;
  774. #ifdef SINGLE_PROCESS_APP
  775. options.emplace("run-by-client", po::variable_value{true, true});
  776. options.emplace("uuid", po::variable_value{std::string{argv[1]}, true});
  777. #else
  778. po::options_description opts("Allowed options");
  779. opts.add_options()
  780. ("help,h", "display help and exit")
  781. ("version,v", "display version information and exit")
  782. ("run-by-client", "indicate that server launched by client on same machine")
  783. ("uuid", po::value<std::string>(), "")
  784. ("enable-shm-uuid", "use UUID for shared memory identifier")
  785. ("enable-shm", "enable usage of shared memory")
  786. ("port", po::value<ui16>(), "port at which server will listen to connections from client");
  787. if(argc > 1)
  788. {
  789. try
  790. {
  791. po::store(po::parse_command_line(argc, argv, opts), options);
  792. }
  793. catch(std::exception & e)
  794. {
  795. std::cerr << "Failure during parsing command-line options:\n" << e.what() << std::endl;
  796. }
  797. }
  798. #endif
  799. po::notify(options);
  800. #ifndef SINGLE_PROCESS_APP
  801. if(options.count("help"))
  802. {
  803. auto time = std::time(0);
  804. printf("%s - A Heroes of Might and Magic 3 clone\n", GameConstants::VCMI_VERSION.c_str());
  805. printf("Copyright (C) 2007-%d VCMI dev team - see AUTHORS file\n", std::localtime(&time)->tm_year + 1900);
  806. printf("This is free software; see the source for copying conditions. There is NO\n");
  807. printf("warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n");
  808. printf("\n");
  809. std::cout << opts;
  810. exit(0);
  811. }
  812. if(options.count("version"))
  813. {
  814. printf("%s\n", GameConstants::VCMI_VERSION.c_str());
  815. std::cout << VCMIDirs::get().genHelpString();
  816. exit(0);
  817. }
  818. #endif
  819. }
  820. #ifdef SINGLE_PROCESS_APP
  821. #define main server_main
  822. #endif
  823. int main(int argc, char * argv[])
  824. {
  825. #if !defined(VCMI_ANDROID) && !defined(VCMI_IOS)
  826. // Correct working dir executable folder (not bundle folder) so we can use executable relative paths
  827. boost::filesystem::current_path(boost::filesystem::system_complete(argv[0]).parent_path());
  828. #endif
  829. // Installs a sig sev segmentation violation handler
  830. // to log stacktrace
  831. #if defined(__GNUC__) && !defined(__MINGW32__) && !defined(VCMI_ANDROID) && !defined(VCMI_IOS)
  832. signal(SIGSEGV, handleLinuxSignal);
  833. #endif
  834. #ifndef VCMI_IOS
  835. console = new CConsoleHandler();
  836. #endif
  837. CBasicLogConfigurator logConfig(VCMIDirs::get().userLogsPath() / "VCMI_Server_log.txt", console);
  838. logConfig.configureDefault();
  839. logGlobal->info(SERVER_NAME);
  840. boost::program_options::variables_map opts;
  841. handleCommandOptions(argc, argv, opts);
  842. preinitDLL(console);
  843. settings.init();
  844. logConfig.configure();
  845. loadDLLClasses();
  846. srand((ui32)time(nullptr));
  847. #ifdef SINGLE_PROCESS_APP
  848. boost::condition_variable * cond = reinterpret_cast<boost::condition_variable *>(argv[0]);
  849. cond->notify_one();
  850. #endif
  851. try
  852. {
  853. boost::asio::io_service io_service;
  854. CVCMIServer server(opts);
  855. try
  856. {
  857. while(server.state != EServerState::SHUTDOWN)
  858. {
  859. server.run();
  860. }
  861. io_service.run();
  862. }
  863. catch(boost::system::system_error & e) //for boost errors just log, not crash - probably client shut down connection
  864. {
  865. logNetwork->error(e.what());
  866. server.state = EServerState::SHUTDOWN;
  867. }
  868. catch(...)
  869. {
  870. handleException();
  871. }
  872. }
  873. catch(boost::system::system_error & e)
  874. {
  875. logNetwork->error(e.what());
  876. //catch any startup errors (e.g. can't access port) errors
  877. //and return non-zero status so client can detect error
  878. throw;
  879. }
  880. #ifdef VCMI_ANDROID
  881. CAndroidVMHelper envHelper;
  882. envHelper.callStaticVoidMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "killServer");
  883. #endif
  884. logConfig.deconfigure();
  885. vstd::clear_pointer(VLC);
  886. return 0;
  887. }
  888. #ifdef VCMI_ANDROID
  889. void CVCMIServer::create()
  890. {
  891. const char * foo[1] = {"android-server"};
  892. main(1, const_cast<char **>(foo));
  893. }
  894. #elif defined(SINGLE_PROCESS_APP)
  895. void CVCMIServer::create(boost::condition_variable * cond, const std::string & uuid)
  896. {
  897. const std::initializer_list<const void *> argv = {
  898. cond,
  899. uuid.c_str(),
  900. };
  901. main(argv.size(), reinterpret_cast<char **>(const_cast<void **>(argv.begin())));
  902. }
  903. #endif