Custom.cfg (#213)

Added custom configs.

These are used for replacing some hardcoded strings inside bot code, currently custom cvar for parachute detection is available, as well as custom c4 model names.

Added editorconfig, and fixed CRLF for files (was a mix between LF & CRLF).
Fixed use-after-free sanitizer error with chatlib.
Fixed configs files loaded with memory-loader does not process last line in config files.

.editorconfig

@@ -0,0 +1,10 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 3
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

cfg/addons/yapb/conf/custom.cfg

@@ -0,0 +1,22 @@
+;
+; @package: YaPB
+; @version: 4.2
+; @author: YaPB Development Team
+; @filename: yapb.cfg
+; 
+; Custom configuration file, allow to change some hardcoded stuff in bot code.
+;
+
+;
+; Custom name for C4 model, for servers that replacing C4 model with it's own.
+; By default it's "c4.mdl" (the models/ path is omitted), so if you need to use
+; "models/mybomb/mybomb.mdl", you should specify "mybomb/mybomb.mdl".
+;
+C4ModelName = c4.mdl
+
+;
+; Custon cvar name for parachute handling, there are all the different plugins that
+; handles parachute (AMX Parachute, AMX Parachute Lite, etc..), you can specify needed
+; cvar here.
+;
+AMXParachuteCvar = sv_parachute

cfg/addons/yapb/conf/lang/ru_lang.cfg

@@ -1994,9 +1994,3 @@ You're launched standalone version of %s. Metamod is not installed or not enable
 
 [TRANSLATED]
 Вы запустили автономную версию %s. Metamod не установлен или не включён!
-
-[ORIGINAL]
-EndOfFile
-
-[TRANSLATED]
-EndOfFile

ext/crlib/cr-detour.h

@@ -1,4 +1,4 @@
-//
+//
 // YaPB - Counter-Strike Bot based on PODBot by Markus Klinge.
 // Copyright © 2004-2020 YaPB Project <yapb@jeefo.net>.
 //

ext/crlib/cr-files.h

@@ -71,6 +71,8 @@ public:
       int ch = 0;
       SmallArray <char> data (255);
 
+      line.clear ();
+
       while ((ch = get ()) != EOF && !eof ()) {
          data.push (static_cast <char> (ch));
 
@@ -78,9 +80,10 @@ public:
             break;
          }
       }
