]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/client.h
Added missing include for <sys/select.h>.
[ngircd-alex.git] / src / ngircd / client.h
index 2cddb54475b98c9754409da792129edf2c855fcc..e47d605bf10c7c5046e0615bd6baa08f2a6633a2 100644 (file)
  * ngIRCd -- The Next Generation IRC Daemon
  * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
  *
- * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
- * der GNU General Public License (GPL), wie von der Free Software Foundation
- * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
- * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
- * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
- * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
+ * 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.
+ * Please read the file COPYING, README and AUTHORS for more information.
  *
- * $Id: client.h,v 1.17 2002/01/06 15:18:14 alex Exp $
+ * $Id: client.h,v 1.34 2003/01/15 14:28:25 alex Exp $
  *
- * client.h: Konfiguration des ngircd (Header)
- *
- * $Log: client.h,v $
- * Revision 1.17  2002/01/06 15:18:14  alex
- * - Loglevel und Meldungen nochmals geaendert. Level passen nun besser.
- *
- * Revision 1.16  2002/01/05 23:26:05  alex
- * - Vorbereitungen fuer Ident-Abfragen in Client-Strukturen.
- *
- * Revision 1.15  2002/01/05 20:08:17  alex
- * - neue Funktion Client_NextHop().
- *
- * Revision 1.14  2002/01/04 01:21:22  alex
- * - Client-Strukturen koennen von anderen Modulen nun nur noch ueber die
- *   enstprechenden (zum Teil neuen) Funktionen angesprochen werden.
- *
- * Revision 1.13  2002/01/03 02:28:06  alex
- * - neue Funktion Client_CheckID(), diverse Aenderungen fuer Server-Links.
- *
- * Revision 1.12  2002/01/02 02:42:58  alex
- * - Copyright-Texte aktualisiert.
- *
- * Revision 1.11  2001/12/31 15:33:13  alex
- * - neuer Befehl NAMES, kleinere Bugfixes.
- * - Bug bei PING behoben: war zu restriktiv implementiert :-)
- *
- * Revision 1.10  2001/12/31 02:18:51  alex
- * - viele neue Befehle (WHOIS, ISON, OPER, DIE, RESTART),
- * - neuen Header "defines.h" mit (fast) allen Konstanten.
- * - Code Cleanups und viele "kleine" Aenderungen & Bugfixes.
- *
- * Revision 1.9  2001/12/29 20:18:18  alex
- * - neue Funktion Client_SetHostname().
- *
- * Revision 1.8  2001/12/29 03:10:47  alex
- * - Client-Modes implementiert; Loglevel mal wieder angepasst.
- *
- * Revision 1.7  2001/12/27 19:13:47  alex
- * - neue Funktion Client_Search(), besseres Logging.
- *
- * Revision 1.6  2001/12/27 16:54:51  alex
- * - neue Funktion Client_GetID(), liefert die "Client ID".
- *
- * Revision 1.5  2001/12/26 14:45:37  alex
- * - "Code Cleanups".
- *
- * Revision 1.4  2001/12/26 03:19:16  alex
- * - neue Funktion Client_Nick().
- *
- * Revision 1.3  2001/12/25 19:21:26  alex
- * - Client-Typ ("Status") besser unterteilt, My_Clients ist zudem nun global.
- *
- * Revision 1.2  2001/12/23 22:03:47  alex
- * - einige neue Funktionen,
- * - Konstanten um "CLIENT_"-Prefix erweitert.
- *
- * Revision 1.1  2001/12/14 08:13:43  alex
- * - neues Modul begonnen :-)
+ * Client management (header)
  */
 
 
 #ifndef __client_h__
 #define __client_h__
 
-#include "channel.h"
-#include "conn.h"
 
+#define CLIENT_UNKNOWN 1               /* connection of unknown type */
+#define CLIENT_GOTPASS 2               /* client did send PASS */
+#define CLIENT_GOTNICK 4               /* client did send NICK */
+#define CLIENT_GOTUSER 8               /* client did send USER */
+#define CLIENT_USER 16                 /* client is an IRC user */
+#define CLIENT_UNKNOWNSERVER 32                /* unregistered server connection */
+#define CLIENT_GOTPASSSERVER 64                /* client did send PASS in "server style" */
+#define CLIENT_SERVER 128              /* client is a server */
+#define CLIENT_SERVICE 256             /* client is a service */
+
+#define CLIENT_TYPE INT
+
+
+#if defined(__client_c__) | defined(S_SPLINT_S)
+
+#include "defines.h"
 
