2007-01-25 07:40:21 +01:00
|
|
|
/*
|
|
|
|
* 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
|
|
|
|
*
|
|
|
|
* $Id: msg.h 6 2005-09-10 01:02:21Z nenolod $
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef INCLUDED_msg_h
|
|
|
|
#define INCLUDED_msg_h
|
|
|
|
|
|
|
|
#include "config.h"
|
2016-02-10 06:08:06 +01:00
|
|
|
#include "msgbuf.h"
|
2007-01-25 07:40:21 +01:00
|
|
|
|
|
|
|
struct Client;
|
|
|
|
|
|
|
|
/* MessageHandler */
|
|
|
|
typedef enum HandlerType
|
|
|
|
{
|
|
|
|
UNREGISTERED_HANDLER,
|
|
|
|
CLIENT_HANDLER,
|
|
|
|
RCLIENT_HANDLER,
|
|
|
|
SERVER_HANDLER,
|
|
|
|
ENCAP_HANDLER,
|
|
|
|
OPER_HANDLER,
|
|
|
|
LAST_HANDLER_TYPE
|
|
|
|
}
|
|
|
|
HandlerType;
|
|
|
|
|
2016-02-11 03:13:44 +01:00
|
|
|
/* struct MsgBuf* msgbuf_p - message buffer (including tags)
|
|
|
|
* struct Client* client_p - connection message originated from
|
2007-01-25 07:40:21 +01:00
|
|
|
* struct Client* source_p - source of message, may be different from client_p
|
2016-02-11 03:13:44 +01:00
|
|
|
* int parc - parameter count (from msgbuf_p)
|
|
|
|
* char* parv[] - parameter vector (from msgbuf_p)
|
2007-01-25 07:40:21 +01:00
|
|
|
*/
|
2016-02-11 03:13:44 +01:00
|
|
|
typedef int (*MessageHandler) (struct MsgBuf *, struct Client *, struct Client *, int, const char *[]);
|
2007-01-25 07:40:21 +01:00
|
|
|
|
|
|
|
struct MessageEntry
|
|
|
|
{
|
|
|
|
MessageHandler handler;
|
|
|
|
int min_para;
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Message table structure */
|
|
|
|
struct Message
|
|
|
|
{
|
2008-04-08 18:51:52 +02:00
|
|
|
const char *cmd;
|
2007-01-25 07:40:21 +01:00
|
|
|
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 */
|
2016-02-19 23:42:40 +01:00
|
|
|
unsigned int flags;
|
|
|
|
|
2007-01-25 07:40:21 +01:00
|
|
|
/* handlers:
|
|
|
|
* UNREGISTERED, CLIENT, RCLIENT, SERVER, OPER, LAST
|
|
|
|
*/
|
|
|
|
struct MessageEntry handlers[LAST_HANDLER_TYPE];
|
|
|
|
};
|
|
|
|
|
|
|
|
/* generic handlers */
|
2016-02-11 03:13:44 +01:00
|
|
|
extern int m_ignore(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
|
|
extern int m_not_oper(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
|
|
extern int m_registered(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
|
|
extern int m_unregistered(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
2007-01-25 07:40:21 +01:00
|
|
|
|
|
|
|
#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:
|
|
|
|
* 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,
|
|
|
|
*
|
2009-01-18 18:22:43 +01:00
|
|
|
* parv[0], unused for historical reasons (formerly
|
|
|
|
* sender name)
|
2007-01-25 07:40:21 +01:00
|
|
|
* parv[1]...parv[parc-1]
|
|
|
|
* pointers to additional parameters
|
|
|
|
* parv[parc] == NULL, *always*
|
|
|
|
*
|
2009-01-18 18:22:43 +01:00
|
|
|
* note: it is guaranteed that parv[1]..parv[parc-1] are all
|
2007-01-25 07:40:21 +01:00
|
|
|
* non-NULL pointers.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#endif /* INCLUDED_msg_h */
|