[irc/quakenet/snircd.git] / include / ircd_features.h

#ifndef INCLUDED_features_h
#define INCLUDED_features_h
/*
 * IRC - Internet Relay Chat, include/features.h
 * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
 *
 * 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, 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
/** @file
 * @brief Public interfaces and declarations for dealing with configurable features.
 * @version $Id: ircd_features.h,v 1.38.2.5 2006/02/16 03:49:54 entrope Exp $
 */

struct Client;
struct StatDesc;

extern struct Client his;

/** Contains all feature settings for ircu.
 * For documentation of each, see doc/readme.features.
 */
enum Feature {
  /* Misc. features */
  FEAT_LOG,
  FEAT_DOMAINNAME,
  FEAT_RELIABLE_CLOCK,
  FEAT_BUFFERPOOL,
  FEAT_HAS_FERGUSON_FLUSHER,
  FEAT_CLIENT_FLOOD,
  FEAT_SERVER_PORT,
  FEAT_NODEFAULTMOTD,
  FEAT_MOTD_BANNER,
  FEAT_PROVIDER,
  FEAT_KILL_IPMISMATCH,
  FEAT_IDLE_FROM_MSG,
  FEAT_HUB,
  FEAT_WALLOPS_OPER_ONLY,
  FEAT_NODNS,
  FEAT_RANDOM_SEED,
  FEAT_DEFAULT_LIST_PARAM,
  FEAT_NICKNAMEHISTORYLENGTH,
  FEAT_HOST_HIDING,
  FEAT_HIDDEN_HOST,
  FEAT_HIDDEN_IP,
  FEAT_AUTOINVISIBLE,
  FEAT_CONNEXIT_NOTICES,
  FEAT_USER_HIDECHANS,
  FEAT_OPLEVELS,
  FEAT_ZANNELS,
  FEAT_LOCAL_CHANNELS,
  FEAT_TOPIC_BURST,
  FEAT_AUTOCHANMODES,
  FEAT_AUTOCHANMODES_LIST,

  /* features that probably should not be touched */
  FEAT_KILLCHASETIMELIMIT,
  FEAT_MAXCHANNELSPERUSER,
  FEAT_NICKLEN,
  FEAT_AVBANLEN,
  FEAT_MAXBANS,
  FEAT_MAXSILES,
  FEAT_HANGONGOODLINK,
  FEAT_HANGONRETRYDELAY,
  FEAT_CONNECTTIMEOUT,
  FEAT_MAXIMUM_LINKS,
  FEAT_PINGFREQUENCY,
  FEAT_CONNECTFREQUENCY,
  FEAT_DEFAULTMAXSENDQLENGTH,
  FEAT_GLINEMAXUSERCOUNT,
  FEAT_SOCKSENDBUF,
  FEAT_SOCKRECVBUF,
  FEAT_IPCHECK_CLONE_LIMIT,
  FEAT_IPCHECK_CLONE_PERIOD,
  FEAT_IPCHECK_CLONE_DELAY,
  FEAT_CHANNELLEN,

  /* Some misc. default paths */
  FEAT_MPATH,
  FEAT_RPATH,
  FEAT_PPATH,

  /* Networking features */
  FEAT_TOS_SERVER,
  FEAT_TOS_CLIENT,
  FEAT_POLLS_PER_LOOP,
  FEAT_IRCD_RES_RETRIES,
  FEAT_IRCD_RES_TIMEOUT,
  FEAT_AUTH_TIMEOUT,
  FEAT_ANNOUNCE_INVITES,

  /* features that affect all operators */
  FEAT_EXTENDED_CHECKCMD,
  FEAT_CONFIG_OPERCMDS,
  FEAT_SETHOST,
  FEAT_SETHOST_FREEFORM,
  FEAT_SETHOST_USER,
  FEAT_SETHOST_AUTO,