-typedef enum
-{
-       CLIENT_UNKNOWN,                 /* Verbindung mit (noch) unbekanntem Typ */
-       CLIENT_GOTPASS,                 /* Client hat PASS gesendet */
-       CLIENT_GOTNICK,                 /* Client hat NICK gesendet */
-       CLIENT_GOTUSER,                 /* Client hat USER gesendet */
-       CLIENT_USER,                    /* Client ist ein Benutzer (USER wurde gesendet) */
-       CLIENT_UNKNOWNSERVER,           /* unregistrierte Server-Verbindung */
-       CLIENT_GOTPASSSERVER,           /* Client hat PASS nach "Server-Art" gesendet */
-       CLIENT_SERVER,                  /* Client ist ein Server */
-       CLIENT_SERVICE                  /* Client ist ein Service */
-} CLIENT_TYPE;
-
-
-#ifdef __client_c__
 typedef struct _CLIENT
 {
-       CHAR id[CLIENT_ID_LEN];         /* Nick (User) bzw. ID (Server) */
-       POINTER *next;                  /* Zeiger auf naechste Client-Struktur */
-       CLIENT_TYPE type;               /* Typ des Client, vgl. CLIENT_TYPE */
-       CONN_ID conn_id;                /* ID der Connection (wenn lokal) bzw. NONE (remote) */
-       struct _CLIENT *introducer;     /* ID des Servers, der die Verbindung hat */
-       CHAR pwd[CLIENT_PASS_LEN];      /* Passwort, welches der Client angegeben hat */
-       CHAR host[CLIENT_HOST_LEN];     /* Hostname des Client */
-       CHAR user[CLIENT_USER_LEN];     /* Benutzername ("Login") */
-       CHAR info[CLIENT_INFO_LEN];     /* Langer Benutzername (User) bzw. Infotext (Server) */
-       CHANNEL *channels[MAX_CHANNELS];/* Channel, in denen der Client Mitglied ist */
-       CHAR modes[CLIENT_MODE_LEN];    /* Client Modes */
-       INT hops, token;                /* "Hops" und "Token" (-> SERVER-Befehl) */
-       BOOLEAN oper_by_me;             /* IRC-Operator-Status durch diesen Server? */
+       CHAR id[CLIENT_ID_LEN];         /* nick (user) / ID (server) */
+       UINT32 hash;                    /* hash of lower-case ID */
+       POINTER *next;                  /* pointer to next client structure */
+       CLIENT_TYPE type;               /* type of client, see CLIENT_xxx */
+       CONN_ID conn_id;                /* ID of the connection (if local) or NONE (remote) */
+       struct _CLIENT *introducer;     /* ID of the servers which the client is connected to */
+       struct _CLIENT *topserver;      /* toplevel servers (only valid if client is a server) */
+       CHAR pwd[CLIENT_PASS_LEN];      /* password received of the client */
+       CHAR host[CLIENT_HOST_LEN];     /* hostname of the client */
+       CHAR user[CLIENT_USER_LEN];     /* user name ("login") */
+       CHAR info[CLIENT_INFO_LEN];     /* long user name (user) / info text (server) */
+       CHAR modes[CLIENT_MODE_LEN];    /* client modes */
+       INT hops, token, mytoken;       /* "hops" and "Token" (see SERVER command) */
+       BOOLEAN oper_by_me;             /* client is local IRC operator on this server? */
+       CHAR away[CLIENT_AWAY_LEN];     /* AWAY text (valid if mode 'a' is set) */
+       CHAR flags[CLIENT_FLAGS_LEN];   /* flags of the client */
 } CLIENT;
+
 #else
+
 typedef POINTER CLIENT;
