CVCMIServer.cpp 32 KB

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