Motivation / Problem

With STUN in mind, it is a lot easier if we have a single protocol to talk between client and server. This was mostly true, except for a part in the lobby window.

Most likely to avoid code-duplication (random guess honestly), opening the lobby does two requests: one via UDP to get the latest game-info, and one via TCP to get the latest company-info. This PR sets out to change that both to TCP.

Accidentally, this solves a rare edge-case, where someone create a new company on a server, TCP reacts with the company-list, but the UDP packet is lost. In this case, the new company is not shown. Only until the UDP packet is received, it will be shown correctly. By using TCP here over UDP, we ensure this isn't possible.

Description

The first commit moves a lot of code related to NetworkGameInfo to a single place, so adding GameInfo to TCP (next to UDP) doesn't cause code duplication.

The second commit adds a packet to the TCP to exchange GameInfo over TCP too.

Sadly, I wasn't a very smart cookie when I wrote the network protocol, and over TCP we do not handshake a protocol-version before we initiate conversation. This means that there are potential (future) issues with this PR. Currently this isn't an issue, but just to walk through the situations:

New client + new server:

• MasterServer tells the servers online, via UDP these are queried. When pressing Join, the Lobby window does everything via TCP.
• Via "Add Server" someone manually adds a server. Via UDP it is queried. When pressing Join, the Lobby window does everything via TCP.

Old client + new server / new client + old server:

• MasterServer tells the servers online, via UDP these are queried. Versions are incompatible, so lobby cannot be opened.
• Via "Add Server" someone manually adds a server. Via UDP it is queried. Versions are incompatible, so lobby cannot be opened.

Using -n to join a server bypasses lobby, and as such works fine too (well, it hits revision mismatch if that is the case, ofc)

Backport

Currently "Add Server" still uses UDP to query the server. A future PR will change this to also use TCP here (only for manual servers and manual refresh). This does mean that adding older servers will result in a protocol error, as older server don't know this new packet. In such future PR, the client will pick up on this and show a nice "Server is too old" text.

It would help to backport this to 1.11. It would mean that when 1.12 releases, the 1.11.N can be added manually and show the game info (and that the version is incompatible). This would mean for most of our servers there isn't a real problem, and it is only an issue if people add really old servers manually.
This is also the reason that this future PR is not included in this PR.

Additionally, the last two commits from this PR don't have to be backported. It makes use of this new TCP packet; without it nothing breaks, and means there is no functional difference after backporting. But it is better to play it safe, so do not backport the last two commits please.

Additionally, if this is backported, so should #9129, as it fixes packet order.

Limitations

None, this should be fully backports compatible. The GUI prevents opening the lobby for old servers, and UDP is used for anything before that.

Checklist for review

Some things are not automated, and forgotten often. This list is a reminder for the reviewers.

• The bug fix is important enough to be backported? (label: 'backport requested')
• This PR affects the save game format? (label 'savegame upgrade')
• This PR affects the GS/AI API? (label 'needs review: Script API')
  • ai_changelog.hpp, gs_changelog.hpp need updating.
  • The compatibility wrappers (compat_*.nut) need updating.
• This PR affects the NewGRF API? (label 'needs review: NewGRF')
  • newgrf_debug_data.h may need updating.
  • PR must be added to API tracker