Moved the rest of players.helpers to C++

Author: Ayuto

addons/source-python/packages/source-python/players/helpers.py

@@ -18,6 +18,7 @@
 # =============================================================================
 # Source.Python Imports
 #   Players
+from _players._helpers import address_from_playerinfo
 from _players._helpers import baseentity_from_playerinfo
 from _players._helpers import baseentity_from_userid
 from _players._helpers import basehandle_from_playerinfo
@@ -27,6 +28,8 @@
 from _players._helpers import index_from_playerinfo
 from _players._helpers import index_from_userid
 from _players._helpers import index_from_name
+from _players._helpers import index_from_steamid
+from _players._helpers import index_from_uniqueid
 from _players._helpers import inthandle_from_playerinfo
 from _players._helpers import inthandle_from_userid
 from _players._helpers import playerinfo_from_baseentity
@@ -45,6 +48,8 @@
 from _players._helpers import userid_from_inthandle
 from _players._helpers import userid_from_playerinfo
 from _players._helpers import userid_from_pointer
+from _players._helpers import uniqueid_from_index
+from _players._helpers import uniqueid_from_playerinfo
 
 
 # =============================================================================
@@ -84,117 +89,3 @@
            'userid_from_playerinfo',
            'userid_from_pointer',
            )
-
-
-# =============================================================================
-# >> OTHER HELPER FUNCTIONS
-# =============================================================================
-def index_from_steamid(steamid):
-    """Return an index from the given SteamID.
-
-    :param str steamid: The SteamID to get the index of.
-    :rtype: int
-    """
-    # Loop through all players on the server
-    for edict in PlayerGenerator():
-
-        # Get the PlayerInfo instance of the player...
-        playerinfo = playerinfo_from_edict(edict)
-
-        # Is the current player's SteamID the same as the one given?
-        if playerinfo.steamid == steamid:
-
-            # Return the index of the current player
-            return index_from_playerinfo(playerinfo)
-
-    raise ValueError(
-        'Conversion from "SteamID" ({}) to "Index" failed.'.format(steamid))
-
-
-def index_from_uniqueid(uniqueid):
-    """Return an index from the given UniqueID.
-
-    :param str uniqueid: The UniqueID to get the index of.
-    :rtype: int
-    """
-    # Loop through all players on the server
-    for edict in PlayerGenerator():
-
-        # Get the PlayerInfo instance of the player...
-        playerinfo = playerinfo_from_edict(edict)
-
-        # Is the current player's UniqueID the same as the one given?
-        if uniqueid_from_playerinfo(playerinfo) == uniqueid:
-
-            # Return the index of the current player
-            return index_from_playerinfo(playerinfo)
-
-    raise ValueError(
-        'Conversion from "UniqueID" ({}) to "Index" failed.'.format(uniqueid))
-
-
-def uniqueid_from_playerinfo(playerinfo):
-    """Return the UniqueID for the given player.
-
-    :param PlayerInfo playerinfo: The PlayerInfo
-        instance to get the UniqueID from.
-    :return: The UniqueID of the player. E.g. 'BOT_STAN' or 'STEAM_0:0:12345'
-    :rtype: str
-    """
-    # Is the player a Bot?
-    if playerinfo.is_fake_client() or 'BOT' in playerinfo.steamid:
-
-        # Return the bot's UniqueID
-        return 'BOT_{0}'.format(playerinfo.name)
-
-    # Get the player's SteamID
-    steamid = playerinfo.steamid
-
-    # Is this a Lan SteamID?
-    if 'LAN' in steamid:
-
-        # Get the player's IP address
-        address = address_from_playerinfo(playerinfo)
-
-        # Return the Lan player's ID
-        return 'LAN_{0}'.format('_'.join(address.split(':')[0].split('.')))
-
-    # Return the player's SteamID
-    return steamid
-
-
-def uniqueid_from_index(index):
-    """Return the UniqueID for the given player index.
-
-    :param int index: The player index to get the UniqueID from.
-    :return: The UniqueID of the player. E.g. 'BOT_STAN' or 'STEAM_0:0:12345'
-    :rtype: str
-    """
-    return uniqueid_from_playerinfo(playerinfo_from_index(index))
-
-
-def address_from_playerinfo(playerinfo):
-    """Return the IP address for the given player.
-
-    If the player is a bot, an empty string will be returned.
-
-    :param PlayerInfo playerinfo: The PlayerInfo
-        instance to get the UniqueID from.
-    :return: The IP address. E.g. '127.0.0.1:27015'
-    :rtype: str
-    """
-    # Is the player a bot?
-    if playerinfo.is_fake_client() or 'BOT' in playerinfo.steamid:
-
-        # Return an empty string, since using <netinfo>.address crashes
-        # with bots
-        return ''
-
-    # Get the player's index
-    index = index_from_playerinfo(playerinfo)
-
-    # Get the player's NetInfo instance
-    netinfo = engine_server.get_player_net_info(index)
-
-    # Return the player's IP Address
-    return netinfo.address

