IpToCountry

[Matthew]

IpToCountry 1.6 for Unreal Tournament '99

Initial to v1.2 by [es]Rush
v1.6 by Matthew 'MSuLL' Sullivan

Release Date: May 21, 2010
Distributed under the terms of OpenUnrealMod license - see LICENSE.txt for details

>> Download Here << (http://www.unrealadmin.org/forums/attachment.php?attachmentid=1320&d=1274293519)
(also mirrored at UT-Files.com) (http://www.ut-files.com/index.php?dir=Admin/IpToCountry/&file=ipToCountry-1.6.zip)

IF UPGRADING (IMPORTANT!)
-------
If you are upgrading from an old version, please see the section 'UPGRADING'
in the readme file. There have been a few important changes you need to be aware of!

CHANGELOG
-------
1.6: -Workaround to prevent crashing, improve stability and efficiency.
-Trying to switch between query servers no longer fails
-Re-added DNS resolution. IP cached in the config, if it changes the mod will re-resolve.
-Increased number of query servers to 4.

1.2: -Added a small clientside package to identify AOL's country. Will work for USA/GB/DE players.
-Added ErrorLimit variable.
-Removed dependency on the DNS resolving system in UnrealEngine which seemed to be crashing the servers.
Now all host based query servers have to specify an IP.

1.1: -Fixed the texture package, now it is CountryFlags2, this one should be perfect.
-Fixed accessed nones in the Addon part while playing on the server with bots.

1.0: -First version

SPECIAL NOTE
-------
Starting at version 1.6, I (MSuLL) will be trying to support this mod through updates and bugfixes, as Rush
has since moved on from UT and Unreal coding. Rush created the initial versions and did an excellent job.
Most of us (coders) didn't even know such magic was possible until this mod was created and refined.
To both Rush and AnthraX: thank you so very much for your contributions to this mod, and to the UT
community in general. We, the players and admins of UT, deeply appreciate it and thank you for your efforts!

WHAT IS IT FOR?
-------
In short, as the name says, it can resolve a country from an IP address; it also resolves a hostname.
IpToCountry is meant mainly to be just a shared component between many other mods, for example
recent versions of SmartCTF, etc. Don't expect much black magic from IpToCountry itself. But to not
make you sad I've also made a little addon which will show players' country names after doing a
mutate command, for admins there is a similiar command showing hostnames, this addon is enabled by
default, but you can disable it in the config.

HOW DOES IT WORK?
-------
To your knowledge, resolving a country from an IP requires quite a big database and implementing
it in UnrealScript would be very hard, thus IpToCountry connects to a PHP script which is located
on a web server. This PHP script uses a database kindly distributed by www.maxmind.com
If you want to know how the querying stuff exactly works just "Use the source Luke!"

AOL is quite troublesome. AOL has all its IP ranges registered in the USA and thus it doesn't
make identification easy. Fortunately Rush found a way to go around the problem.
Three major countries where AOL is very popular are: USA, Great Britain and Germany. All those three have
different timezones, so Rush just had to get a player's time and compare it to GMT. The idea maybe was Rush's
but Cratos was the first to implement it in LeagueAS, Rush got some code from him so big thanks, mate.

WHO USES IT?
-------
At the time of writing this readme the following mods/mutators make use of IpToCountry (that I know of...):
-SuperWebAdmin 0.97
-LeagueAS140
-SmartCTF_4D (and up)
-BTPlusPlusv097
-Hostname Ban
-Nexgen

A NOTE ON THE HTTPCLIENT CLASS (FOR DEVS ONLY)
-------
UT's implementation of a strong, stable HTTP Client wasn't much of a success. Thankfully Rush and
AnthraX took some time and made great progress on a UScript-based solution for the original
builds of IpToCountry. Problem is: if both query servers went down, or the internet stopped working for
just a little while, the entire UT server process would often die. In September 2008 I
(MSuLL) began working on a mod that would depend on strong HTTP communications, which became the mod
'Universal Unreal'. I used Rush's IpToCountry HTTP Client implentation as a base, then went about refining
it and making it more stable and efficient.

One big issue with the old client was that everything was being performed from the HTTP Client class,
and that class was spawned as a ServerActor at startup. When something screws up, the HTTP Client class,
which is based off of UBrowserHTTPClient, can't re-bind a port properly. The solution is to kill the
HTTP Client class and start another instance upon a critical bind error.

For v1.6(+future editions) of IpToCountry, I've ported (or un-ported?) my HTTP Client implementation
back into the mod where it all began. I've separated it into three main parts. The LinkActor class
does error handling and general data management. The HTTPClient class does the grunt work and can be
killed off (and then restarted) when critical errors are encountered. The third class is the Addon
class, nothing major has changed in this class though.

I'd encourage developers to make use of this improved HTTP Client implementation in your own
mods. Even though this game is 11 years old, there's still time for cool new stuff to be built :D
The class is very modular and shouldn't be too hard to understand / modify / etc. Feel free to
ask for help in the UnrealAdmin.org forum, and I'd be glad to help.

THANKS TO
-------
AnthraX - for overall help, consultations and helping UT'99 community so much, thanks mate! Also thanks for updating the query server
teleport*bR - thanks for the great help in putting the texture package to one, thanks also for testing
Cratos - for supporting IpToCountry in LeagueAS and giving me some code to identify AOL's timezone
UnrealAdmin - for keeping UT alive

[3apa3a]

should the i in "ipToCountry" be lowercase or capital? Will this screw stuff up for linux servers?

[Matthew]

should the i in "ipToCountry" be lowercase or capital? Will this screw stuff up for linux servers?
Good question. For some reason, the old IpToCountry builds would save the INI file as "ipToCountry" on Gentoo, and then when data needed to be loaded from the file it was looking for "IpToCountry", and wouldn't see any data there (it was very weird...).

I decided to make everything in this 1.6 version be "ipToCountry", with exception of the AOL extension. This is why the upgrade instructions say to remove both the old .INI and the old .U

The Linux builds of UT should auto-search for .U files via a case-insensitive search. The name of the .INI file however *will matter*, but since I changed the convention for query servers in this edition, the .INI should just be deleted and auto-generated anyway.

[Letylove49]

Matthews why the release date is 21 May ? we are the 19th May not the 21th today.

[Matthew]

Matthews why the release date is 21 May ? we are the 19th May not the 21th today.

Finished faster than I anticipated and forgot to update it; I wrote the readme last week.

[Letylove49]

ok thanks
for the answere. and thanks for your work.

[{MOS}*KrystoF*]

Ty Matthew and all other people that have helped you.

I have installed it and it work well, i like what you have added more in the .ini file.

Ty again.

[qwerty]

I Love You

[Rush]

Matthew, I occasionally follow what happens in the Unrealadmin community. You have done an immensely great job, BIG THANKS for continuing what I started with this MOD. It is true that I no longer have an active interest in the community but I still DO care. It is very rewarding to think that something you created lives on, big cheers dude and thumbs up. :thumbup:

[Matthew]

I Love You
<3
Matthew, I occasionally follow what happens in the Unrealadmin community. You have done an immensely great job, BIG THANKS for continuing what I started with this MOD. It is true that I no longer have an active interest in the community but I still DO care. It is very rewarding to think that something you created lives on, big cheers dude and thumbs up. :thumbup:

:) Thanks rush

[Killerbee]

Thx something gOOd to upgrade!

[TSQ]

Good job :thumbup: works great!:D

[back4more]

thanks alot for this upgrade Mathew.

Regards

BFM

[nik_mz]

Unfortunately new version no longer works with MODOSUtilsV26pre5 (flags in DM mode)

[Matthew]

Unfortunately new version no longer works with MODOSUtilsV26pre5 (flags in DM mode)

I would imagine that the coder must have hard-coded IpToCountry into the mod instead of calling the GetItemName function of Actor. I'd ask the coder to try and fix.

[qwerty]

I'm also having a problem now where the country flags dont show in BT :( any ideas? otherwise its still doing look ups :)

please and thank you :)

