/*
 * Copyright 2009-2011, Andrea Anzani. All rights reserved.
 * Copyright 2009-2011, Pier Luigi Fiorini. All rights reserved.
 * Copyright 2021, Jaidyn Levesque. All rights reserved.
 * Distributed under the terms of the MIT License.
 */
#ifndef _CAYA_PROTOCOL_MESSAGES_H
#define _CAYA_PROTOCOL_MESSAGES_H

/**
 * What-codes for messages.
 */
enum message_what_codes {
	//!	All client <> protocol communication uses this what-code
	IM_MESSAGE						= 'IMme',

	//!	Used for very important (blocking) error messages
	IM_ERROR						= 'IMer',

	//!	Returned after a request has succeded
	IM_ACTION_PERFORMED				= 'IMap'
};

/**
 * Valid codes for im_what field.
 */
enum im_what_code {
	/*
	 * Messages that involves server-side contact list.
	 */

	//!	Request a server-side contact list from protocol →Protocol
	IM_GET_CONTACT_LIST					= 1,

	//!	Server-side contact list received →Caya
	//	Requires:	Stringlist "user_id"
	IM_CONTACT_LIST						= 2,

	//!	Contact(s) was added to the server-side list →Caya
	//	Requires:	String "user_id"
	IM_CONTACT_LIST_ADD_CONTACT			= 3,

	//!	Contact(s) removed from the server-side list →Caya
	//	Requires:	String "user_id"
	IM_CONTACT_LIST_REMOVED_CONTACT		= 4,


	/*
	 * Messages related to text chat.
	 */

	//!	Send a chat message				→Protocol
	//	Requires:	String "user_id", String "body"
	IM_SEND_MESSAGE						= 20,

	//!	Chat message has been sent		→Caya
	//	If no user_id is specified, it's treated as a system message
	//	Requires:	String "chat_id", String "body"
	//	Allows:		String "user_id"
	IM_MESSAGE_SENT						= 21,

	//!	Chat message received			→Caya
	//	Requires:	String "chat_id", String "user_id", String "body"
	IM_MESSAGE_RECEIVED					= 22,

	//!	Logs received					→Caya
	//	Without "when" (a time_t), the logged message will lack a timestamp
	//	Requires:	Strings "chat_id", Strings "user_id", Strings "body"
	//	Accepts:	in64s "when"
	IM_LOGS_RECEIVED					= 23,

	//!	User started typing				→Caya
	//	Requires:	String "chat_id", String "user_id"
	IM_USER_STARTED_TYPING				= 24,

	//!	User stopped typing				→Caya
	//	Requires:	String "chat_id", String "user_id"
	IM_USER_STOPPED_TYPING				= 25,


	/*
	 * Messages related to contact changes.
	 */

	//!	Change contact's status			→Protocol
	IM_SET_NICKNAME						= 40,

	//!	Contact's status has changed	→Caya
	IM_NICKNAME_SET						= 41,


	/*
	 * Messages related to contact's information received from protocols.
	 */

	//!	Received contact new status		→Caya
	//	Requires:	String "user_id", int32/CayaStatus "status"
	IM_STATUS_SET						= 60,

	//!	User's avatar icon was changed	→Caya
	//	Requires:	String "user_id", Ref "ref"
	IM_AVATAR_SET						= 61,

	//!	Get contact information			→Protocol
	IM_GET_CONTACT_INFO					= 62,

	//!	Received contact information	→Caya
	//	Requires:	String "user_id"
	//	Accepts:	String "user_name", String "message", int32/CayaStatus "status"
	IM_CONTACT_INFO						= 63,

	//!	Request contact information		→Protocol
	IM_GET_EXTENDED_CONTACT_INFO		= 64,

	//!	Received contact information	→Caya
	//	Requires:	String "user_id"
	//	Accepts:	String "user_name", String "full_name"
	IM_EXTENDED_CONTACT_INFO			= 65,


	/*
	 * Messages that involve changing own information.
	 */

	//!	Change own nickname				→Protocol
	//	Requires:	String "user_name"
	IM_SET_OWN_NICKNAME					= 80,

	//!	Own nickname was changed		→Caya
	IM_OWN_NICKNAME_SET					= 81,

	//!	Change own status				→Protocol
	//	Requires:	int32/CayaStatus "status"
	IM_SET_OWN_STATUS					= 82,

	//	Own status was changed			→Caya
	//	Requires:	int32/CayaStatus "status"
	IM_OWN_STATUS_SET					= 83,

	//!	Get own contact information
	//	Requires:	String "user_id"
	IM_OWN_CONTACT_INFO					= 84,

	//!	Change own avatar icon
	IM_SET_OWN_AVATAR					= 85,

	//!	Own avatar icon was changed
	//	 Requires:	Ref "ref"
	IM_OWN_AVATAR_SET					= 86,


	/*
	 * Contacts registration.
	 */

	//!	Start listening to changes in these contact's statuses
	IM_REGISTER_CONTACTS				= 100,