+      if (!data.empty ()) {
          line.assign (data.data (), data.length ());
-
-      return !eof ();
+      }
+      return !line.empty ();
    }
 
    template <typename ...Args> size_t puts (const char *fmt, Args &&...args) {
@@ -282,10 +285,7 @@ public:
       if (!contents_ || seek_ >= length_) {
          return Eof;
       }
-      auto ch = contents_[seek_];
-      ++seek_;
-
-      return static_cast <char> (ch);
+      return static_cast <char> (contents_[seek_++]);
    }
 
    char *getString (char *buffer, size_t count) {
@@ -315,16 +315,20 @@ public:
       char ch;
       SmallArray <char> data (255);
 
-      while ((ch = get ()) != Eof) {
+      line.clear ();
+
+      while ((ch = get ()) != Eof && !eof ()) {
          data.push (ch);
 
          if (ch == '\n') {
             break;
          }
       }
-      line.assign (data.data (), data.length ());
 
-      return !eof ();
+      if (!data.empty ()) {
+         line.assign (data.data (), data.length ());
+      }
+      return !line.empty ();
    }
 
    size_t read (void *buffer, size_t size, size_t count = 1) {

ext/crlib/cr-http.h

@@ -111,7 +111,6 @@ CR_DECLARE_SCOPED_ENUM (HttpClientResult,
 
 CR_NAMESPACE_BEGIN
 
-
 namespace detail {
 
    // simple http uri omitting query-string and port
@@ -281,12 +280,10 @@ private:
    String userAgent_ = "crlib";
    HttpClientResult statusCode_ = HttpClientResult::Undefined;
    int32 chunkSize_ = 4096;
+   bool initialized_ = false;
 
 public:
-   HttpClient () {
-      detail::SocketInit::start ();
-   }
-
+   HttpClient () = default;
    ~HttpClient () = default;
 
 private:
@@ -333,9 +330,17 @@ private:
    }
 
 public:
+   void startup () {
+      detail::SocketInit::start ();
+      initialized_ = true;
+   }
 
    // simple blocked download
    bool downloadFile (StringRef url, StringRef localPath, int32 timeout = DefaultSocketTimeout) {
+      if (plat.win && !initialized_) {
+         plat.abort ("Sockets not initialized.");
+      }
+
       if (File::exists (localPath)) {
          statusCode_ = HttpClientResult::LocalFileExists;
          return false;
@@ -402,6 +407,10 @@ public:
    }
 
    bool uploadFile (StringRef url, StringRef localPath, const int32 timeout = DefaultSocketTimeout) {
+      if (plat.win && !initialized_) {
+         plat.abort ("Sockets not initialized.");
+      }
+
       if (!File::exists (localPath)) {
          statusCode_ = HttpClientResult::NoLocalFile;
          return false;

inc/config.h

@@ -51,6 +51,7 @@ private:
 
    HashMap <uint32, String, Hash <int32>> m_language;
    HashMap <int32, DifficultyData> m_difficulty;
+   HashMap <String, String> m_custom;
 
    // default tables for personality weapon preferences, overridden by weapon.cfg
    SmallArray <int32> m_normalWeaponPrefs = { 0, 2, 1, 4, 5, 6, 3, 12, 10, 24, 25, 13, 11, 8, 7, 22, 23, 18, 21, 17, 19, 15, 17, 9, 14, 16 };
@@ -98,6 +99,9 @@ public:
    // loads bots map-specific config
    void loadMapSpecificConfig ();
 
+   // loads custom config
+   void loadCustomConfig ();
+
    // sets memfile to use engine functions
    void setupMemoryFiles ();
 
@@ -119,6 +123,9 @@ public:
    // translates bot message into needed language
    const char *translate (StringRef input);
 
+   // display current custom values
+   void showCustomValues ();
+
 private:
    bool isCommentLine (StringRef line) const {
       if (line.empty ()) {
@@ -237,6 +244,21 @@ public:
    StringRef getRandomLogoName (int index) {
       return m_logos[index];
    }
+
+   // get custom value
+   StringRef fetchCustom (StringRef name) {
+      if (m_custom.has (name)) {
+         return m_custom[name];
+      }
+      SimpleLogger::instance ().error ("Trying to fetch uknonwn custom variable: %s", name);
+
+      return "";
+   }
+
+   // simple accessor to c4 model name
+   StringRef getBombModelName () {
+      return fetchCustom ("C4ModelName");
+   }
 };
 
 // explose global

inc/control.h

@@ -99,6 +99,7 @@ private:
    int cmdMenu ();
    int cmdList ();
    int cmdCvars ();
+   int cmdShowCustom ();
    int cmdNode ();
    int cmdNodeOn ();
    int cmdNodeOff ();

inc/support.h

@@ -108,6 +108,10 @@ public:
 
    // check if object inside frustum plane
    bool isObjectInsidePlane (FrustumPlane &plane, const Vector &center, float height, float radius);
+
+   // checks if same model ommiting the models directory
+   bool isModel (const edict_t *ent, StringRef model);
+
 public:
 
    // re-show welcome after changelevel ?

inc/version.h

@@ -14,6 +14,6 @@
 #define MODULE_BUILD_MACHINE "localhost"
 #define MODULE_BUILD_COMPILER "unknown"
 
-#define MODULE_BOT_VERSION "4.1"
-#define MODULE_BOT_VERSION_FILE 4,0,0,000
+#define MODULE_BOT_VERSION "4.2"
+#define MODULE_BOT_VERSION_FILE 4,2,0,000
 #define MODULE_BOT_BUILD_ID "0:0"

meson.build

@@ -9,7 +9,7 @@ project (
    'yapb',
    'cpp',
     
-    version: '4.1',
+   version: '4.2',
    license: 'MIT',
     
    default_options: [
@@ -205,7 +205,6 @@ if isWindows and (isVC or isIntel)
          '/Oy',
          '/Oi'
       ]
-        
       ldflags += '/LTCG'
    endif
     

package.py

@@ -1,4 +1,5 @@
-#
+# -*- coding: utf-8 -*-#
+
 # YaPB - Counter-Strike Bot based on PODBot by Markus Klinge.
 # Copyright © 2004-2020 YaPB Project <yapb@jeefo.net>.
 #

src/botlib.cpp

@@ -572,7 +572,7 @@ void Bot::updatePickups () {
             allowPickup = true;
             pickupType = Pickup::DefusalKit;
          }
-         else if (strncmp ("grenade", classname, 7) == 0 && strcmp (model, "c4.mdl") == 0) {
+         else if (strncmp ("grenade", classname, 7) == 0 && conf.getBombModelName () == model) {
             allowPickup = true;
             pickupType = Pickup::PlantedC4;
          }
@@ -2888,7 +2888,7 @@ void Bot::checkDarkness () {
 }
 
 void Bot::checkParachute () {
-   static auto parachute = engfuncs.pfnCVarGetPointer ("sv_parachute");
+   static auto parachute = engfuncs.pfnCVarGetPointer (conf.fetchCustom ("AMXParachuteCvar").chars ());
 
    // if no cvar or it's not enabled do not bother
    if (parachute && parachute->value > 0.0f) {
@@ -5460,7 +5460,7 @@ edict_t *Bot::correctGrenadeVelocity (const char *model) {
    edict_t *result = nullptr;
 
    game.searchEntities ("classname", "grenade", [&] (edict_t *ent) {
-      if (ent->v.owner == this->ent () && strcmp (ent->v.model.chars (9), model) == 0) {
+      if (ent->v.owner == this->ent () && util.isModel (ent, model)) {
          result = ent;
 
          // set the correct velocity for the grenade

src/chatlib.cpp

@@ -144,7 +144,7 @@ void Bot::prepareChatMessage (StringRef message) {
    }
 
    // get the humanized name out of client
-   auto humanizedName = [] (int index) -> StringRef {
+   auto humanizedName = [] (int index) -> String {
       auto ent = game.playerOfIndex (index);
 
       if (!util.isPlayer (ent)) {
@@ -157,7 +157,7 @@ void Bot::prepareChatMessage (StringRef message) {
    };
 
    // find highfrag player
-   auto getHighfragPlayer = [&] () -> StringRef {
+   auto getHighfragPlayer = [&] () -> String {
       int highestFrags = -1;
       int index = 0;
 
@@ -178,7 +178,7 @@ void Bot::prepareChatMessage (StringRef message) {
    };
 
    // get roundtime
-   auto getRoundTime = [] () -> StringRef {
+   auto getRoundTime = [] () -> String {
       auto roundTimeSecs = static_cast <int> (bots.getRoundEndTime () - game.time ());
       
       String roundTime;
@@ -188,12 +188,12 @@ void Bot::prepareChatMessage (StringRef message) {
    };
 
    // get bot's victim
-   auto getMyVictim = [&] () -> StringRef {;
+   auto getMyVictim = [&] () -> String {;
       return humanizedName (game.indexOfPlayer (m_lastVictim));
    };
 
    // get the game name alias
-   auto getGameName = [] () -> StringRef {
+   auto getGameName = [] () -> String {
       String gameName;
 
       if (game.is (GameFlags::ConditionZero)) {
@@ -216,7 +216,7 @@ void Bot::prepareChatMessage (StringRef message) {
    };
 
    // get enemy or teammate alive
-   auto getPlayerAlive = [&] (bool needsEnemy) -> StringRef {
+   auto getPlayerAlive = [&] (bool needsEnemy) -> String {
       for (const auto &client : util.getClients ()) {
          if (!(client.flags & ClientFlags::Used) || !(client.flags & ClientFlags::Alive) || client.ent == ent ()) {
             continue;

src/config.cpp

@@ -1,6 +1,6 @@
 //
 // YaPB - Counter-Strike Bot based on PODBot by Markus Klinge.
-// Copyright Š 2004-2020 YaPB Project <yapb@jeefo.net>.
+// Copyright © 2004-2020 YaPB Project <yapb@jeefo.net>.
 //
 // SPDX-License-Identifier: MIT
 //
@@ -28,6 +28,7 @@ void BotConfig::loadConfigs () {
    loadLogosConfig ();
    loadAvatarsConfig ();
    loadDifficultyConfig ();
+   loadCustomConfig ();
 }
 
 void BotConfig::loadMainConfig (bool isFirstLoad) {
@@ -614,6 +615,38 @@ void BotConfig::loadMapSpecificConfig () {
    }
 }
 
+void BotConfig::loadCustomConfig () {
+   String line;
+   MemFile file;
+
+   m_custom["C4ModelName"] = "c4.mdl";
+   m_custom["AMXParachuteCvar"] = "sv_parachute";
+
+   // custom inititalization
+   if (util.openConfig ("custom.cfg", "Custom config file not found. Loading defaults.", &file)) {
+      m_custom.clear ();
+
+      while (file.getLine (line)) {
+         line.trim ();
+
+         if (isCommentLine (line)) {
+            continue;
+         }
+         auto values = line.split ("=");
+
+         if (values.length () != 2) {
+            logger.error ("Bad configuration for custom.cfg");
+            return;
+         }
+         auto kv = Twin <String, String> (values[0].trim (), values[1].trim ());
+
+         if (!kv.first.empty () && !kv.second.empty ()) {
+            m_custom[kv.first] = kv.second;
+         }
+      }
+   }
+}
+
 void BotConfig::loadLogosConfig () {
    setupMemoryFiles ();
 
@@ -750,6 +783,14 @@ const char *BotConfig::translate (StringRef input) {
    return input.chars (); // nothing found
 }
 
+void BotConfig::showCustomValues () {
+   game.print ("Current values for custom config items:");
+
+   m_custom.foreach ([&](const String &key, const String &val) {
+      game.print ("  %s = %s", key, val);
+   });
+}
+
 uint32 BotConfig::hashLangString (StringRef str) {
    auto test = [] (const char ch) {
       return  (ch >= '0' && ch <= '9') || (ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z');

src/control.cpp

@@ -262,6 +262,14 @@ int BotControl::cmdCvars () {
    return BotCommandResult::Handled;
 }
 
+int BotControl::cmdShowCustom () {
+   enum args { alias = 1 };
+
+   conf.showCustomValues ();
+
+   return BotCommandResult::Handled;
+}
+
 int BotControl::cmdNode () {
    enum args { root, alias, cmd, cmd2 };
 
@@ -1895,6 +1903,7 @@ BotControl::BotControl () {
    m_cmds.emplace ("list/listbots", "list [noarguments]", "Lists the bots currently playing on server.", &BotControl::cmdList);
    m_cmds.emplace ("graph/g/wp/wpt/waypoint", "graph [help]", "Handles graph operations.", &BotControl::cmdNode);
    m_cmds.emplace ("cvars", "cvars [save|cvar]", "Display all the cvars with their descriptions.", &BotControl::cmdCvars);
+   m_cmds.emplace ("show_custom", "show_custom [noarguments]", "Show's the curent values from custom.cfg.", &BotControl::cmdShowCustom);
 
    // declare the menus
    createMenus ();

src/engine.cpp

@@ -799,6 +799,9 @@ bool Game::postload () {
    // set out user agent for http stuff
    http.setUserAgent (strings.format ("%s/%s", product.name, product.version));
 
+   // startup the sockets
+   http.startup ();
+
    // set the app name
    plat.setAppName (product.name.chars ());
 

src/graph.cpp

@@ -2806,9 +2806,10 @@ void BotGraph::setBombOrigin (bool reset, const Vector &pos) {
       return;
    }
    bool wasFound = false;
+   auto bombModel = conf.getBombModelName ();
    
    game.searchEntities ("classname", "grenade", [&] (edict_t *ent) {
-      if (strcmp (ent->v.model.chars (9), "c4.mdl") == 0) {
+      if (util.isModel (ent, bombModel)) {
          m_bombOrigin = game.getEntityWorldOrigin (ent);
          wasFound = true;
 

src/manager.cpp

@@ -1628,10 +1628,13 @@ void BotManager::updateActiveGrenade () {
    }
    m_activeGrenades.clear (); // clear previously stored grenades
 
+   // need to ignore bomb model in active grenades...
+   auto bombModel = conf.getBombModelName ();
+
    // search the map for any type of grenade
    game.searchEntities ("classname", "grenade", [&] (edict_t *e) {
       // do not count c4 as a grenade
-      if (strcmp (e->v.model.chars (9), "c4.mdl") != 0) { 
+      if (!util.isModel (e, bombModel)) {
          m_activeGrenades.push (e);
       }
       return EntitySearchResult::Continue; // continue iteration

src/navigate.cpp

@@ -17,7 +17,7 @@ int Bot::findBestGoal () {
       int result = kInvalidNodeIndex;
 
       game.searchEntities ("classname", "weaponbox", [&] (edict_t *ent) {
-         if (strcmp (ent->v.model.chars (9), "backpack.mdl") == 0) {
+         if (util.isModel (ent, "backpack.mdl")) {
             result = graph.getNearest (game.getEntityWorldOrigin (ent));
 
             if (graph.exists (result)) {
@@ -2965,11 +2965,13 @@ int Bot::getNearestToPlantedBomb () {
    if (!game.mapIs (MapFlags::Demolition)) {
       return kInvalidNodeIndex; // don't search for bomb if the player is CT, or it's not defusing bomb
    }
-   int result = kInvalidNodeIndex;
+
+   auto bombModel = conf.getBombModelName ();
+   auto result = kInvalidNodeIndex;
 
    // search the bomb on the map
-   game.searchEntities ("classname", "grenade", [&result] (edict_t *ent) {
-      if (strcmp (ent->v.model.chars (9), "c4.mdl") == 0) {
+   game.searchEntities ("classname", "grenade", [&result, &bombModel] (edict_t *ent) {
+      if (util.isModel (ent, bombModel)) {
          result = graph.getNearest (game.getEntityWorldOrigin (ent));
 
          if (graph.exists (result)) {

src/support.cpp

@@ -687,6 +687,10 @@ bool BotSupport::isObjectInsidePlane (FrustumPlane &plane, const Vector &center,
    return isPointInsidePlane (top) || isPointInsidePlane (bottom);
 }
 
+bool BotSupport::isModel (const edict_t *ent, StringRef model) {
+   return model == ent->v.model.chars (9);
+}
+
 int32 BotSupport::sendTo (int socket, const void *message, size_t length, int flags, const sockaddr *dest, int destLength) {
    const auto send = [&] (const Twin <const uint8 *, size_t> &msg) -> int32 {
       return Socket::sendto (socket, msg.first, msg.second, flags, dest, destLength);