[Matthew]

I'm also having a problem now where the country flags dont show in BT :( any ideas? otherwise its still doing look ups :)

please and thank you :)

What BT version (what .u, specifically)? I'll do a quick code look-over.

[qwerty]

BTPlusPlusv097.u

[Matthew]

BTPlusPlusv097.u

The source is stripped from the package, which makes it impossible to edit (so you'll have to contact the author). But I loaded it up into WOTGreal Exporter and I can see why it no longer works; the coder didn't follow the recommended implementation scheme, and when I changed a few things on the inside it broke this mod's ability to find IpToCountry. It's a very easy fix as long as someone has source code.

[qwerty]

well thanks for looking :) much appreciated :)

[Rush]

Matthew, I think it makes me the author of BTPlusPlus:

foreach AllActors(class'UBrowserHTTPClient', IpToCountry) {
if(string(IpToCountry.class) == "IpToCountry.LinkActor")

BTPlusPlus' source is open, it's included with the zip:
http://www.unrealadmin.org/forums/attachment.php?attachmentid=1143&d=1167347427

As long as your IpToCountry update follows the same package naming and class naming "IpToCountry.LinkActor" I see no reason it shouldn't work.

[Matthew]

Matthew, I think it makes me the author of BTPlusPlus:

foreach AllActors(class'UBrowserHTTPClient', IpToCountry) {
if(string(IpToCountry.class) == "IpToCountry.LinkActor")

BTPlusPlus' source is open, it's included with the zip:
http://www.unrealadmin.org/forums/attachment.php?attachmentid=1143&d=1167347427

As long as your IpToCountry update follows the same package naming and class naming "IpToCountry.LinkActor" I see no reason it shouldn't work.

LinkActor actually spawns and manages another class, 'HTTPClient', which now handles the data transfer. That's how this new version avoids crashing the server - it manages the HTTP client carefully to keep it stable (Rush if you are interested in learning a bit more about how I re-worked this edition, have a look at the readme, you might be interested since you did so much for this mod :))

Because of this change the code won't work anymore. But thankfully it's very easily fixed, especially since the source is posted (thanks Rush, you da man). Qwerty, would you like me to fix it, or do you want to take this one on?

[nik_mz]

I would imagine that the coder must have hard-coded IpToCountry into the mod instead of calling the GetItemName function of Actor. I'd ask the coder to try and fix.
If i'm not mistaken sphx is the coder, and since SmartUT is still beta, and supports only TDM/DOM, for coutry flags, in DM, modified MODOS is the only option available out there :)

[qwerty]

LinkActor actually spawns and manages another class, 'HTTPClient', which now handles the data transfer. That's how this new version avoids crashing the server - it manages the HTTP client carefully to keep it stable (Rush if you are interested in learning a bit more about how I re-worked this edition, have a look at the readme, you might be interested since you did so much for this mod :))

Because of this change the code won't work anymore. But thankfully it's very easily fixed, especially since the source is posted (thanks Rush, you da man). Qwerty, would you like me to fix it, or do you want to take this one on?

I dont know how to code :*(

[Matthew]

I dont know how to code :*(

heh okay, I'll take care of it soon

[back4more]

Would seem that I will have to wait for this release also lol, as i have just setup a BT Server using BT++r3

[SoNY_scarface]

Rush has already released a version requesting what Qwerty did

[back4more]

Do you know where i can download it from mate cheers?
Iam using version 1.2v3 atm but no flags showing in SmartCTF4D++ :\
from console iptocountry works fine. but no flags in SmartCTF HUD.

[Rush]

I looked at SmartCTF4D's source and it should properly resolve the flags - it doesn't depend on LinkActor being a child of UBrowserHTTPClient.

The supposedly working BTPlusPlus version is here:
http://153.19.49.41:5580/~rush/BTPlusPlus_crashfixtest2.zip
I still hasn't released it yet, and it doesn't have its own readme.
It is BTPlusPlusv097 + crash workaround + fix to IpToCountry binding.

[admin]

i have no error with BTPlusPlusv097 and

[IpToCountry.LinkActor]
QueryServerHost[0]=iptocountry.ut-files.com
QueryServerHost[1]=www.ut-slv.com
QueryServerHost[2]=utgl.unrealadmin.org
QueryServerHost[3]=
QueryServerFilePath[0]=/iptocountry16.php
QueryServerFilePath[1]=/iptocountry/iptocountry16.php
QueryServerFilePath[2]=/iptocountry16.php

[back4more]

flags not showing in scoreboard for some reason.

... BtPlusPlus.ini
[BTPlusPlusv097r3.BTPlusPlus]
bEnabled=True
bBTScoreboard=True
bAutoLoadInsta=True
bMultiFlags=True
bRespawnAfterCap=True
bAntiBoost=True
bBlockBoostForGood=False
AllowBoostOn=
bNoKilling=True
AllowKillingOn=BT-Colors,BT-1point4megs,BT-i4games,BT-Abomination,BT-Allied
bGhostWhenCamping=True
CampTime=10
CampRadius=200
bEverybodyGhosts=False
bForceMoversKill=True
ForceMoversKill[0]=Mover0,Mover1,Mover2,Mover5:BT-Maverick
ForceMoversKill[1]=
ForceMoversKill[2]=
ForceMoversKill[3]=
ForceMoversKill[4]=
ForceMoversKill[5]=
ForceMoversKill[6]=
ForceMoversKill[7]=
ForceMoversKill[8]=
ForceMoversKill[9]=
bSaveRecords=True
bNoCapSuicide=True
RecordsWithoutBoost=2
bDisableInTournament=True
bDisableInNonBTMaps=True
BoardLabel=Bunny Track (BT++)
CountryFlagsPackage=CountryFlags2

.. bt.ini ServerPackages/ServerActors loaded

ServerPackages=NexgenCC
ServerPackages=Nexgen111
ServerPackages=NexgenX111
ServerPackages=BunnyTrack3
ServerPackages=CTFDoTheRightThing2
ServerPackages=MapVoteLA13
ServerPackages=BTPlusPlusv097r3
ServerPackages=BTPlusPlusv097r3_C
ServerPackages=IpToCountry_AOL
ServerPackages=CountryFlags2
;serverPackages=SmartCTF_4E
;ServerPackages=EUT_1G
;ServerPackages=EUTIV
;ServerPackages=EUT3
ServerActors=Nexgen111.NexgenActor
ServerActors=NexgenX111.NexgenX
ServerActors=AKAv6kLog_X103.ServerActor
;ServerActors=SmartCTF_4E.SmartCTFServerActor
ServerActors=IpToCountry.LinkActor
ServerActors=HostnameBan.HostnameBan

...MapVoteLa.ini
CustomGameConfig[0]=(bEnabled=True,GameClass="BunnyTrack3.BunnyTrackGame",NewPrefix="CTF-BT",mutators="CTFDoTheRightThing2.CTFDoTheRightThingMutator",Settings="GameSpeed=1.00,GoalTeamScore=15.0,AirControl=0.350000,TimeLimit=30")

is most likely to be the BtPlusPlus mod as SmartCTF4E Picks up the flags no problems, unfortunately SmartCTF4E is not for BT Score Tracking or Rather Does not have 100% compatibility with the BT gameType.

Nearly there lol. once flags up everything should be good to go.

Add mutator BTPlusPlusv097r3.BTPlusPlus
+-----------------
| BTPlusPlus v0.97r3 by [es]Rush*bR
| Status: Running
+-----------------
Converting BTRecords.ini file to the new format, it might need some manual corre
ctions though.

[back4more]

got flags working with 1.6 , need to re-arrange SA's & SP's (Actors/Packages) where by iptocountry is at the top in both , or rather loads before dependant Actor/Packages.

Makes sense? . Good one.
cheers.

[inquisitor]

Hi all, i just discoverered some troubles with this module to get it working, long story short - after all unsuccessfully irritate trying i just put this actor as mutator in dynamic loader "ActorCLP" and everything is working fine:


...
[Engine.GameEngine]
CacheSizeMegs=4
UseSound=True
ServerActors=IpDrv.UdpBeacon
ServerActors=IpServer.UdpServerQuery
ServerActors=IpServer.UdpServerUplink MasterServerAddress=unreal.epicgames.com MasterServerPort=27900
ServerActors=IpServer.UdpServerUplink MasterServerAddress=master0.gamespy.com MasterServerPort=27900
ServerActors=IpServer.UdpServerUplink MasterServerAddress=master.mplayer.com MasterServerPort=27900
ServerActors=UWeb.WebServer
;
ServerActors=ActorCLP.ActorCLP
;
ServerPackages=SoldierSkins
ServerPackages=CommandoSkins
ServerPackages=FCommandoSkins
ServerPackages=SGirlSkins
ServerPackages=BossSkins
ServerPackages=Botpack
;
ServerPackages=CountryFlags2
ServerPackages=IpToCountry_AOL
ServerPackages=MapVoteLA13
;
MinClientVersion=451
;ServerActors=IpToCountry.LinkActor


[ActorCLP.ActorCLP]
;Mutators=MapVoteLA13.BDBMapVote,ZPPure7G.AccuGib
Mutators=MapVoteLA13.BDBMapVote
Mutators=IpToCountry.LinkActor
DefaultMap=DM-Stalwart
;DefaultGametype=EUT_1G.SmartCTFGame

...

[Data_Destroyer]

Thx Rush for Creating IpToCountry and thx Matthew for continuing his work!

Cheers!

[Toruk_Makto]

Flag of El Salvador is missing in CountryFlags2.utx.

[(G)ott]

Flag of El Salvador is missing in CountryFlags2.utx.

and here..

here is a list of all not supported country's in the CountryFlags2.utx...
ag -> Antigua and Barbuda
ai -> Anguilla
aq -> Antarctica
as -> American Samoa
bv -> Bouvet Island
cc -> Cocos (Keeling) Islands
cd -> Congo (Ex-Zaire)
cx -> Christmas Island
dj -> Djibouti
dm -> Dominica
do -> Dominican Republic
eh -> Western Sahara
eu -> Europe
fk -> Falkland Islands (Malvinas)
fm -> Micronesia
fx -> France, Metropolitan
gd -> Grenada
gf -> French Guiana
gg -> Guernsey
gh -> Ghana
gm -> Gambia
gn -> Guinea
gq -> Equatorial Guinea
gs -> S. Georgia and S. Sandwich Isls.
gw -> Guinea-Bissau
hm -> Heard and McDonald Islands
hn -> Honduras
ht -> Haiti
im -> Isle of Man
io -> British Indian Ocean Territory
je -> Jersey
km -> Comoros
kn -> Saint Kitts and Nevis
kw -> Kuwait
la -> Laos
lr -> Liberia
ls -> Lesotho
me -> Montenegro
mh -> Marshall Islands
ml -> Mali
mm -> Myanmar
mq -> Martinique
mr -> Mauritania
mu -> Mauritius
mv -> Maldives
mw -> Malawi
ne -> Niger
ng -> Nigeria
ni -> Nicaragua
nt -> Neutral Zone
nu -> Niue
pg -> Papua New Guinea
pn -> Pitcairn
ps -> Palestinian Authority
pw -> Palau
re -> Reunion
rs -> Serbia
rw -> Rwanda
sc -> Seychelles
sh -> St. Helena
sj -> Svalbard and Jan Mayen Islands
sm -> San Marino
sn -> Senegal
sr -> Suriname
st -> Sao Tome and Principe
su -> USSR
sv -> El Salvador
sy -> Syria
sz -> Swaziland
td -> Chad
tf -> French Southern Territories
tj -> Tajikistan
tk -> Tokelau
tm -> Turkmenistan
um -> US Minor Outlying Islands
uz -> Uzbekistan
vc -> Saint Vincent and the Grenadines
vu -> Vanuatu
wf -> Wallis and Futuna Islands
yt -> Mayotte
zm -> Zambia
zr -> Zaire

[Data_Destroyer]

My English is bad too, but its fine :thumbup:

Well, I have no knowledge about object-oriented programming :(

Cheers!

[Toruk_Makto]

I have two servers with practical the same system folders, mods and ini's.
On one this iptocountrymod works fine.
On the other I get this error:

ScriptLog: [IpToCountry] iptocountry.ut-files.com timed out after 10 seconds
ScriptLog: [IpToCountry] iptocountry.ut-files.com failed! Trying the alternate server...
ScriptWarning: HTTPClient CTF-Face.HTTPClient0 (Function ipToCountry.HTTPClient.DoBind:000A) BindPort: already bound
ScriptLog: [IpToCountry] Error while resolving the host www.ut-slv.com
ScriptLog: [IpToCountry] www.ut-slv.com failed! Trying the alternate server...
ScriptWarning: HTTPClient CTF-Face.HTTPClient0 (Function ipToCountry.HTTPClient.DoBind:000A) BindPort: already bound
ScriptLog: [IpToCountry] Error while resolving the host utgl.unrealadmin.org
ScriptLog: [IpToCountry] utgl.unrealadmin.org failed! Trying the alternate server...
ScriptWarning: HTTPClient CTF-Face.HTTPClient0 (Function ipToCountry.HTTPClient.DoBind:000A) BindPort: already bound
ScriptLog: [IpToCountry] Error while resolving the host iptocountry.ut-files.com
ScriptLog: [IpToCountry] iptocountry.ut-files.com failed! Trying the alternate server...
ScriptWarning: HTTPClient CTF-Face.HTTPClient0 (Function ipToCountry.HTTPClient.DoBind:000A) BindPort: already bound
ScriptLog: [IpToCountry] Error while resolving the host www.ut-slv.com
ScriptLog: [IpToCountry] www.ut-slv.com failed! Trying the alternate server...
ScriptWarning: HTTPClient CTF-Face.HTTPClient0 (Function ipToCountry.HTTPClient.DoBind:000A) BindPort: already bound
ScriptLog: [IpToCountry] Error while resolving the host utgl.unrealadmin.org
ScriptLog: [IpToCountry] utgl.unrealadmin.org failed! Trying the alternate server...
ScriptLog: [IpToCountry] No data was received during the last session; will attempt to re-resolve utgl.unrealadmin.org upon HTTP client reload.
ScriptLog: [IpToCountry] Too many HTTP error


Does anybody know what the cause can be?

Thanks

[Letylove49]

try to use another port on the 2nd server

QueryServerPort[0]=79
QueryServerPort[1]=79
QueryServerPort[2]=79
QueryServerPort[3]=79

[Toruk_Makto]

try to use another port on the 2nd server

QueryServerPort[0]=79
QueryServerPort[1]=79
QueryServerPort[2]=79
QueryServerPort[3]=79

Thank you letylove49
Unfortunately it did not help.


I did forget to mention this part of the errormessage:
ScriptLog: [IpToCountry] Too many HTTP errors in one session, HTTP client restarting.
Log: Resolving utgl.unrealadmin.org...
Log: CheckConnectionAttempt: Error while checking socket status.
Log: Resolving utgl.unrealadmin.org...
Log: Resolved utgl.unrealadmin.org (85.236.100.16)




When I do change ports to 79 the iptocountrymod will be disabled after too many errors:


ScriptLog: [IpToCountry] Too many HTTP client restarts in one session, HTTP functions disabled.
Log: Resolving www.ut-slv.com...
Log: CheckConnectionAttempt: Error while checking socket status.
Log: Client netspeed is 10000
Log: Client netspeed is 20000
ScriptLog: Team 0
ScriptLog: Login: -player1
Log: Possessed PlayerPawn: CHSpectator CTF-FaceOlympic.CHSpectator1
ScriptLog: [Hostname Ban] IpToCountry returned an error! (Error: !Disabled)
ScriptLog: [Hostname Ban] Hostname Ban is aborting banlist check for -player1



Quoting Matthew:

One big issue with the old client was that everything was being performed from the HTTP Client class,
and that class was spawned as a ServerActor at startup. When something screws up, the HTTP Client class,
which is based off of UBrowserHTTPClient, can't re-bind a port properly. The solution is to kill the
HTTP Client class and start another instance upon a critical bind error.


In the end the connection is established...
But it looks like something has screwed up the HTTP Client class
And everytime a player joins I get this error.

[admin]

IpToCountry: utgl.unrealadmin.org/iptocountry-ut.php returned bad data! ??