	//!	Stop listening to status changes from these contacts
	IM_UNREGISTER_CONTACTS				= 101,


	/*
	 * Authorization.
	 */

	//!	Ask authorization to contact
	IM_ASK_AUTHORIZATION				= 120,

	//!	Authorization response received from contact
	IM_AUTHORIZATION_RECEIVED			= 121,

	//!	Authorization request received from contact
	IM_AUTHORIZATION_REQUEST			= 122,

	//!	Authorization response given to contact
	IM_AUTHORIZATION_RESPONSE			= 123,

	//!	Contact has been authorized
	IM_CONTACT_AUTHORIZED				= 124,


	/*
	 * Miscellaneous.
	 */

	//!	Progress message received, could be login sequence, file transfer etc...
	IM_PROGRESS							= 140,

	//!	Notifications
	IM_NOTIFICATION						= 141,


	/*
	 * Room membership
	 */

	//!	Create an individual chat		→Protocol
	//	Individual chats and rooms are really the same thing (at least according
	//	to Caya)― the only difference is in how they're created and joined.
	//	A "chat" should be uniquely tied to a single user, and its chat_id
	//	should be derivable from the user's ID (when sent back from
	//	CHAT_CREATED). It doesn't matter how you get this done, really.
	//	Requires:	String "user_id"
	IM_CREATE_CHAT						= 150,

	//!	Chat has been created			→Caya
	//	Requires:	String "chat_id", String "user_id"
	IM_CHAT_CREATED						= 151,

	//!	Create a room					→Protocol
	//	The required slots for this message are completely determined by the
	//	protocol itself― the protocol will just receive data from the
	//	"room" template (which is fetched via
	//	CayaProtocol::SettingsTemplate("room")
	IM_CREATE_ROOM						= 152,

	//!	Inform Caya room was created	→Caya
	//	Just a semantically-dressed IM_ROOM_JOINED
	//	Requires:	String "chat_id"
	IM_ROOM_CREATED						= 153,

	//!	Join a room						→Protocol
	//	Requires:	String "chat_id"
	IM_JOIN_ROOM						= 154,

	//!	Confirm the room's been joined	→Caya
	//	Requires:	String "chat_id"
	IM_ROOM_JOINED						= 155,

	//!	User wants to leave the room	→Protocol
	//	Requires:	String "chat_id"
	IM_LEAVE_ROOM						= 156,

	//!	User left the room				→Caya
	//	Requires:	String "chat_id"
	IM_ROOM_LEFT						= 157,

	//! Request a room's userlist		→Protocol
	//	Requires:	String "chat_id"
	IM_GET_ROOM_PARTICIPANTS			= 158,

	//!	Quietly add user(s) to the chat	→Caya
	//	Shouldn't be sent automatically on joining a room.
	//	Requires:	String "chat_id", StringList "user_id"
	//	Accepts:	StringList "user_name"
	IM_ROOM_PARTICIPANTS				= 159,

	//!	User has explicitly joined		→Caya
	//	 Requires:	String "chat_id", String "user_id"
	//	 Accepts:	String "body"
	IM_ROOM_PARTICIPANT_JOINED			= 160,

	//!	A user left the room			→Caya
	//	Requires:	String "chat_id", String "user_id"
	//	Accepts:	String "user_name", String "body"
	IM_ROOM_PARTICIPANT_LEFT			= 161,

	//!	Invite a user to a room			→Protocol
	//	You can tell it succeded with IM_ROOM_PARTICIPANT_JOINED.
	//	Requires:	String "chat_id", String "user_id"
	//	Accepts:	String "body"
	IM_ROOM_SEND_INVITE					= 162,

	//!	Invitee explicitly refused		→Caya
	//	Requires:	String "chat_id", String "user_id"
	//	Accepts:	String "user_name", String "body"
	IM_ROOM_INVITE_REFUSED				= 163,

	//!	User was invited to a room		→Caya
	//	Requires:	String "chat_id"
	//	Accepts:	String "user_id", String "chat_name", String "body"
	IM_ROOM_INVITE_RECEIVED				= 164,

	//!	User accepted an invite			→Protocol
	//	Requires:	String "chat_id"
	IM_ROOM_INVITE_ACCEPT				= 165,

	//!	User denies an invite			→Protocol
	//	Requires:	String "chat_id"
	IM_ROOM_INVITE_REFUSE				= 166,


	/*
	 * Room metadata
	 */

	//!	Request a room's metadata		→Protocol
	//	Requires:	String "chat_id"
	IM_GET_ROOM_METADATA				= 170,

	//!	Receive room metadata			→Caya
	//	The idea is that all other metadata-related messages should only be
	//	called either from a request, or from a change.
	//	This shouldn't be sent automatically upon joining a room.
	//	Requires:	String "chat_id"
	//	Allows:		String "chat_name", String "subject",
	//				int32 "room_default_flags", int32 "room_disallowed_flags"
	IM_ROOM_METADATA					= 171,

