trunk/include/parse.h

/*
 *  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
 *
 *  Copyright (c) 1997-2014 ircd-hybrid development team
 *
 *  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 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
 */

/*! \file parse.h
 * \brief A header for the message parser.
 * \version $Id$
 */

#ifndef INCLUDED_parse_h
#define INCLUDED_parse_h

struct Client;


/*
 * m_functions execute protocol messages on this server:
 * int m_func(struct Client* client_p, struct Client* source_p, int parc, char* parv[]);
 *
 *    client_p    is always NON-NULL, pointing to a *LOCAL* client
 *            structure (with an open socket connected!). This
 *            identifies the physical socket where the message
 *            originated (or which caused the m_function to be
 *            executed--some m_functions may call others...).
 *
 *    source_p    is the source of the message, defined by the
 *            prefix part of the message if present. If not
 *            or prefix not found, then source_p==client_p.
 *
 *            (!IsServer(client_p)) => (client_p == source_p), because
 *            prefixes are taken *only* from servers...
 *
 *            (IsServer(client_p))
 *                    (source_p == client_p) => the message didn't
 *                    have the prefix.
 *
 *                    (source_p != client_p && IsServer(source_p) means
 *                    the prefix specified servername. (?)
 *
 *                    (source_p != client_p && !IsServer(source_p) means
 *                    that message originated from a remote
 *                    user (not local).
 *
 *
 *            combining
 *
 *            (!IsServer(source_p)) means that, source_p can safely
 *            taken as defining the target structure of the
 *            message in this server.
 *
 *    *Always* true (if 'parse' and others are working correct):
 *
 *    1)      source_p->from == client_p  (note: client_p->from == client_p)
 *
 *    2)      MyConnect(source_p) <=> source_p == client_p (e.g. source_p
 *            *cannot* be a local connection, unless it's
 *            actually client_p!). [MyConnect(x) should probably
 *            be defined as (x == x->from) --msa ]
 *
 *    parc    number of variable parameter strings (if zero,
 *            parv is allowed to be NULL)
 *
 *    parv    a NULL terminated list of parameter pointers,
 *
 *                    parv[0], sender (prefix string), if not present
 *                            this points to an empty string.
 *                    parv[1]...parv[parc-1]
 *                            pointers to additional parameters
 *                    parv[parc] == NULL, *always*
 *
 *            note:   it is guaranteed that parv[0]..parv[parc-1] are all
 *                    non-NULL pointers.
 */

/*
 * MessageHandler
 */
typedef enum HandlerType {
  UNREGISTERED_HANDLER,
  CLIENT_HANDLER,
  SERVER_HANDLER,
  ENCAP_HANDLER,
  OPER_HANDLER,
  DUMMY_HANDLER,
  LAST_HANDLER_TYPE
} HandlerType;

/*
 * MessageHandler function
 * Params:
 * struct Client* client_p   - connection message originated from
 * struct Client* source_p   - source of message, may be different from client_p
 * int            parc   - parameter count
 * char*          parv[] - parameter vector
 */
typedef int (*MessageHandler)(struct Client *, struct Client *, int, char *[]);

/*
 * Message table structure
 */
struct Message
{
  const char *cmd;
  unsigned int count;      /* number of times command used */
  unsigned int rcount;     /* number of times command used by server */
  unsigned int args_min; /* at least this many args must be passed
                             * or an error will be sent to the user
                             * before the m_func is even called
                             */
  unsigned int args_max;    /* maximum permitted parameters */
  unsigned int flags;      /* bit 0 set means that this command is allowed
                             * to be used only on the average of once per 2
                             * seconds -SRB
                             */
  uint64_t bytes;  /* bytes received for this message */

  /*
   * client_p = Connected client ptr
   * source_p = Source client ptr
   * parc = parameter count
   * parv = parameter variable array
   */
  /* handlers:
   * UNREGISTERED, CLIENT, SERVER, ENCAP, OPER, DUMMY, LAST
   */
  MessageHandler handlers[LAST_HANDLER_TYPE];
};

/*
 * Constants
 */
#define   MFLG_SLOW             0x001   /* Command can be executed roughly
                                         * once per 2 seconds.
                                         */
#define MAXPARA    15

extern void parse(struct Client *, char *, char *);
extern void mod_add_cmd(struct Message *);
extern void mod_del_cmd(struct Message *);
extern struct Message *find_command(const char *);
extern void report_messages(struct Client *);

