CVCMIServer.cpp 30 KB

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