+
+#endif
+
+
+GLOBAL VOID Client_Init PARAMS(( VOID ));
+GLOBAL VOID Client_Exit PARAMS(( VOID ));
+
+GLOBAL CLIENT *Client_NewLocal PARAMS(( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented ));
+GLOBAL CLIENT *Client_NewRemoteServer PARAMS(( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented ));
+GLOBAL CLIENT *Client_NewRemoteUser PARAMS(( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented ));
+GLOBAL CLIENT *Client_New PARAMS(( CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer, INT Type, CHAR *ID, CHAR *User, CHAR *Hostname, CHAR *Info, INT Hops, INT Token, CHAR *Modes, BOOLEAN Idented ));
+
+GLOBAL VOID Client_Destroy PARAMS(( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit ));
+#ifdef CONN_MODULE
+GLOBAL VOID Client_DestroyNow PARAMS(( CLIENT *Client ));
 #endif
 
+GLOBAL CLIENT *Client_ThisServer PARAMS(( VOID ));
+
+GLOBAL CLIENT *Client_GetFromConn PARAMS(( CONN_ID Idx ));
+GLOBAL CLIENT *Client_GetFromToken PARAMS(( CLIENT *Client, INT Token ));
+
+GLOBAL CLIENT *Client_Search PARAMS(( CHAR *ID ));
+GLOBAL CLIENT *Client_First PARAMS(( VOID ));
+GLOBAL CLIENT *Client_Next PARAMS(( CLIENT *c ));
+
+GLOBAL INT Client_Type PARAMS(( CLIENT *Client ));
+GLOBAL CONN_ID Client_Conn PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_ID PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_Mask PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_Info PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_User PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_Hostname PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_Password PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_Modes PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_Flags PARAMS(( CLIENT *Client ));
+GLOBAL CLIENT *Client_Introducer PARAMS(( CLIENT *Client ));
+GLOBAL BOOLEAN Client_OperByMe PARAMS(( CLIENT *Client ));
+GLOBAL INT Client_Hops PARAMS(( CLIENT *Client ));
+GLOBAL INT Client_Token PARAMS(( CLIENT *Client ));
+GLOBAL INT Client_MyToken PARAMS(( CLIENT *Client ));
+GLOBAL CLIENT *Client_TopServer PARAMS(( CLIENT *Client ));
+GLOBAL CLIENT *Client_NextHop PARAMS(( CLIENT *Client ));
+GLOBAL CHAR *Client_Away PARAMS(( CLIENT *Client ));
+
+GLOBAL BOOLEAN Client_HasMode PARAMS(( CLIENT *Client, CHAR Mode ));
+
+GLOBAL VOID Client_SetHostname PARAMS(( CLIENT *Client, CHAR *Hostname ));
+GLOBAL VOID Client_SetID PARAMS(( CLIENT *Client, CHAR *Nick ));
+GLOBAL VOID Client_SetUser PARAMS(( CLIENT *Client, CHAR *User, BOOLEAN Idented ));
+GLOBAL VOID Client_SetInfo PARAMS(( CLIENT *Client, CHAR *Info ));
+GLOBAL VOID Client_SetPassword PARAMS(( CLIENT *Client, CHAR *Pwd ));
+GLOBAL VOID Client_SetType PARAMS(( CLIENT *Client, INT Type ));
+GLOBAL VOID Client_SetHops PARAMS(( CLIENT *Client, INT Hops ));
+GLOBAL VOID Client_SetToken PARAMS(( CLIENT *Client, INT Token ));
+GLOBAL VOID Client_SetOperByMe PARAMS(( CLIENT *Client, BOOLEAN OperByMe ));
+GLOBAL VOID Client_SetModes PARAMS(( CLIENT *Client, CHAR *Modes ));
+GLOBAL VOID Client_SetFlags PARAMS(( CLIENT *Client, CHAR *Flags ));
+GLOBAL VOID Client_SetIntroducer PARAMS(( CLIENT *Client, CLIENT *Introducer ));
+GLOBAL VOID Client_SetAway PARAMS(( CLIENT *Client, CHAR *Txt ));
+
+GLOBAL BOOLEAN Client_ModeAdd PARAMS(( CLIENT *Client, CHAR Mode ));
+GLOBAL BOOLEAN Client_ModeDel PARAMS(( CLIENT *Client, CHAR Mode ));
+
+GLOBAL BOOLEAN Client_CheckNick PARAMS(( CLIENT *Client, CHAR *Nick ));
+GLOBAL BOOLEAN Client_CheckID PARAMS(( CLIENT *Client, CHAR *ID ));
+
+GLOBAL LONG Client_UserCount PARAMS(( VOID ));
+GLOBAL LONG Client_ServiceCount PARAMS(( VOID ));
+GLOBAL LONG Client_ServerCount PARAMS(( VOID ));
+GLOBAL LONG Client_OperCount PARAMS(( VOID ));
+GLOBAL LONG Client_UnknownCount PARAMS(( VOID ));
+GLOBAL LONG Client_MyUserCount PARAMS(( VOID ));
+GLOBAL LONG Client_MyServiceCount PARAMS(( VOID ));
+GLOBAL LONG Client_MyServerCount PARAMS(( VOID ));
+GLOBAL LONG Client_MaxUserCount PARAMS((  VOID ));
+GLOBAL LONG Client_MyMaxUserCount PARAMS((  VOID ));
+
+GLOBAL BOOLEAN Client_IsValidNick PARAMS(( CHAR *Nick ));
 
