/*
 * Copyright © 2005 William Pitcock, et al.
 * Rights to this code are as documented in doc/pod/license.pod.
 *
 * Protocol handlers, both generic and the actual declarations themselves.
 *
 * $Id: phandler.h,v 1.3 2007/07/21 13:23:18 pippijn Exp $
 */

#ifndef PHANDLER_H
#define PHANDLER_H

struct ircd_t
{
  char *ircdname;
  char *tldprefix;
  bool uses_uid;
  bool uses_rcommand;
  bool uses_owner;
  bool uses_protect;
  bool uses_halfops;
  bool uses_p10;		/* Parser hackhack. */
  bool uses_vhost;		/* Do we use vHosts? */
  unsigned int oper_only_modes;
  unsigned int owner_mode;
  unsigned int protect_mode;
  unsigned int halfops_mode;
  char *owner_mchar;
  char *protect_mchar;
  char *halfops_mchar;
  unsigned int type;
  unsigned int perm_mode;	/* Modes to not disappear when empty */
  char *ban_like_modes;		/* e.g. "beI" */
  char except_mchar;
  char invex_mchar;
  int flags;
};

/* values for type */
/*  -- what the HELL are these used for? A grep reveals nothing.. --w00t
 *  -- they are used to provide a hint to third-party module coders about what
 *     ircd they are working with. --nenolod
 */
#define PROTOCOL_ASUKA			1
#define PROTOCOL_BAHAMUT		2
#define PROTOCOL_CHARYBDIS		3
#define PROTOCOL_DREAMFORGE		4
#define PROTOCOL_HYPERION		5
#define PROTOCOL_INSPIRCD		6
#define PROTOCOL_IRCNET			7
#define PROTOCOL_MONKEY			8	/* obsolete */
#define PROTOCOL_PLEXUS			9
#define PROTOCOL_PTLINK			10
#define PROTOCOL_RATBOX			11
#define PROTOCOL_SCYLLA			12
#define PROTOCOL_SHADOWIRCD		13
#define PROTOCOL_SORCERY		14
#define PROTOCOL_ULTIMATE3		15
#define PROTOCOL_UNDERNET		16
#define PROTOCOL_UNREAL			17
#define PROTOCOL_SOLIDIRCD		18
#define PROTOCOL_NEFARIOUS		19
#define PROTOCOL_OFFICEIRC		20

#define PROTOCOL_OTHER			255

/* values for flags */
#define IRCD_CIDR_BANS			1

/* forced nick change types */
#define FNC_REGAIN 0		/* give a registered user their nick back */
#define FNC_FORCE  1		/* force a user off their nick (kill if unsupported) */

/* server login, usually sends PASS, CAPAB, SERVER and SVINFO
 * you can still change ircd->uses_uid at this point
 * set me.bursting = true
 * return 1 if sts() failed (by returning 1), otherwise 0 */
E unsigned int (*server_login) (void);
/* introduce a client on the services server */
E void (*introduce_nick) (user_t *u);
/* send an invite for a given user to a channel
 * the source may not be on the channel */
E void (*invite_sts) (user_t *source, user_t *target, channel_t *channel);
/* quit a client on the services server with the given message */
E void (*quit_sts) (user_t *u, const char *reason);
/* send wallops
 * use something that only opers can see if easily possible */
E void (*wallops_sts) (const char *text);
/* join a channel with a client on the services server
 * the client should be introduced opped
 * isnew indicates the channel modes (and bans XXX) should be bursted
 * note that the channelts can still be old in this case (e.g. kills)
 * modes is a convenience argument giving the simple modes with parameters
 * do not rely upon chanuser_find(c,u) */
E void (*join_sts) (channel_t *c, user_t *u, bool isnew, char *modes);
/* lower the TS of a channel, joining it with the given client on the
 * services server (opped), replacing the current simple modes with the
 * ones stored in the channel_t and clearing all other statuses
 * if bans are timestamped on this ircd, call chanban_clear()
 * if the topic is timestamped on this ircd, clear it */
E void (*chan_lowerts) (channel_t *c, user_t *u);
/* kick a user from a channel
 * from is a client on the services server which may or may not be
 * on the channel */
E void (*kick) (char *from, char *channel, char *to, char *reason);
/* change ircd metadata */
E void (*mdchange) (const char *target, const char *key, const char *value);
/* send a privmsg
 * here it's ok to assume the source is able to send */
E void (*msg) (const char *from, const char *target, const char *fmt, ...);
/* send a notice to a user
 * from can be a client on the services server or the services server
 * itself (NULL) */
E void (*notice_user_sts) (user_t *from, user_t *target, const char *text);
/* send a global notice to all users on servers matching the mask
 * from is a client on the services server
 * mask is either "*" or it has a non-wildcard TLD */
