OpenTTD Source  20241121-master-g67a0fccfad
network_survey.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "../stdafx.h"
11 #include "network_survey.h"
12 #include "settings_table.h"
13 #include "network.h"
14 #include "network_func.h"
15 #include "../debug.h"
16 #include "../survey.h"
17 #include "../3rdparty/fmt/chrono.h"
18 #include "../3rdparty/fmt/std.h"
19 
20 #include "../safeguards.h"
21 
22 NetworkSurveyHandler _survey = {};
23 
29 })
30 
38 std::string NetworkSurveyHandler::CreatePayload(Reason reason, bool for_preview)
39 {
40  nlohmann::json survey;
41 
42  survey["schema"] = NETWORK_SURVEY_VERSION;
43  survey["reason"] = reason;
44  survey["date"] = fmt::format("{:%Y-%m-%d %H:%M:%S} (UTC)", fmt::gmtime(time(nullptr)));
45 
46 #ifdef SURVEY_KEY
47  /* We censor the key to avoid people trying to be "clever" and use it to send their own surveys. */
48  survey["key"] = for_preview ? "(redacted)" : SURVEY_KEY;
49 #else
50  survey["key"] = "";
51 #endif
52 
53  SurveyGameSession(survey["session"]);
54 
55  {
56  auto &info = survey["info"];
57  SurveyOS(info["os"]);
58  SurveyOpenTTD(info["openttd"]);
59  SurveyConfiguration(info["configuration"]);
60  SurveyFont(info["font"]);
61  SurveyCompiler(info["compiler"]);
62  SurveyLibraries(info["libraries"]);
63  SurveyPlugins(info["plugins"]);
64  }
65 
66  {
67  auto &game = survey["game"];
68  SurveyTimers(game["timers"]);
69  SurveyCompanies(game["companies"]);
70  SurveySettings(game["settings"], false);
71  SurveyGrfs(game["grfs"]);
72  SurveyGameScript(game["game_script"]);
73  }
74 
75  /* For preview, we indent with 4 whitespaces to make things more readable. */
76  int indent = for_preview ? 4 : -1;
77  return survey.dump(indent);
78 }
79 
86 void NetworkSurveyHandler::Transmit(Reason reason, bool blocking)
87 {
88  if constexpr (!NetworkSurveyHandler::IsSurveyPossible()) {
89  Debug(net, 4, "Survey: not possible to send survey; most likely due to missing JSON library at compile-time");
90  return;
91  }
92 
94  Debug(net, 5, "Survey: user is not participating in survey; skipping survey");
95  return;
96  }
97 
98  Debug(net, 1, "Survey: sending survey results");
99  NetworkHTTPSocketHandler::Connect(NetworkSurveyUriString(), this, this->CreatePayload(reason));
100 
101  if (blocking) {
102  std::unique_lock<std::mutex> lock(this->mutex);
103 
104  /* Block no longer than 2 seconds. If we failed to send the survey in that time, so be it. */
105  std::chrono::steady_clock::time_point end = std::chrono::steady_clock::now() + std::chrono::seconds(2);
106 
107  while (!this->transmitted && std::chrono::steady_clock::now() < end) {
109  this->transmitted_cv.wait_for(lock, std::chrono::milliseconds(30));
110  }
111  }
112 }
113 
115 {
116  Debug(net, 1, "Survey: failed to send survey results");
117  this->transmitted = true;
118  this->transmitted_cv.notify_all();
119 }
120 
121 void NetworkSurveyHandler::OnReceiveData(std::unique_ptr<char[]> data, size_t)
122 {
123  if (data == nullptr) {
124  Debug(net, 1, "Survey: survey results sent");
125  this->transmitted = true;
126  this->transmitted_cv.notify_all();
127  }
128 }
static void Connect(const std::string &uri, HTTPCallback *callback, const std::string data="")
Connect to the given URI.
Definition: http_curl.cpp:93
Socket handler for the survey connection.
void OnFailure() override
An error has occurred and the connection has been closed.
@ PREVIEW
User is previewing the survey result.
@ EXIT
User is exiting the application.
@ LEAVE
User is leaving the game (but not exiting the application).
std::atomic< bool > transmitted
Whether the survey has been transmitted.
std::condition_variable transmitted_cv
Condition variable to inform changes to transmitted.
void OnReceiveData(std::unique_ptr< char[]> data, size_t length) override
We're receiving data.
std::mutex mutex
Mutex for the condition variable.
void Transmit(Reason reason, bool blocking=false)
Transmit the survey.
const char * NetworkSurveyUriString()
Get the URI string for the survey from the environment variable OTTD_SURVEY_URI, or when it has not b...
Definition: config.cpp:75
static const uint8_t NETWORK_SURVEY_VERSION
What version of the survey do we use?
Definition: config.h:51
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
void NetworkBackgroundLoop()
We have to do some (simple) background stuff that runs normally, even when we are not in multiplayer.
Definition: network.cpp:1080
Basic functions/variables used all over the place.
Network functions used by other parts of OpenTTD.
NLOHMANN_JSON_SERIALIZE_ENUM(NetworkSurveyHandler::Reason, { {NetworkSurveyHandler::Reason::PREVIEW, "preview"}, {NetworkSurveyHandler::Reason::LEAVE, "leave"}, {NetworkSurveyHandler::Reason::EXIT, "exit"}, {NetworkSurveyHandler::Reason::CRASH, "crash"}, }) std
Create the payload for the survey.
Part of the network protocol handling opt-in survey.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:56
Definition of the configuration tables of the settings.
NetworkSettings network
settings related to the network
ParticipateSurvey participate_survey
Participate in the automated survey.
void SurveySettings(nlohmann::json &survey, bool skip_if_default)
Convert settings to JSON.
Definition: survey.cpp:160
void SurveyPlugins(nlohmann::json &survey)
Convert plugin information to JSON.
Definition: survey.cpp:464
void SurveyTimers(nlohmann::json &survey)
Convert timer information to JSON.
Definition: survey.cpp:339
void SurveyGameSession(nlohmann::json &survey)
Convert game session information to JSON.
Definition: survey.cpp:238
void SurveyGameScript(nlohmann::json &survey)
Convert game-script information to JSON.
Definition: survey.cpp:382
void SurveyConfiguration(nlohmann::json &survey)
Convert generic game information to JSON.
Definition: survey.cpp:252
void SurveyOpenTTD(nlohmann::json &survey)
Convert generic OpenTTD information to JSON.
Definition: survey.cpp:206
void SurveyFont(nlohmann::json &survey)
Convert font information to JSON.
Definition: survey.cpp:295
void SurveyCompanies(nlohmann::json &survey)
Convert company information to JSON.
Definition: survey.cpp:308
void SurveyCompiler(nlohmann::json &survey)
Convert compiler information to JSON.
Definition: survey.cpp:178
void SurveyLibraries(nlohmann::json &survey)
Convert compiled libraries information to JSON.
Definition: survey.cpp:394
void SurveyGrfs(nlohmann::json &survey)
Convert GRF information to JSON.
Definition: survey.cpp:355
std::mutex lock
synchronization for playback status fields
Definition: win32_m.cpp:35