mirror of
https://github.com/matrix-construct/construct
synced 2024-11-03 12:28:52 +01:00
3c7d6fcce7
Also fix up some return values and stuff to use bool (or void if nothing). I just did it whilst I was here. According to jilles, the return value used to signify whether or not the client had exited. This was error-prone and was fixed a long, long time ago, but the return value was left int for historical reasons. Since the return type is not used (and has no clear use case anyway), it's safe to just get rid of it.
145 lines
5.1 KiB
C
145 lines
5.1 KiB
C
/*
|
|
* ircd-ratbox: A slightly useful ircd.
|
|
* msg.h: A header for the message handler structure.
|
|
*
|
|
* Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
|
|
* Copyright (C) 1996-2002 Hybrid Development Team
|
|
* Copyright (C) 2002-2004 ircd-ratbox 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
|
|
*/
|
|
|
|
#ifndef INCLUDED_msg_h
|
|
#define INCLUDED_msg_h
|
|
|
|
#include "config.h"
|
|
#include "msgbuf.h"
|
|
|
|
struct Client;
|
|
|
|
/* MessageHandler */
|
|
typedef enum HandlerType
|
|
{
|
|
UNREGISTERED_HANDLER,
|
|
CLIENT_HANDLER,
|
|
RCLIENT_HANDLER,
|
|
SERVER_HANDLER,
|
|
ENCAP_HANDLER,
|
|
OPER_HANDLER,
|
|
LAST_HANDLER_TYPE
|
|
}
|
|
HandlerType;
|
|
|
|
/* struct MsgBuf* msgbuf_p - message buffer (including tags)
|
|
* 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 (from msgbuf_p)
|
|
* char* parv[] - parameter vector (from msgbuf_p)
|
|
*/
|
|
typedef void (*MessageHandler) (struct MsgBuf *, struct Client *, struct Client *, int, const char *[]);
|
|
|
|
struct MessageEntry
|
|
{
|
|
MessageHandler handler;
|
|
int min_para;
|
|
};
|
|
|
|
/* 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 long bytes; /* bytes received for this message */
|
|
unsigned int flags;
|
|
|
|
/* handlers:
|
|
* UNREGISTERED, CLIENT, RCLIENT, SERVER, OPER, LAST
|
|
*/
|
|
struct MessageEntry handlers[LAST_HANDLER_TYPE];
|
|
};
|
|
|
|
/* generic handlers */
|
|
extern void m_ignore(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
extern void m_not_oper(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
extern void m_registered(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
extern void m_unregistered(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
|
|
#define mg_ignore { m_ignore, 0 }
|
|
#define mg_not_oper { m_not_oper, 0 }
|
|
#define mg_reg { m_registered, 0 }
|
|
#define mg_unreg { m_unregistered, 0 }
|
|
|
|
/*
|
|
* m_functions execute protocol messages on this server:
|
|
* void 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], unused for historical reasons (formerly
|
|
* sender name)
|
|
* parv[1]...parv[parc-1]
|
|
* pointers to additional parameters
|
|
* parv[parc] == NULL, *always*
|
|
*
|
|
* note: it is guaranteed that parv[1]..parv[parc-1] are all
|
|
* non-NULL pointers.
|
|
*/
|
|
|
|
#endif /* INCLUDED_msg_h */
|