/*
* ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
*
- * 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.
- *
- * $Id: client.h,v 1.17 2002/01/06 15:18:14 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 :-)
+ * 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.
*/
-
#ifndef __client_h__
#define __client_h__
-#include "channel.h"
-#include "conn.h"
+/**
+ * @file
+ * Client management (header)
+ */
+#define CLIENT_UNKNOWN 0x0001 /* connection of unknown type */
+#define CLIENT_GOTPASS 0x0002 /* client did send PASS */
+#define CLIENT_GOTNICK 0x0004 /* client did send NICK */
+#define CLIENT_GOTUSER 0x0008 /* client did send USER */
+#define CLIENT_USER 0x0010 /* client is an IRC user */
+#define CLIENT_SERVER 0x0020 /* client is a server */
+#define CLIENT_SERVICE 0x0040 /* client is a service */
+#define CLIENT_UNKNOWNSERVER 0x0080 /* unregistered server connection */
+#define CLIENT_GOTPASS_2813 0x0100 /* client did send PASS, RFC 2813 style */
+#ifndef STRICT_RFC
+# define CLIENT_WAITAUTHPING 0x0200 /* waiting for AUTH PONG from client */
+#endif
+#define CLIENT_WAITCAPEND 0x0400 /* waiting for "CAP END" command */
+#define CLIENT_ANY 0xFFFF
+
+#define CLIENT_TYPE int
+
+#include "defines.h"
+
+#if defined(__client_c__) | defined(__client_cap_c__) | defined(S_SPLINT_S)
-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? */
+ time_t starttime; /* Start time of link */
+ 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 host[CLIENT_HOST_LEN]; /* hostname of the client */
+ char *cloaked; /* cloaked hostname of the client */
+ char *ipa_text; /* textual representaton of IP address */
+ char user[CLIENT_USER_LEN]; /* user name ("login") */
+#if defined(PAM)
+ char orig_user[CLIENT_AUTHUSER_LEN];
+ /* original user name supplied by USER command */
+#endif
+ 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) */
+ char *away; /* AWAY text (valid if mode 'a' is set) */
+ char flags[CLIENT_FLAGS_LEN]; /* flags of the client */
+ char *account_name; /* login account (for services) */
+ int capabilities; /* enabled IRC capabilities */
} CLIENT;
+
#else
+
typedef POINTER CLIENT;
+
#endif
-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 );
+typedef struct _WHOWAS
+{
+ time_t time; /* time stamp of entry or 0 if unused */
+ char id[CLIENT_NICK_LEN]; /* client nickname */
+ 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 */
+ char server[CLIENT_HOST_LEN]; /* server name */
+} WHOWAS;
+
+
+GLOBAL void Client_Init PARAMS(( void ));
+GLOBAL void Client_Exit PARAMS(( void ));
+
+GLOBAL CLIENT *Client_NewLocal PARAMS(( CONN_ID Idx, const char *Hostname, int Type, bool Idented ));
+GLOBAL CLIENT *Client_NewRemoteServer PARAMS(( CLIENT *Introducer, const char *Hostname, CLIENT *TopServer, int Hops, int Token, const char *Info, bool Idented ));
+GLOBAL CLIENT *Client_NewRemoteUser PARAMS(( CLIENT *Introducer, const char *Nick, int Hops, const char *User, const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented ));
+
+GLOBAL void Client_Destroy PARAMS(( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit ));
+GLOBAL CLIENT *Client_ThisServer PARAMS(( void ));
+
+GLOBAL CLIENT *Client_GetFromToken PARAMS(( CLIENT *Client, int Token ));
+
+GLOBAL bool Client_Announce PARAMS(( CLIENT *Client, CLIENT *Prefix, CLIENT *User ));
+
+GLOBAL CLIENT *Client_Search PARAMS(( const char *ID ));
+GLOBAL CLIENT *Client_SearchServer PARAMS(( const 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_MaskCloaked PARAMS(( CLIENT *Client ));
+GLOBAL char *Client_Info PARAMS(( CLIENT *Client ));
+GLOBAL char *Client_User PARAMS(( CLIENT *Client ));
+#ifdef PAM
+GLOBAL char *Client_OrigUser PARAMS(( CLIENT *Client ));
#endif
+GLOBAL char *Client_Hostname PARAMS(( CLIENT *Client ));
+GLOBAL char *Client_HostnameCloaked PARAMS((CLIENT *Client));
+GLOBAL char *Client_HostnameDisplayed PARAMS(( CLIENT *Client ));
+GLOBAL const char *Client_IPAText 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 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 char *Client_AccountName PARAMS((CLIENT *Client));
+GLOBAL time_t Client_StartTime PARAMS(( CLIENT *Client ));
+
+GLOBAL bool Client_HasMode PARAMS(( CLIENT *Client, char Mode ));
+GLOBAL bool Client_HasFlag PARAMS(( CLIENT *Client, char Flag ));
+
+GLOBAL void Client_SetHostname PARAMS(( CLIENT *Client, const char *Hostname ));
+GLOBAL void Client_SetIPAText PARAMS(( CLIENT *Client, const char *IPAText ));
+GLOBAL void Client_SetID PARAMS(( CLIENT *Client, const char *Nick ));
+GLOBAL void Client_SetUser PARAMS(( CLIENT *Client, const char *User, bool Idented ));
+GLOBAL void Client_SetOrigUser PARAMS(( CLIENT *Client, const char *User ));
+GLOBAL void Client_SetInfo PARAMS(( CLIENT *Client, const char *Info ));
+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_SetModes PARAMS(( CLIENT *Client, const char *Modes ));
+GLOBAL void Client_SetFlags PARAMS(( CLIENT *Client, const char *Flags ));
+GLOBAL void Client_SetIntroducer PARAMS(( CLIENT *Client, CLIENT *Introducer ));
+GLOBAL void Client_SetAway PARAMS(( CLIENT *Client, const char *Txt ));
+GLOBAL void Client_SetAccountName PARAMS((CLIENT *Client, const char *AccountName));
+
+GLOBAL bool Client_ModeAdd PARAMS(( CLIENT *Client, char Mode ));
+GLOBAL bool Client_ModeDel PARAMS(( CLIENT *Client, char Mode ));
+
+GLOBAL bool Client_CheckNick PARAMS(( CLIENT *Client, char *Nick ));
+GLOBAL bool 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 unsigned long Client_OperCount PARAMS(( void ));
+GLOBAL unsigned long Client_UnknownCount PARAMS(( void ));
+GLOBAL long Client_MyUserCount PARAMS(( void ));
+GLOBAL long Client_MyServiceCount PARAMS(( void ));
+GLOBAL unsigned long Client_MyServerCount PARAMS(( void ));
+GLOBAL long Client_MaxUserCount PARAMS(( void ));
+GLOBAL long Client_MyMaxUserCount PARAMS(( void ));
+
+GLOBAL bool Client_IsValidNick PARAMS(( const char *Nick ));
+
+GLOBAL WHOWAS *Client_GetWhowas PARAMS(( void ));
+GLOBAL int Client_GetLastWhowasIndex PARAMS(( void ));
+
+GLOBAL void Client_RegisterWhowas PARAMS(( CLIENT *Client ));
+
+GLOBAL const char *Client_TypeText PARAMS((CLIENT *Client));
+
+GLOBAL void Client_Reject PARAMS((CLIENT *Client, const char *Reason,
+ bool InformClient));
+GLOBAL void Client_Introduce PARAMS((CLIENT *From, CLIENT *Client, int Type));
+
+GLOBAL void Client_UpdateCloakedHostname PARAMS((CLIENT *Client,
+ CLIENT *Originator,
+ const char *hostname));
+
+
+GLOBAL void Client_DebugDump PARAMS((void));
+#endif
/* -eof- */