E void (*notice_global_sts) (user_t *from, const char *mask, const char *text);
/* send a notice to a channel
 * from can be a client on the services server or the services server
 * itself (NULL)
 * if the source cannot send because it is not on the channel, send the
 * notice from the server or join for a moment */
E void (*notice_channel_sts) (user_t *from, channel_t *target, const char *text);
/* send a notice to ops in a channel
 * source may or may not be on channel
 * generic_wallchops() sends an individual notice to each channel operator */
E void (*wallchops) (user_t *source, channel_t *target, const char *message);
/* send a numeric from must be me.name or ME */
E void (*numeric_sts) (char *from, int numeric, char *target, char *fmt, ...);
/* kill a user
 * from can be a client on the services server or the services server
 * itself (me.name or ME)
 * it is recommended to change an invalid source to ME */
E void (*skill) (char *from, char *nick, char *fmt, ...);
/* part a channel with a client on the services server */
E void (*part_sts) (channel_t *c, user_t *u);
/* add a kline on the servers matching the given mask
 * duration is in seconds, 0 for a permanent kline
 * if the ircd requires klines to be sent from users, use opersvs */
E void (*kline_sts) (char *server, char *user, char *host, long duration, char *reason);
/* remove a kline on the servers matching the given mask
 * if the ircd requires unklines to be sent from users, use opersvs */
E void (*unkline_sts) (char *server, char *user, char *host);
/* make chanserv set a topic on a channel
 * setter and ts should be used if the ircd supports topics to be set
 * with a given topicsetter and topicts; ts is not a channelts
 * prevts is the topicts of the old topic or 0 if there was no topic,
 * useful in optimizing which form of topic change to use
 * if the given topicts was not set and topicts is used on the ircd,
 * set c->topicts to the value used */
E void (*topic_sts) (channel_t *c, const char *setter, time_t ts, time_t prevts, const char *topic);
/* set modes on a channel by the given sender; sender must be a client
 * on the services server; sender may or may not be on channel */
E void (*mode_sts) (char *sender, channel_t *target, char *modes);
/* ping the uplink
 * first check if me.connected is true and bail if not */
E void (*ping_sts) (void);
/* mark user 'origin' as logged in as 'user'
 * wantedhost is currently not used
 * first check if me.connected is true and bail if not */
E void (*ircd_on_login) (char *origin, char *user, char *wantedhost);
/* mark user 'origin' as logged out
 * first check if me.connected is true and bail if not
 * return false if successful or logins are not supported
 * return true if the user was killed to force logout (P10) */
E bool (*ircd_on_logout) (char *origin, char *user, char *wantedhost);
/* introduce a fake server
 * it is ok to use opersvs to squit the old server
 * if SQUIT uses kill semantics (e.g. charybdis), server_delete() the server
 * and continue
 * if SQUIT uses unconnect semantics (e.g. bahamut), set SF_JUPE_PENDING on
 * the server and return; you will be called again when the server is really
 * deleted */
E void (*jupe) (const char *server, const char *reason);
/* set a dynamic spoof on a user
 * if the ircd does not notify the user of this, do
 * notice(source, target, "Setting your host to \2%s\2.", host); */
E void (*sethost_sts) (char *source, char *target, char *host);
/* force a nickchange for a user
 * possible values for type:
 * FNC_REGAIN: give a registered user their nick back
 * FNC_FORCE:  force a user off their nick (kill if unsupported)
 */
E void (*fnc_sts) (user_t *source, user_t *u, char *newnick, int type);
/* temporarily make a nick unavailable to users
 * source is the responsible service
 * duration is in seconds, 0 to remove the effect of a previous call
 * account is an account that may still use the nick, or NULL */
E void (*holdnick_sts) (user_t *source, int duration, const char *nick, myuser_t *account);
/* change nick, user, host and/or services login name for a user
 * target may also be a not yet fully introduced UID (for SASL) */
E void (*svslogin_sts) (char *target, char *nick, char *user, char *host, char *login);
/* send sasl message */
E void (*sasl_sts) (char *target, char mode, char *data);
/* find next channel ban (or other ban-like mode) matching user */
E node_t *(*next_matching_ban) (channel_t *c, user_t *u, int type, node_t *first);
/* find next host channel access matching user */
E node_t *(*next_matching_host_chanacs) (mychan_t *mc, user_t *u, node_t *first);

// These two are used in some protocol modules
E void generic_wallchops (user_t *source, channel_t *target, const char *message);
E void generic_fnc_sts (user_t *source, user_t *u, char *newnick, int type);

E cmode_t *mode_list;
E extmode *ignore_mode_list;
E cmode_t *status_mode_list;
E cmode_t *prefix_mode_list;

E ircd_t *ircd;

#endif