	//!	Set the room name				→Protocol
	//	Requires:	String "chat_id", String "chat_name"
	IM_SET_ROOM_NAME					= 172,

	//!	Room name has changed			→Protocol
	//	Requires:	String "chat_id", String "chat_name"
	IM_ROOM_NAME_SET					= 173,

	//!	Set the room subject			→Caya
	//	Requires:	String "chat_id", String "subject"
	IM_SET_ROOM_SUBJECT					= 174,

	//!	Subject has been changed		→Caya
	//	Requires:	String "chat_id", String "subject"
	IM_ROOM_SUBJECT_SET					= 175,


	/*
	 * Room moderation
	 */

	//!	A user's role has been changed	→Caya
	//	Requires:	String "role_title", int32 "role_perms", int32 "role_priority"
	IM_ROOM_ROLECHANGED					= 190,

	//!	Kick user						→Protocol
	//	Requires:	String "chat_id", String "user_id"
	IM_ROOM_KICK_PARTICIPANT			= 191,

	//!	A user was kicked				→Caya
	//	Requires:	String "chat_id", String "user_id"
	//	Accepts:	String "user_name", String "body"
	IM_ROOM_PARTICIPANT_KICKED			= 192,

	//!	Ban user						→Protocol
	//	Requires:	String "chat_id", String "user_id"
	IM_ROOM_BAN_PARTICIPANT				= 193,

	//!	A user was banned				→Caya
	//	Requires:	String "chat_id", String "user_id"
	//	Accepts:	String "user_name", String "body"
	IM_ROOM_PARTICIPANT_BANNED			= 194,

	//!	Unban user →Protocol
	IM_ROOM_UNBAN_PARTICIPANT			= 195,

	//!	Mute user						→Protocol
	//	The result of this can be seen with IM_ROOM_ROLECHANGED.
	//	Requires:	String "chat_id", String "user_id"
	IM_ROOM_MUTE_PARTICIPANT			= 196,

	//!	Unmute user						→Protocol
	//	The result of this can be seen with IM_ROOM_ROLECHANGED.
	//	Requires:	String "chat_id", String "user_id"
	IM_ROOM_UNMUTE_PARTICIPANT			= 197,

	//!	Deafen							→Protocol
	//	The result of this can be seen with IM_ROOM_ROLECHANGED.
	//	Requires:	String "chat_id", String "user_id"
	IM_ROOM_DEAFEN_PARTICIPANT			= 198,

	//!	Allow to read messages			→Protocol
	//	The result of this can be seen with IM_ROOM_ROLECHANGED.
	//	Requires:	String "chat_id", String "user_id"
	IM_ROOM_UNDEAFEN_PARTICIPANT		= 199,


	/*
	 * Special messages
	 */

	//!	Special message forwarded to protocol
	IM_SPECIAL_TO_PROTOCOL				= 1000,

	//!	Special message forwarded from protocol
	IM_SPECIAL_FROM_PROTOCOL			= 1001,

	//!	Protocol is ready to receive messages
	IM_PROTOCOL_READY					= 1002,


	/*
	 * GUI-related messages
	 */

	//! Register a chat command			→Caya
	//	Just an archived ChatCommand; if "instance" isn't specified, the command
	//	is global, rather than protocol-only.
	//	Requires: String "_name", String "_desc", Bool "_proto",
	//			  Message "_msg", int32s "_argtype",
	//			  String "class" = "ChatCommand"
	//	Allowed:  int64 "instance"
	IM_REGISTER_COMMAND					= 1100,

	//! Register a pop-up item			→Caya
	//	Just an archived BMenuItem with extra slots; if "instance" isn't
	//	specified, the item is global, rather than protocol-only.
	//	Requires: String "_label", Message "_msg", String "class" = "BMenuItem"
	//			  Bool "x_to_protocol", Bool "x_priority", int32 "x_perms",
	//			  int32 "x_target_perms", int32 "x_target_antiperms"
	//	Allowed:  int64 "instance"
	IM_REGISTER_USERLIST_ITEM			= 1101,

	//! Register a pop-up item			→Caya
	//	Just an archived BMenuItem with extra slots; if "instance" isn't
	//	specified, the item is global, rather than protocol-only.
	//	Requires: String "_label", Message "_msg", String "class" = "BMenuItem"
	//			  Bool "x_to_protocol", int32 "x_perms"
	//	Allowed:  int64 "instance"
	IM_REGISTER_CHATLIST_ITEM			= 1102,

	//! Register a "Protocol" menu item	→Caya
	//	Just an archived BMenuItem with extra slots; it adds a menu item to
	//	the menubar's "Protocol" menu.
	//	Requires: String "_label", Message "_msg", String "class" = "BMenuItem"
	//			  Bool "x_to_protocol", int64 "instance"
	IM_REGISTER_MENUBAR_ITEM			= 1103
};


#endif	// _CAYA_PROTOCOL_MESSAGES_H