Remove usages of Game.convertIpToString and mark as deprecated

[ranisalt]

Pull Request Prelude

• I have followed proper The Forgotten Server code styling.
• I have read and understood the contribution guidelines before making this PR.
• I am aware that this PR may be closed if the above-mentioned criteria are not fulfilled.

Changes Proposed

Fixes a backwards-incompatibility introduced in #3952 where there are still some functions around that expect numeric IPs, which are not available anymore. Since most of the time the IP comes from player:getIP(), which returns string values, this function can be skipped, but if they come from somewhere else it will still try to convert the number.

Issues addressed:
#4274

[Zbizu]

you have a nil value there, variable masked no longer exists within this function scope after your changes

[MillhioreBT]

should look something like this right?

function getPlayersByIPAddress(ip, mask)
	local players = {}
	if type(ip) == "string" then
		for _, player in ipairs(Game.getPlayers()) do
			if player:getIp() == ip then
				players[#players + 1] = player:getId()
			end
		end
	else
		if not mask then mask = 0xFFFFFFFF end
		local masked = bit.band(ip, mask)
		for _, player in ipairs(Game.getPlayers()) do
			if bit.band(player:getIp(), mask) == masked then
				players[#players + 1] = player:getId()
			end
		end
	end
	return players
end

[xmish]

@MillhioreBT Would be nice to have some function to convert string IP to numeric so mask would also be applied for strings. But anyway as there's IPv6 support (#3952) it should handle prefixes too ("subnet mask").

[xmish]

But actually as this is a only for compatibility it should be okay to accept numeric input only as all usecases in user scripts are numeric*.
One problem is comparison player:getIp() (string) with ip (number) and another is IPv6 prefix masks.

(*) But also return types of getIPByPlayerName/getIpByName were changed from number to string so it's no longer valid that getPlayersByIPAddress would always get numeric IP's.

[ranisalt]

@xmish yes, that's the reasoning. I just kept this compatibility of accepting numeric IPs for the extremely unlikely, but definitely possible scenario where someone manually blocked an IP by hardcoding it.

[ranisalt]

@Zbizu hope it is good enough now 😅

[omarcopires]

The advantage is that the error no longer happens, however the ip appears as follows:

[ranisalt]

@omarcopires does this print just the return value of player:getIp(), or are you still calling Game.convertIpToString()?

[omarcopires]

@omarcopires does this print just the return value of player:getIp(), or are you still calling Game.convertIpToString()?

I'm using the code as in your branch, I didn't make any changes.

[xmish]

The advantage is that the error no longer happens, however the ip appears as follows:

However it's valid representation of IPv4, see: RFC4291.
It's what you get of boost::asio::ip::address::to_string, Solution I've found:

    boost::asio::ip::address addr{boost::asio::ip::make_address("::ffff:127.0.0.1")};
    boost::asio::ip::address_v6 ipv6 = addr.to_v6(); // convert to address_v6 
    if (ipv6.is_v4_mapped()) {
        auto ipv4 = ipv6.to_v4();
        std::string str = ipv4.to_string(); // 127.0.0.1
    }

[ranisalt]

I'm using the code as in your branch, I didn't make any changes.

As @xmish pointed out, that's a valid IP, and your server console is printing that the function has been deprecated, where it has been called (filename and line), and that you should skip calling it instead. What do you think, is this enough information for the server owner?

[omarcopires]

I'm using the code as in your branch, I didn't make any changes.

As @xmish pointed out, that's a valid IP, and your server console is printing that the function has been deprecated, where it has been called (filename and line), and that you should skip calling it instead. What do you think, is this enough information for the server owner?

I didn't realize that was the default behavior, sorry.
This is more than enough.