/*
 * Copyright (c) 2017-2019 sel-project
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */
/**
 * Copyright: Copyright (c) 2017-2019 sel-project
 * License: MIT
 * Authors: Kripth
 * Source: $(HTTP github.com/sel-project/selery/source/selery/hncom/login.d, selery/hncom/login.d)
 */
module selery.hncom.login;

import selery.hncom.about;
import selery.hncom.io;

import xpacket : BigEndian;

/**
 * First packet sent by the client after the connection is established.
 * It contains informations used by the hub to check permissions and compatibility.
 */
@serverbound class ConnectionRequest : HncomPacket {
	
	enum ubyte ID = 1;
	
	/**
	 * Version of the protocol used by the client that must match the hub's one.
	 */
	@BigEndian uint protocol = __PROTOCOL__;
	
	/**
	 * Name of the node that will be validated by the hub. It should always be
	 * lowercase and only contain letters, numbers, dashes and underscores.
	 */
	string name;
	
	/**
	 * Password, if the hub requires one, or an empty string.
	 */
	string password;
	
	/**
	 * Indicates whether the node accepts clients when they first connect to the
	 * hub or exclusively when they are transferred.
	 */
	bool main = true;
	
	mixin Make;
	
}

/**
 * Reply to ConnectionRequest sent only when the node's ip is accepted by the hub.
 * It contains the connection status (accepted or an error code) and the hub's protocol.
 */
@clientbound class ConnectionResponse : HncomPacket {
	
	enum ubyte ID = 2;
	
	enum : ubyte {
		
		OK,
		OUTDATED_HUB,				/// The hub uses an old version of hncom
		OUTDATED_NODE,				/// The node uses an old version of hncom
		PASSWORD_REQUIRED,			/// A password is required to connect
		WRONG_PASSWORD,				/// The password doesn't match the hub's one
		INVALID_NAME_LENGTH,		/// The name is too short or too long
		INVALID_NAME_CHARACTERS,	/// The name contains invalid characters
		NAME_ALREADY_USED,			/// There's already a node connected with the same name
		NAME_RESERVED,				/// The name cannot be used because the hub has reserved it for something else
		BLOCKED_BY_PLUGIN,			/// A plugin has blocked the node from connecting
		
	}
	
	/**
	 * Indicates the status of connection. If not 0, it indicates an error.
	 */
	ubyte status;
	
	/**
	 * Indicates the version of the protocol used by the hub when the status
	 * code indicates that the hub or the node is obsolete.
	 */
	uint protocol = __PROTOCOL__;
	
	mixin Make;
	
}

/**
 * Hub's informations.
 */
@clientbound class HubInfo : HncomPacket {
	
	enum ubyte ID = 3;
	
	enum int UNLIMITED = -1;
	
	struct GameInfo { string motd; uint[] protocols; bool onlineMode; ushort port; }
	
	/**
	 * Server's id, either given by a snoop system or randomly generated at runtime.
	 */
	ulong serverId;
	
	/**
	 * First number of the 4,294,967,296 (2^32) reserved by the hub to create the node's UUIDs.
	 * Every UUID generated by the node is formed by the server's id (most signicant)
	 * and the next reserved uuid (least significant). This way every UUID in the hub
	 * and in the connected nodes is always different.
	 */
	ulong reservedUUIDs;
	
	/**
	 * Unformatted name of the server as indicated in the hub's configuration file.
	 */
	string displayName;
	
	/**
	 * Informations about the games supported by the hub.
	 */
	GameInfo[ubyte] gamesInfo;
	
	/**
	 * Number of players currently online and connected to other nodes.
	 */
	uint online;
	
	/**
	 * Number of maximum players that can connect to the server (that is the sum
	 * of the max players of the nodes already connected).
	 * The number may change after the current node connects.
	 */
	int max;
	
	/**
	 * Languages accepted by the server in format ISO 639.1 (language code) underscore
	 * ISO 3166 (country code), e.g. en_US.
	 * The list must contain at least one element.
	 */
	string[] acceptedLanguages;
	
	/**
	 * Indicates whether the web admin protocol is active on the hub. If it is the
	 * node should send the port where it will listen for connections in its info packet.
	 */
	bool webAdmin;
	
	/**
	 * Optional informations about the server's software, social accounts, system and options.
	 * Example:
	 * ---
	 * {
	 *   "software": {
	 *      "name": "Selery",
	 *      "version": "0.1.0",
	 *      "stable": true
	 *   },
	 *   "minecraft": {
	 *      "edu": false,
	 *      "realm": true
	 *   },
	 *   "social": {
	 *      "website": "example.com",
	 *      "facebook": "example-official",
	 *      "twitter": "example_tweets",
	 *      "youtube": "examplechannel",
	 *      "instagram": "example",
	 *      "google-plus": "example-plus"
	 *   },
	 *   "system": {
	 *      "os": "Ubuntu 16.04",
	 *      "cpu": "Intel(R) Core(TM) i5-5200U CPU @ 2.20GHz",
	 *      "cores": 2,
	 *      "ram": 2147483648
	 *   }
	 * }
	 * ---
	 */
	string additionalJSON;
	
	mixin Make;
	
}

/**
 * Node's informations.
 */
@serverbound class NodeInfo : HncomPacket {
	
	enum ubyte ID = 4;
	
	enum uint UNLIMITED = 0;
	
	struct Plugin { uint id; string name; string version_; }
	
	/**
	 * Informations about the games accepted by the node. There should be at least
	 * one combination of game/protocols that is also accepted by hub as indicated
	 * in HubInfo.gamesInfo, otherwise the node will never receive any player.
	 */
	uint[][ubyte] acceptedGames;
	
	/**
	 * Maximum number of players accepted by node.
	 */
	uint max;
	
	/**
	 * List of plugins currently loaded on the node.
	 * This field is used only for information purposes (as displaying the
	 * plugins in the querying protocol).
	 */
	Plugin[] plugins;
	
	/**
	 * Port where the node is listening for connections, if the web admin protocol
	 * is active on the hub.
	 */
	ushort webAdminPort;
	
	/**
	 * Optional informations about the server's software and system,
	 * similar to HubInfo's additionalJson field.
	 * Example:
	 * ---
	 * {
	 *   "software": {
	 *      "name": "Selery",
	 *      "version": "0.1.0",
	 *      "stable": true
	 *   },
	 *   "system": {
	 *      "os": "Windows 10",
	 *      "cpu": "Intel(R) Core(TM) i7-5700U CPU @ 3.40GHz",
	 *      "cores": 4,
	 *      "ram": 8589934592
	 *   }
	 * }
	 * ---
	 */
	string additionalJSON;
	
	mixin Make;
	
}