  /* HEAD_IN_SAND Features */
  FEAT_HIS_SNOTICES,
  FEAT_HIS_SNOTICES_OPER_ONLY,
  FEAT_HIS_DEBUG_OPER_ONLY,
  FEAT_HIS_WALLOPS,
  FEAT_HIS_MAP,
  FEAT_HIS_LINKS,
  FEAT_HIS_TRACE,
  FEAT_HIS_STATS_a,
  FEAT_HIS_STATS_c,
  FEAT_HIS_STATS_d,
  FEAT_HIS_STATS_e,
  FEAT_HIS_STATS_f,
  FEAT_HIS_STATS_g,
  FEAT_HIS_STATS_i,
  FEAT_HIS_STATS_j,
  FEAT_HIS_STATS_J,
  FEAT_HIS_STATS_k,
  FEAT_HIS_STATS_l,
  FEAT_HIS_STATS_L,
  FEAT_HIS_STATS_M,
  FEAT_HIS_STATS_m,
  FEAT_HIS_STATS_o,
  FEAT_HIS_STATS_p,
  FEAT_HIS_STATS_q,
  FEAT_HIS_STATS_R,
  FEAT_HIS_STATS_r,
  FEAT_HIS_STATS_s,
  FEAT_HIS_STATS_t,
  FEAT_HIS_STATS_T,
  FEAT_HIS_STATS_u,
  FEAT_HIS_STATS_U,
  FEAT_HIS_STATS_v,
  FEAT_HIS_STATS_w,
  FEAT_HIS_STATS_x,
  FEAT_HIS_STATS_y,
  FEAT_HIS_STATS_z,
  FEAT_HIS_STATS_IAUTH,
  FEAT_HIS_WHOIS_SERVERNAME,
  FEAT_HIS_WHOIS_IDLETIME,
  FEAT_HIS_WHOIS_LOCALCHAN,
  FEAT_HIS_WHO_SERVERNAME,
  FEAT_HIS_WHO_HOPCOUNT,
  FEAT_HIS_WHO_FILTERIP,
  FEAT_HIS_MODEWHO,
  FEAT_HIS_BANWHO,
  FEAT_HIS_KILLWHO,
  /* Asuka - Reimplement HEAD_IN_SAND_GLINE from Lain */
  FEAT_HIS_GLINE,
  FEAT_HIS_REWRITE,
  FEAT_HIS_REMOTE,
  FEAT_HIS_NETSPLIT,
  FEAT_HIS_SERVERNAME,
  FEAT_HIS_SERVERINFO,
  FEAT_HIS_URLSERVERS,
  FEAT_HIS_USERGLINE,

  /* Misc. random stuff */
  FEAT_NETWORK,
  FEAT_URL_CLIENTS,

  FEAT_LAST_F
};

extern void feature_init(void);

extern int feature_set(struct Client* from, const char* const* fields,
		       int count);
extern int feature_reset(struct Client* from, const char* const* fields,
			 int count);
extern int feature_get(struct Client* from, const char* const* fields,
		       int count);

extern void feature_unmark(void);
extern void feature_mark(void);

extern void feature_report(struct Client* to, const struct StatDesc* sd,
                           char* param);

extern int feature_int(enum Feature feat);
extern int feature_bool(enum Feature feat);
extern const char *feature_str(enum Feature feat);