src/CMakeLists.txt

@@ -65,6 +65,8 @@ Set(SOURCEPYTHON_UTILITIES_SOURCES
     core/utilities/conversions/playerinfo_from.cpp
     core/utilities/conversions/pointer_from.cpp
     core/utilities/conversions/userid_from.cpp
+    core/utilities/conversions/address_from.cpp
+    core/utilities/conversions/uniqueid_from.cpp
 )
 
 Set(SOURCEPYTHON_UTILITIES_FILES

src/core/modules/players/players_helpers_wrap.cpp

@@ -59,6 +59,7 @@ void export_player_conversion_functions(scope _helpers)
 	EXPORT_CONVERSION_FUNCTION(unsigned int, Index, IPlayerInfo *, PlayerInfo);
 	EXPORT_CONVERSION_FUNCTION(unsigned int, Index, const char *, Name);
 	EXPORT_CONVERSION_FUNCTION(unsigned int, Index, const char *, SteamID);
+	EXPORT_CONVERSION_FUNCTION(unsigned int, Index, const char *, UniqueID);
 
 	// To Edict conversions...
 	EXPORT_CONVERSION_FUNCTION(edict_t *, Edict, unsigned int, Userid, reference_existing_object_policy());
@@ -97,4 +98,11 @@ void export_player_conversion_functions(scope _helpers)
 	// To BaseEntity conversions...
 	EXPORT_CONVERSION_FUNCTION(CBaseEntity *, BaseEntity, unsigned int, Userid, return_by_value_policy());
 	EXPORT_CONVERSION_FUNCTION(CBaseEntity *, BaseEntity, IPlayerInfo *, PlayerInfo, return_by_value_policy());
+
+	// To Address conversions...
+	EXPORT_CONVERSION_FUNCTION(const char *, Address, IPlayerInfo *, PlayerInfo);
+
+	// To UniqueID conversions...
+	EXPORT_CONVERSION_FUNCTION(str, UniqueID, IPlayerInfo *, PlayerInfo);
+	EXPORT_CONVERSION_FUNCTION(str, UniqueID, unsigned int, Index);
 }

src/core/utilities/conversions.h

@@ -213,6 +213,7 @@ bool IndexFromUserid( unsigned int iUserID, unsigned int& output );
 bool IndexFromPlayerInfo( IPlayerInfo *pPlayerInfo, unsigned int& output );
 bool IndexFromName( const char *szName, unsigned int& output );
 bool IndexFromSteamID( const char* szSteamID, unsigned int& output );
+bool IndexFromUniqueID( const char* szUniqueID, unsigned int& output );
 
 CREATE_EXC_CONVERSION_FUNCTION(unsigned int, Index, edict_t *, Edict);
 CREATE_EXC_CONVERSION_FUNCTION(unsigned int, Index, CBaseHandle, BaseHandle);
@@ -223,6 +224,7 @@ CREATE_EXC_CONVERSION_FUNCTION(unsigned int, Index, unsigned int, Userid);
 CREATE_EXC_CONVERSION_FUNCTION(unsigned int, Index, IPlayerInfo *, PlayerInfo);
 CREATE_EXC_CONVERSION_FUNCTION(unsigned int, Index, const char *, Name);
 CREATE_EXC_CONVERSION_FUNCTION(unsigned int, Index, const char *, SteamID);
+CREATE_EXC_CONVERSION_FUNCTION(unsigned int, Index, const char *, UniqueID);
 
 
 //-----------------------------------------------------------------------------
