src/network/core/config.cpp

   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
   8 /**
   9  * @file config.cpp Configuration of the connection strings for network stuff using environment variables.
  10  */
  11
  12 #include "../../stdafx.h"
  13
  14 #include "../../string_func.h"
  15
  16 #include "../../safeguards.h"
  17
  18 /**
  19  * Get the environment variable using std::getenv and when it is an empty string (or nullptr), return a fallback value instead.
  20  * @param variable The environment variable to read from.
  21  * @param fallback The fallback in case the environment variable is not set.
  22  * @return The environment value, or when that does not exist the given fallback value.
  23  */
  24 static const char *GetEnv(const char *variable, const char *fallback)
  25 {
  26         const char *value = std::getenv(variable);
  27         return StrEmpty(value) ? fallback : value;
  28 }
  29
  30 /**
  31  * Get the connection string for the game coordinator from the environment variable OTTD_COORDINATOR_CS,
  32  * or when it has not been set a hard coded default DNS hostname of the production server.
  33  * @return The game coordinator's connection string.
  34  */
  35 const char *NetworkCoordinatorConnectionString()
  36 {
  37         return GetEnv("OTTD_COORDINATOR_CS", "coordinator.openttd.org");
  38 }
  39
  40 /**
  41  * Get the connection string for the STUN server from the environment variable OTTD_STUN_CS,
  42  * or when it has not been set a hard coded default DNS hostname of the production server.
  43  * @return The STUN server's connection string.
  44  */
  45 const char *NetworkStunConnectionString()
  46 {
  47         return GetEnv("OTTD_STUN_CS", "stun.openttd.org");
  48 }
  49
  50 /**
  51  * Get the connection string for the content server from the environment variable OTTD_CONTENT_SERVER_CS,
  52  * or when it has not been set a hard coded default DNS hostname of the production server.
  53  * @return The content server's connection string.
  54  */
  55 const char *NetworkContentServerConnectionString()
  56 {
  57         return GetEnv("OTTD_CONTENT_SERVER_CS", "content.openttd.org");
  58 }
  59
  60 /**
  61  * Get the URI string for the content mirror from the environment variable OTTD_CONTENT_MIRROR_URI,
  62  * or when it has not been set a hard coded URI of the production server.
  63  * @return The content mirror's URI string.
  64  */
  65 const char *NetworkContentMirrorUriString()
  66 {
  67         return GetEnv("OTTD_CONTENT_MIRROR_URI", "https://binaries.openttd.org/bananas");
  68 }
  69
  70 /**
  71  * Get the URI string for the survey from the environment variable OTTD_SURVEY_URI,
  72  * or when it has not been set a hard coded URI of the production server.
  73  * @return The survey's URI string.
  74  */
  75 const char *NetworkSurveyUriString()
  76 {
  77         return GetEnv("OTTD_SURVEY_URI", "https://survey-participate.openttd.org/");
  78 }