/*
  Copyright (C) 2001-2004 Stephane Magnenat & Luc-Olivier de Charrière
  for any question or comment contact us at <stephane at magnenat dot net> or <NuageBleu at gmail dot com>

  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 3 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/

#ifndef __YOG_CONSTS_H
#define __YOG_CONSTS_H

#include <string>
#include "SDL_net.h"

///New YOG constants
const Uint16 YOG_SERVER_PORT = 7486;
const std::string YOG_SERVER_IP = "yog.globulation2.org";
//const std::string YOG_SERVER_IP = "127.0.0.1";

#define IRC_CHAN "#glob2"
#define IRC_SERVER "irc.globulation2.org"

///Policies for login
enum YOGLoginPolicy
{
	///This represents an unknown policy. Used by the client
	///before the policy information has been transferred across the network
	YOGUnknownLoginPolicy,
	///This policy demands a password with the login
	YOGRequirePassword,
	///This policy allows anonymous logins.
	YOGAnonymousLogin,
};

///Policies for the games the server hosts
enum YOGGamePolicy
{
	///This represents an unknown policy. Used by the client
	///before the policy information has been transferred across the network
	YOGUnknownGamePolicy,
	///In this policy, the server hosts one game, and all connected are a part of it.
	YOGSingleGame,
	///In this policy, the server hosts multiple games, and users can choose what game
	///they are a part of
	YOGMultipleGames,
};

///Represents the state of a login. Whether it was accepted, or if it
///was refused, and if so, for what reason.
enum YOGLoginState
{
	///This represents when the login was successful.
	YOGLoginSuccessful,
	///This represents when the login state is unknown
	YOGLoginUnknown,
	///This means that the password was incorrect.
	///(only for servers that require registration)
	YOGPasswordIncorrect,
	///This means that a user with the same username is already connected.
	YOGUsernameAlreadyUsed,
	///This means that no registered user with that username exists
	///(only for servers that require registration)
	YOGUserNotRegistered,
	///This means that the clients version is too old, they must update
	YOGClientVersionTooOld,
};

///This represents the reason why the player could not join a game.
enum YOGGameJoinRefusalReason
{
	///This represents internally an unknown reason
	YOGJoinRefusalUnknown,
};

///This represents the reason why the player could not join a game.
enum YOGGameCreateRefusalReason
{
	///This represents internally an unknown reason
	YOGCreateRefusalUnknown,
};

///This is used to represent the types of messages that can be sent through YOG
enum YOGMessageType
{
	///This means a normal message sent to all connected users
	YOGNormalMessage,
	///This means a private message sent to one user
	YOGPrivateMessage,
	///This means an administrator message sent by YOG
	YOGAdministratorMessage,
	///This is a message sent only to members of the same game
	YOGGameMessage,
};

///This is used to represent the various reasons a player may be
///removed from a game.
enum YOGKickReason
{
	///This means the host has disconnected and all players must quit
	YOGHostDisconnect,
	///This means that the host has kicked the player
	YOGKickedByHost,
	///This represents an unknown reason
	YOGUnknownKickReason,
};


/*

#define YOG_SERVER_IP "yog.globulation2.org"
#define YOG_SERVER_PORT 7486

// 1s-4s-7.5s-14.5s-22s
#ifndef SECOND_TIMEOUT

#define SECOND_TIMEOUT 25
#define SHORT_NETWORK_TIMEOUT 75
#define DEFAULT_NETWORK_TIMEOUT 175
#define LONG_NETWORK_TIMEOUT 350
#define MAX_NETWORK_TIMEOUT 550

#define DEFAULT_NETWORK_TOTL 3
#endif


//We allways have:
// 512 char max local messages size,
// 256 char max messages size,
//  64 char max games name size,
//  64 char max map name size,
//  32 char max userName size.

//Max size is defined by games lists. (4+2+4+2+4+4+64)*16+4=1348
//or clients (4+32+2)*32+1=1217
#define YOG_MAX_PACKET_SIZE 1348
#define YOG_PROTOCOL_VERSION 5

enum clientUpdateChange
{
	CUP_BAD=0,
	CUP_LEFT=1,
	CUP_PLAYING=2,
	CUP_NOT_PLAYING=4,
	CUP_AWAY=8,
	CUP_NOT_AWAY=16
};

// Those are the messages identifiers inside YOG-client.
// It has to guarantee the binnary compatibility with YOGMessageType,
// except for inside YOG-client only messages.
enum YOGClientMessageType
{
	YCMT_BAD=0,
	YCMT_EVENT_MESSAGE=8,
	YCMT_MESSAGE=12,
	YCMT_PRIVATE_MESSAGE=14,
	YCMT_PRIVATE_RECEIPT=16,
	YCMT_PRIVATE_RECEIPT_BUT_AWAY=18,
	YCMT_ADMIN_MESSAGE=20,
};

// data[4] of a YMT_CONNECTION_REFUSED message:
enum YogConnectionRefusedType
{
	YCRT_NOTHING=0,
	YCRT_PROTOCOL_TOO_OLD=10,
	YCRT_USERNAME_ALLREADY_USED=20,
	YCRT_BAD_PASSWORD=30,
	YCRT_BAD_PASSWORD_NON_ZERO=34,
	YCRT_ALREADY_PASSWORD=40,
	YCRT_ALREADY_AUTHENTICATED=50,
	YCRT_NOT_CONNECTED_YET=60
};

// Those are all the possible UDP packet identifier,
// used to communicate betweem the YOG-client and the YOG-metaserver.
enum YOGMessageType
{
	YMT_BAD=0,
	
	YMT_BROADCAST_LAN_GAME_HOSTING=1,
	YMT_BROADCAST_REQUEST=2,
	YMT_BROADCAST_RESPONSE_LAN=3,
	YMT_BROADCAST_RESPONSE_YOG=4,
	
	YMT_GAME_INFO_FROM_HOST=5,
	
	YMT_CONNECTING=6,
	YMT_AUTHENTICATING=7,
	YMT_CONNECTION_REFUSED=8,
	YMT_DECONNECTING=9,
	
	YMT_SEND_MESSAGE=10,
	YMT_MESSAGE=12,
	YMT_PRIVATE_MESSAGE=14,
	YMT_PRIVATE_RECEIPT=16,
	YMT_ADMIN_MESSAGE=20,
	
	YMT_SHARING_GAME=22,
	YMT_STOP_SHARING_GAME=24,
	YMT_STOP_PLAYING_GAME=26,
	
	YMT_HOST_GAME_SOCKET=30,
	YMT_JOIN_GAME_SOCKET=32,
	
	YMT_GAMES_LIST=40,
	YMT_UNSHARED_LIST=42,
	
	YMT_CLIENTS_LIST=50,
	YMT_UPDATE_CLIENTS_LIST=52,
	
	YMT_CONNECTION_PRESENCE=80,
	
	YMT_PLAYERS_WANTS_TO_JOIN=100,
	
	YMT_FLUSH_FILES=126,
	YMT_CLOSE_YOG=127
};
*/

#endif