@@ -265,6 +267,27 @@ CREATE_EXC_CONVERSION_FUNCTION(CPointer, Pointer, unsigned int, Userid);
 CREATE_EXC_CONVERSION_FUNCTION(CPointer, Pointer, IPlayerInfo *, PlayerInfo);
 
 
+//-----------------------------------------------------------------------------
+// AddressFrom* declarations
+//-----------------------------------------------------------------------------
+bool AddressFromPlayerInfo( IPlayerInfo* pInfo, const char*& output );
+
+CREATE_EXC_CONVERSION_FUNCTION(const char*, Address, IPlayerInfo *, PlayerInfo);
+
+
+//-----------------------------------------------------------------------------
+// UniqueIDFrom* declarations
+//-----------------------------------------------------------------------------
+#define UNIQUE_ID_SIZE 128
+
+bool UniqueIDFromPlayerInfo2( IPlayerInfo* pInfo, char*& output );
+bool UniqueIDFromPlayerInfo( IPlayerInfo* pInfo, str& output );
+bool UniqueIDFromIndex( unsigned int iIndex, str& output );
+
+CREATE_EXC_CONVERSION_FUNCTION(str, UniqueID, IPlayerInfo *, PlayerInfo);
+CREATE_EXC_CONVERSION_FUNCTION(str, UniqueID, unsigned int, Index);
+
+
 //-----------------------------------------------------------------------------
 // Helper functions
 //-----------------------------------------------------------------------------

src/core/utilities/conversions/address_from.cpp

@@ -0,0 +1,58 @@
+/**
+* =============================================================================
+* Source Python
+* Copyright (C) 2012-2015 Source Python Development Team.  All rights reserved.
+* =============================================================================
+*
+* This program is free software; you can redistribute it and/or modify it under
+* the terms of the GNU General Public License, version 3.0, as published by the
+* Free Software Foundation.
+*
+* This program 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.  See the GNU General Public License for more
+* details.
+*
+* You should have received a copy of the GNU General Public License along with
+* this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+* As a special exception, the Source Python Team gives you permission
+* to link the code of this program (as well as its derivative works) to
+* "Half-Life 2," the "Source Engine," and any Game MODs that run on software
+* by the Valve Corporation.  You must obey the GNU General Public License in
+* all respects for all other code used.  Additionally, the Source.Python
+* Development Team grants this exception to all derivative works.
+*/
+
+//-----------------------------------------------------------------------------
+// Includes.
+//-----------------------------------------------------------------------------
+#include "../conversions.h"
+#include "inetchannelinfo.h"
+
+
+//-----------------------------------------------------------------------------
+// Returns an address from the given PlayerInfo instance.
+//-----------------------------------------------------------------------------
+bool AddressFromPlayerInfo( IPlayerInfo* pInfo, const char*& output )
+{
+	if (!pInfo)
+		return false;
+
+	if (pInfo->IsFakeClient() || V_strstr(pInfo->GetNetworkIDString(), "BOT"))
+	{
+		output = "";
+		return true;
+	}
+
+	unsigned int index;
+	if (!IndexFromPlayerInfo(pInfo, index))
+		return false;
+
+	INetChannelInfo* netinfo = engine->GetPlayerNetInfo(index);
+	if (!netinfo)
+		return false;
+
+	output = netinfo->GetAddress();
+	return true;
+}

src/core/utilities/conversions/index_from.cpp

@@ -205,3 +205,30 @@ bool IndexFromSteamID( const char* szSteamID, unsigned int& output )
 
 	return false;
 }
+
+
+//-----------------------------------------------------------------------------
+// Returns an index instance from the given SteamID.
+//-----------------------------------------------------------------------------
+bool IndexFromUniqueID( const char* szUniqueID, unsigned int& output )
+{
+	for (unsigned int i=1; i <= (unsigned int) gpGlobals->maxClients; ++i)
+	{
+		IPlayerInfo* pInfo = NULL;
+		if (!PlayerInfoFromIndex(i, pInfo))
+			continue;
+		
+		char szTempUniqueID[UNIQUE_ID_SIZE] = "";
+		char* pTempUniqueID = (char*) szTempUniqueID;
+		if (!UniqueIDFromPlayerInfo2(pInfo, pTempUniqueID))
+			continue;
+
+		if (V_strcmp(szUniqueID, pTempUniqueID) == 0)
+		{
+			output = i;
+			return true;
+		}
+	}
+
+	return false;
+}