228 lines
8.7 KiB
C++
Executable File
228 lines
8.7 KiB
C++
Executable File
/******************************************************************************\
|
|
* Copyright (c) 2004-2020
|
|
*
|
|
* Author(s):
|
|
* Volker Fischer
|
|
*
|
|
|
|
Currently, if you want to run a private server, you have to open the firewall of
|
|
your computer at the correct ports and introduce a port forwarding at your
|
|
router to get it work. Using a central server simplifies the process. The user
|
|
who wants to run a server just registers his server a the central server
|
|
and a mechanism implemented in the protocol opens the firewall similar to STUN.
|
|
|
|
REQUIREMENTS:
|
|
|
|
The client sets the URL of the central server and can get a list of all
|
|
currently activated and registered private servers. If the user clicks on
|
|
the server of his choice, he gets connected to this server.
|
|
|
|
The server list must be available in both cases: if the client is connected to
|
|
the central server or not.
|
|
|
|
The server list contains the name of the server, an optional topic, an optional
|
|
location, the number of connected users and a ping time which is updated as
|
|
long as the server list is visible (similar to the ping measurement in the
|
|
general settings dialog). Additional information may be also present in the list
|
|
like reliability of the server, etc.
|
|
|
|
CONNECTION PROCESS:
|
|
|
|
The private server contacts the central server and registers through some
|
|
protocol mechanism.
|
|
|
|
If a client requests the server list from the central server, the central server
|
|
sends the IP address of the client to each registered private servers so that
|
|
they can immediately send a "firewall opening" UDP packet to this IP address.
|
|
If the client now sends ping messages to each of the private servers in the
|
|
list, the firewalls and routers are prepared for receiving UDP packets from this
|
|
IP address and will tunnel it through. Note: this mechanism will not work in a
|
|
private network.
|
|
|
|
******************************************************************************
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU General Public License as published by the Free Software
|
|
* Foundation; either version 2 of the License, or (at your option) any later
|
|
* version.
|
|
*
|
|
* 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, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*
|
|
\******************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include <QObject>
|
|
#include <QLocale>
|
|
#include <QList>
|
|
#include <QElapsedTimer>
|
|
#include <QMutex>
|
|
#include "global.h"
|
|
#include "util.h"
|
|
#include "protocol.h"
|
|
|
|
|
|
/* Classes ********************************************************************/
|
|
class CServerListEntry : public CServerInfo
|
|
{
|
|
public:
|
|
CServerListEntry() :
|
|
CServerInfo ( CHostAddress(),
|
|
CHostAddress(),
|
|
"",
|
|
QLocale::AnyCountry,
|
|
"",
|
|
0,
|
|
false ) { UpdateRegistration(); }
|
|
|
|
CServerListEntry ( const CHostAddress& NHAddr,
|
|
const CHostAddress& NLHAddr,
|
|
const QString& NsName,
|
|
const QLocale::Country& NeCountry,
|
|
const QString& NsCity,
|
|
const int NiMaxNumClients,
|
|
const bool NbPermOnline)
|
|
: CServerInfo ( NHAddr,
|
|
NLHAddr,
|
|
NsName,
|
|
NeCountry,
|
|
NsCity,
|
|
NiMaxNumClients,
|
|
NbPermOnline ) { UpdateRegistration(); }
|
|
|
|
CServerListEntry ( const CHostAddress& NHAddr,
|
|
const CHostAddress& NLHAddr,
|
|
const CServerCoreInfo& NewCoreServerInfo )
|
|
: CServerInfo ( NHAddr,
|
|
NLHAddr,
|
|
NewCoreServerInfo.strName,
|
|
NewCoreServerInfo.eCountry,
|
|
NewCoreServerInfo.strCity,
|
|
NewCoreServerInfo.iMaxNumClients,
|
|
NewCoreServerInfo.bPermanentOnline )
|
|
{ UpdateRegistration(); }
|
|
|
|
void UpdateRegistration() { RegisterTime.start(); }
|
|
|
|
public:
|
|
// time on which the entry was registered
|
|
QElapsedTimer RegisterTime;
|
|
};
|
|
|
|
class CServerListManager : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
CServerListManager ( const quint16 iNPortNum,
|
|
const QString& sNCentServAddr,
|
|
const QString& strServerInfo,
|
|
const int iNumChannels,
|
|
const bool bNCentServPingServerInList,
|
|
CProtocol* pNConLProt );
|
|
|
|
// the update has to be called if any change to the server list
|
|
// properties was done
|
|
void Update();
|
|
|
|
void SetEnabled ( const bool bState ) { bEnabled = bState; }
|
|
bool GetEnabled() const { return bEnabled; }
|
|
|
|
void SetCentralServerAddress ( const QString sNCentServAddr );
|
|
QString GetCentralServerAddress() { return strCentralServerAddress; }
|
|
|
|
void SetCentralServerAddressType ( const ECSAddType eNCSAT ) { eCentralServerAddressType = eNCSAT; }
|
|
ECSAddType GetCentralServerAddressType() { return eCentralServerAddressType; }
|
|
|
|
bool GetIsCentralServer() const { return bIsCentralServer; }
|
|
|
|
void CentralServerRegisterServer ( const CHostAddress& InetAddr,
|
|
const CHostAddress& LInetAddr,
|
|
const CServerCoreInfo& ServerInfo );
|
|
|
|
void CentralServerRegisterServerEx ( const CHostAddress& InetAddr,
|
|
const CHostAddress& LInetAddr,
|
|
const CServerCoreInfo& ServerInfo,
|
|
const COSUtil::EOpSystemType ,
|
|
const QString& );
|
|
|
|
void CentralServerUnregisterServer ( const CHostAddress& InetAddr );
|
|
|
|
void CentralServerQueryServerList ( const CHostAddress& InetAddr );
|
|
|
|
void SlaveServerUnregister() { SlaveServerRegisterServer ( false ); }
|
|
|
|
// set server infos -> per definition the server info of this server is
|
|
// stored in the first entry of the list, we assume here that the first
|
|
// entry is correctly created in the constructor of the class
|
|
void SetServerName ( const QString& strNewName )
|
|
{ ServerList[0].strName = strNewName; }
|
|
|
|
QString GetServerName() { return ServerList[0].strName; }
|
|
|
|
void SetServerCity ( const QString& strNewCity )
|
|
{ ServerList[0].strCity = strNewCity; }
|
|
|
|
QString GetServerCity() { return ServerList[0].strCity; }
|
|
|
|
void SetServerCountry ( const QLocale::Country eNewCountry )
|
|
{ ServerList[0].eCountry = eNewCountry; }
|
|
|
|
QLocale::Country GetServerCountry() { return ServerList[0].eCountry; }
|
|
|
|
ESvrRegStatus GetSvrRegStatus() { return eSvrRegStatus; }
|
|
|
|
void StoreRegistrationResult ( ESvrRegResult eStatus );
|
|
|
|
protected:
|
|
void SlaveServerRegisterServer ( const bool bIsRegister );
|
|
void SetSvrRegStatus ( ESvrRegStatus eNSvrRegStatus );
|
|
|
|
QTimer TimerPollList;
|
|
QTimer TimerRegistering;
|
|
QTimer TimerPingServerInList;
|
|
QTimer TimerPingCentralServer;
|
|
QTimer TimerCLRegisterServerResp;
|
|
|
|
QMutex Mutex;
|
|
QTextStream& tsConsoleStream;
|
|
|
|
QList<CServerListEntry> ServerList;
|
|
|
|
QString strCentralServerAddress;
|
|
int iNumPredefinedServers;
|
|
bool bEnabled;
|
|
bool bIsCentralServer;
|
|
ECSAddType eCentralServerAddressType;
|
|
bool bCentServPingServerInList;
|
|
|
|
CHostAddress SlaveCurCentServerHostAddress;
|
|
CHostAddress SlaveCurLocalHostAddress;
|
|
|
|
CProtocol* pConnLessProtocol;
|
|
|
|
// server registration status
|
|
ESvrRegStatus eSvrRegStatus;
|
|
|
|
// count of registration retries
|
|
int iSvrRegRetries;
|
|
|
|
public slots:
|
|
void OnTimerPollList();
|
|
void OnTimerPingServerInList();
|
|
void OnTimerPingCentralServer();
|
|
void OnTimerCLRegisterServerResp();
|
|
void OnTimerRegistering() { SlaveServerRegisterServer ( true ); }
|
|
void OnTimerIsPermanent() { ServerList[0].bPermanentOnline = true; }
|
|
|
|
signals:
|
|
void SvrRegStatusChanged();
|
|
};
|