-GLOBAL VOID Client_Init( VOID );
-GLOBAL VOID Client_Exit( VOID );
-
-GLOBAL CLIENT *Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented );
-GLOBAL CLIENT *Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented );
-GLOBAL CLIENT *Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented );
-GLOBAL CLIENT *Client_New( CONN_ID Idx, CLIENT *Introducer, INT Type, CHAR *ID, CHAR *User, CHAR *Hostname, CHAR *Info, INT Hops, INT Token, CHAR *Modes, BOOLEAN Idented );
-
-GLOBAL VOID Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg );
-
-GLOBAL CLIENT *Client_ThisServer( VOID );
-
-GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx );
-GLOBAL CLIENT *Client_GetFromID( CHAR *Nick );
-GLOBAL CLIENT *Client_GetFromToken( CLIENT *Client, INT Token );
-
-GLOBAL CLIENT *Client_Search( CHAR *ID );
-GLOBAL CLIENT *Client_First( VOID );
-GLOBAL CLIENT *Client_Next( CLIENT *c );
-
-GLOBAL INT Client_Type( CLIENT *Client );
-GLOBAL CONN_ID Client_Conn( CLIENT *Client );
-GLOBAL CHAR *Client_ID( CLIENT *Client );
-GLOBAL CHAR *Client_Mask( CLIENT *Client );
-GLOBAL CHAR *Client_Info( CLIENT *Client );
-GLOBAL CHAR *Client_User( CLIENT *Client );
-GLOBAL CHAR *Client_Hostname( CLIENT *Client );
-GLOBAL CHAR *Client_Password( CLIENT *Client );
-GLOBAL CHAR *Client_Modes( CLIENT *Client );
-GLOBAL CLIENT *Client_Introducer( CLIENT *Client );
-GLOBAL BOOLEAN Client_OperByMe( CLIENT *Client );
-GLOBAL INT Client_Hops( CLIENT *Client );
-GLOBAL INT Client_Token( CLIENT *Client );
-GLOBAL CLIENT *Client_NextHop( CLIENT *Client );
-
-GLOBAL BOOLEAN Client_HasMode( CLIENT *Client, CHAR Mode );
-
-GLOBAL VOID Client_SetHostname( CLIENT *Client, CHAR *Hostname );
-GLOBAL VOID Client_SetID( CLIENT *Client, CHAR *Nick );
-GLOBAL VOID Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented );
-GLOBAL VOID Client_SetInfo( CLIENT *Client, CHAR *Info );
-GLOBAL VOID Client_SetPassword( CLIENT *Client, CHAR *Pwd );
-GLOBAL VOID Client_SetType( CLIENT *Client, INT Type );
-GLOBAL VOID Client_SetHops( CLIENT *Client, INT Hops );
-GLOBAL VOID Client_SetToken( CLIENT *Client, INT Token );
-GLOBAL VOID Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe );
-GLOBAL VOID Client_SetModes( CLIENT *Client, CHAR *Modes );
-GLOBAL VOID Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer );
-
-GLOBAL BOOLEAN Client_ModeAdd( CLIENT *Client, CHAR Mode );
-GLOBAL BOOLEAN Client_ModeDel( CLIENT *Client, CHAR Mode );
-
-GLOBAL BOOLEAN Client_CheckNick( CLIENT *Client, CHAR *Nick );
-GLOBAL BOOLEAN Client_CheckID( CLIENT *Client, CHAR *ID );
 
 #endif