#endif /* INCLUDED_features_h */
Commit	Line	Data
189935b1	1	#ifndef INCLUDED_features_h
	2	#define INCLUDED_features_h
	3	/*
	4	* IRC - Internet Relay Chat, include/features.h
	5	* Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2, or (at your option)
	10	* any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	20	*/
	21	/** @file
	22	* @brief Public interfaces and declarations for dealing with configurable features.
9f8856e9	23	* @version $Id: ircd_features.h,v 1.38.2.5 2006/02/16 03:49:54 entrope Exp $
189935b1	24	*/
	25
	26	struct Client;
	27	struct StatDesc;
	28
	29	extern struct Client his;
	30
	31	/** Contains all feature settings for ircu.
	32	* For documentation of each, see doc/readme.features.
	33	*/
	34	enum Feature {
	35	/* Misc. features */
	36	FEAT_LOG,
	37	FEAT_DOMAINNAME,
	38	FEAT_RELIABLE_CLOCK,
	39	FEAT_BUFFERPOOL,
	40	FEAT_HAS_FERGUSON_FLUSHER,
	41	FEAT_CLIENT_FLOOD,
	42	FEAT_SERVER_PORT,
	43	FEAT_NODEFAULTMOTD,
	44	FEAT_MOTD_BANNER,
	45	FEAT_PROVIDER,
	46	FEAT_KILL_IPMISMATCH,
	47	FEAT_IDLE_FROM_MSG,
	48	FEAT_HUB,
	49	FEAT_WALLOPS_OPER_ONLY,
	50	FEAT_NODNS,
	51	FEAT_RANDOM_SEED,
	52	FEAT_DEFAULT_LIST_PARAM,
	53	FEAT_NICKNAMEHISTORYLENGTH,
	54	FEAT_HOST_HIDING,
	55	FEAT_HIDDEN_HOST,
	56	FEAT_HIDDEN_IP,
d8e74551	57	FEAT_AUTOINVISIBLE,
189935b1	58	FEAT_CONNEXIT_NOTICES,
d8e74551	59	FEAT_USER_HIDECHANS,
189935b1	60	FEAT_OPLEVELS,
052b069e	61	FEAT_ZANNELS,
189935b1	62	FEAT_LOCAL_CHANNELS,
189935b1	63	FEAT_TOPIC_BURST,
d8e74551	64	FEAT_AUTOCHANMODES,
d8e74551	65	FEAT_AUTOCHANMODES_LIST,
189935b1	66
	67	/* features that probably should not be touched */
	68	FEAT_KILLCHASETIMELIMIT,
	69	FEAT_MAXCHANNELSPERUSER,
	70	FEAT_NICKLEN,
	71	FEAT_AVBANLEN,
	72	FEAT_MAXBANS,
	73	FEAT_MAXSILES,
	74	FEAT_HANGONGOODLINK,
	75	FEAT_HANGONRETRYDELAY,
	76	FEAT_CONNECTTIMEOUT,
	77	FEAT_MAXIMUM_LINKS,
	78	FEAT_PINGFREQUENCY,
	79	FEAT_CONNECTFREQUENCY,
	80	FEAT_DEFAULTMAXSENDQLENGTH,
	81	FEAT_GLINEMAXUSERCOUNT,
	82	FEAT_SOCKSENDBUF,
	83	FEAT_SOCKRECVBUF,
	84	FEAT_IPCHECK_CLONE_LIMIT,
	85	FEAT_IPCHECK_CLONE_PERIOD,
	86	FEAT_IPCHECK_CLONE_DELAY,
	87	FEAT_CHANNELLEN,
	88
	89	/* Some misc. default paths */
	90	FEAT_MPATH,
	91	FEAT_RPATH,
	92	FEAT_PPATH,
	93
	94	/* Networking features */
	95	FEAT_TOS_SERVER,
	96	FEAT_TOS_CLIENT,
	97	FEAT_POLLS_PER_LOOP,
	98	FEAT_IRCD_RES_RETRIES,
	99	FEAT_IRCD_RES_TIMEOUT,
	100	FEAT_AUTH_TIMEOUT,
	101	FEAT_ANNOUNCE_INVITES,
	102
	103	/* features that affect all operators */
d8e74551	104	FEAT_EXTENDED_CHECKCMD,
189935b1	105	FEAT_CONFIG_OPERCMDS,
d8e74551	106	FEAT_SETHOST,
	107	FEAT_SETHOST_FREEFORM,
	108	FEAT_SETHOST_USER,
	109	FEAT_SETHOST_AUTO,
189935b1	110
	111	/* HEAD_IN_SAND Features */
	112	FEAT_HIS_SNOTICES,
	113	FEAT_HIS_SNOTICES_OPER_ONLY,
	114	FEAT_HIS_DEBUG_OPER_ONLY,
	115	FEAT_HIS_WALLOPS,
	116	FEAT_HIS_MAP,
	117	FEAT_HIS_LINKS,
	118	FEAT_HIS_TRACE,
	119	FEAT_HIS_STATS_a,
	120	FEAT_HIS_STATS_c,
	121	FEAT_HIS_STATS_d,
	122	FEAT_HIS_STATS_e,
	123	FEAT_HIS_STATS_f,
	124	FEAT_HIS_STATS_g,
	125	FEAT_HIS_STATS_i,
	126	FEAT_HIS_STATS_j,
	127	FEAT_HIS_STATS_J,
	128	FEAT_HIS_STATS_k,
	129	FEAT_HIS_STATS_l,
	130	FEAT_HIS_STATS_L,
	131	FEAT_HIS_STATS_M,
	132	FEAT_HIS_STATS_m,
	133	FEAT_HIS_STATS_o,
	134	FEAT_HIS_STATS_p,
	135	FEAT_HIS_STATS_q,
	136	FEAT_HIS_STATS_R,
	137	FEAT_HIS_STATS_r,
d8e74551	138	FEAT_HIS_STATS_s,
189935b1	139	FEAT_HIS_STATS_t,
	140	FEAT_HIS_STATS_T,
	141	FEAT_HIS_STATS_u,
	142	FEAT_HIS_STATS_U,
	143	FEAT_HIS_STATS_v,
	144	FEAT_HIS_STATS_w,
	145	FEAT_HIS_STATS_x,
	146	FEAT_HIS_STATS_y,
	147	FEAT_HIS_STATS_z,
9f8856e9	148	FEAT_HIS_STATS_IAUTH,
189935b1	149	FEAT_HIS_WHOIS_SERVERNAME,
	150	FEAT_HIS_WHOIS_IDLETIME,
	151	FEAT_HIS_WHOIS_LOCALCHAN,
	152	FEAT_HIS_WHO_SERVERNAME,
	153	FEAT_HIS_WHO_HOPCOUNT,
d8e74551	154	FEAT_HIS_WHO_FILTERIP,
052b069e	155	FEAT_HIS_MODEWHO,
189935b1	156	FEAT_HIS_BANWHO,
189935b1	157	FEAT_HIS_KILLWHO,
d8e74551	158	/* Asuka - Reimplement HEAD_IN_SAND_GLINE from Lain */
d8e74551	159	FEAT_HIS_GLINE,
189935b1	160	FEAT_HIS_REWRITE,
	161	FEAT_HIS_REMOTE,
	162	FEAT_HIS_NETSPLIT,
	163	FEAT_HIS_SERVERNAME,
	164	FEAT_HIS_SERVERINFO,
	165	FEAT_HIS_URLSERVERS,
d8e74551	166	FEAT_HIS_USERGLINE,
189935b1	167
	168	/* Misc. random stuff */
	169	FEAT_NETWORK,
	170	FEAT_URL_CLIENTS,
	171
	172	FEAT_LAST_F
	173	};
	174
	175	extern void feature_init(void);
	176
	177	extern int feature_set(struct Client* from, const char* const* fields,
	178	int count);
	179	extern int feature_reset(struct Client* from, const char* const* fields,
	180	int count);
	181	extern int feature_get(struct Client* from, const char* const* fields,
	182	int count);
	183
	184	extern void feature_unmark(void);
	185	extern void feature_mark(void);
	186
	187	extern void feature_report(struct Client* to, const struct StatDesc* sd,
	188	char* param);
	189
	190	extern int feature_int(enum Feature feat);
	191	extern int feature_bool(enum Feature feat);
	192	extern const char *feature_str(enum Feature feat);
	193
	194	#endif /* INCLUDED_features_h */