/* generic handlers */
extern int m_ignore(struct Client *, struct Client *, int, char *[]);
extern int m_not_oper(struct Client *, struct Client *, int, char *[]);
extern int m_registered(struct Client *, struct Client *, int, char *[]);
extern int m_unregistered(struct Client *, struct Client *, int, char *[]);
#endif /* INCLUDED_parse_h */
Revision:	2865
Committed:	Sun Jan 19 14:35:22 2014 UTC (11 years, 7 months ago) by michael
Content type:	text/x-chdr
File size:	5875 byte(s)
Log Message:	- Clean up all files in include/ (fixed indentation, removed whitespaces/tabs) - Fixed copyright years
#	Content
1	/*
2	* ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3	*
4	* Copyright (c) 1997-2014 ircd-hybrid development team
5	*
6	* This program is free software; you can redistribute it and/or modify
7	* it under the terms of the GNU General Public License as published by
8	* the Free Software Foundation; either version 2 of the License, or
9	* (at your option) any later version.
10	*
11	* This program is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with this program; if not, write to the Free Software
18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19	* USA
20	*/
21
22	/*! \file parse.h
23	* \brief A header for the message parser.
24	* \version $Id$
25	*/
26
27	#ifndef INCLUDED_parse_h
28	#define INCLUDED_parse_h
29
30	struct Client;
31
32
33	/*
34	* m_functions execute protocol messages on this server:
35	* int m_func(struct Client* client_p, struct Client* source_p, int parc, char* parv[]);
36	*
37	* client_p is always NON-NULL, pointing to a LOCAL client
38	* structure (with an open socket connected!). This
39	* identifies the physical socket where the message
40	* originated (or which caused the m_function to be
41	* executed--some m_functions may call others...).
42	*
43	* source_p is the source of the message, defined by the
44	* prefix part of the message if present. If not
45	* or prefix not found, then source_p==client_p.
46	*
47	* (!IsServer(client_p)) => (client_p == source_p), because
48	* prefixes are taken only from servers...
49	*
50	* (IsServer(client_p))
51	* (source_p == client_p) => the message didn't
52	* have the prefix.
53	*
54	* (source_p != client_p && IsServer(source_p) means
55	* the prefix specified servername. (?)
56	*
57	* (source_p != client_p && !IsServer(source_p) means
58	* that message originated from a remote
59	* user (not local).
60	*
61	*
62	* combining
63	*
64	* (!IsServer(source_p)) means that, source_p can safely
65	* taken as defining the target structure of the
66	* message in this server.
67	*
68	* Always true (if 'parse' and others are working correct):
69	*
70	* 1) source_p->from == client_p (note: client_p->from == client_p)
71	*
72	* 2) MyConnect(source_p) <=> source_p == client_p (e.g. source_p
73	* cannot be a local connection, unless it's
74	* actually client_p!). [MyConnect(x) should probably
75	* be defined as (x == x->from) --msa ]
76	*
77	* parc number of variable parameter strings (if zero,
78	* parv is allowed to be NULL)
79	*
80	* parv a NULL terminated list of parameter pointers,
81	*
82	* parv[0], sender (prefix string), if not present
83	* this points to an empty string.
84	* parv[1]...parv[parc-1]
85	* pointers to additional parameters
86	* parv[parc] == NULL, always
87	*
88	* note: it is guaranteed that parv[0]..parv[parc-1] are all
89	* non-NULL pointers.
90	*/
91
92	/*
93	* MessageHandler
94	*/
95	typedef enum HandlerType {
96	UNREGISTERED_HANDLER,
97	CLIENT_HANDLER,
98	SERVER_HANDLER,
99	ENCAP_HANDLER,
100	OPER_HANDLER,
101	DUMMY_HANDLER,
102	LAST_HANDLER_TYPE
103	} HandlerType;
104
105	/*
106	* MessageHandler function
107	* Params:
108	* struct Client* client_p - connection message originated from
109	* struct Client* source_p - source of message, may be different from client_p
110	* int parc - parameter count
111	* char* parv[] - parameter vector
112	*/
113	typedef int (MessageHandler)(struct Client , struct Client , int, char []);
114
115	/*
116	* Message table structure
117	*/
118	struct Message
119	{
120	const char *cmd;
121	unsigned int count; /* number of times command used */
122	unsigned int rcount; /* number of times command used by server */
123	unsigned int args_min; /* at least this many args must be passed
124	* or an error will be sent to the user
125	* before the m_func is even called
126	*/
127	unsigned int args_max; /* maximum permitted parameters */
128	unsigned int flags; /* bit 0 set means that this command is allowed
129	* to be used only on the average of once per 2
130	* seconds -SRB
131	*/
132	uint64_t bytes; /* bytes received for this message */
133
134	/*
135	* client_p = Connected client ptr
136	* source_p = Source client ptr
137	* parc = parameter count
138	* parv = parameter variable array
139	*/
140	/* handlers:
141	* UNREGISTERED, CLIENT, SERVER, ENCAP, OPER, DUMMY, LAST
142	*/
143	MessageHandler handlers[LAST_HANDLER_TYPE];
144	};
145
146	/*
147	* Constants
148	*/
149	#define MFLG_SLOW 0x001 /* Command can be executed roughly
150	* once per 2 seconds.
151	*/
152	#define MAXPARA 15
153
154	extern void parse(struct Client , char , char *);
155	extern void mod_add_cmd(struct Message *);
156	extern void mod_del_cmd(struct Message *);
157	extern struct Message find_command(const char );
158	extern void report_messages(struct Client *);
159
160	/* generic handlers */
161	extern int m_ignore(struct Client , struct Client , int, char *[]);
162	extern int m_not_oper(struct Client , struct Client , int, char *[]);
163	extern int m_registered(struct Client , struct Client , int, char *[]);
164	extern int m_unregistered(struct Client , struct Client , int, char *[]);
165	#endif /* INCLUDED_parse_h */