src/ngircd/client.h

   1 /*
   2  * ngIRCd -- The Next Generation IRC Daemon
   3  * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
   4  *
   5  * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
   6  * der GNU General Public License (GPL), wie von der Free Software Foundation
   7  * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
   8  * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
   9  * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
  10  * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
  11  *
  12  * $Id: client.h,v 1.24 2002/03/11 22:04:10 alex Exp $
  13  *
  14  * client.h: Konfiguration des ngircd (Header)
  15  *
  16  * $Log: client.h,v $
  17  * Revision 1.24  2002/03/11 22:04:10  alex
  18  * - Client_Destroy() hat neuen Paramter: QUITs fuer Clients verschicken?
  19  *
  20  * Revision 1.23  2002/02/27 18:22:09  alex
  21  * - neue Funktion Client_SetAway() und Client_Away() implementiert.
  22  *
  23  * Revision 1.22  2002/02/06 16:49:56  alex
  24  * - neue Funktion Client_IsValidNick().
  25  *
  26  * Revision 1.21  2002/01/29 00:14:49  alex
  27  * - neue Funktion Client_TopServer(), Client_NewXXX() angepasst.
  28  *
  29  * Revision 1.20  2002/01/21 00:06:49  alex
  30  * - Channel-Pointer aus Client-Struktur entfernt. Wird nun dynamisch verwaltet :-)
  31  *
  32  * Revision 1.19  2002/01/16 22:10:35  alex
  33  * - neue Funktionen Client_xxxCount().
  34  *
  35  * Revision 1.18  2002/01/07 23:42:12  alex
  36  * - Es werden fuer alle Server eigene Token generiert,
  37  * - QUIT von einem Server fuer einen User wird an andere Server geforwarded,
  38  * - ebenso NICK-Befehle, die "fremde" User einfuehren.
  39  *
  40  * Revision 1.17  2002/01/06 15:18:14  alex
  41  * - Loglevel und Meldungen nochmals geaendert. Level passen nun besser.
  42  *
  43  * Revision 1.16  2002/01/05 23:26:05  alex
  44  * - Vorbereitungen fuer Ident-Abfragen in Client-Strukturen.
  45  *
  46  * Revision 1.15  2002/01/05 20:08:17  alex
  47  * - neue Funktion Client_NextHop().
  48  *
  49  * Revision 1.14  2002/01/04 01:21:22  alex
  50  * - Client-Strukturen koennen von anderen Modulen nun nur noch ueber die
  51  *   enstprechenden (zum Teil neuen) Funktionen angesprochen werden.
  52  *
  53  * Revision 1.13  2002/01/03 02:28:06  alex
  54  * - neue Funktion Client_CheckID(), diverse Aenderungen fuer Server-Links.
  55  *
  56  * Revision 1.12  2002/01/02 02:42:58  alex
  57  * - Copyright-Texte aktualisiert.
  58  *
  59  * Revision 1.11  2001/12/31 15:33:13  alex
  60  * - neuer Befehl NAMES, kleinere Bugfixes.
  61  * - Bug bei PING behoben: war zu restriktiv implementiert :-)
  62  *
  63  * Revision 1.10  2001/12/31 02:18:51  alex
  64  * - viele neue Befehle (WHOIS, ISON, OPER, DIE, RESTART),
  65  * - neuen Header "defines.h" mit (fast) allen Konstanten.
  66  * - Code Cleanups und viele "kleine" Aenderungen & Bugfixes.
  67  *
  68  * Revision 1.9  2001/12/29 20:18:18  alex
  69  * - neue Funktion Client_SetHostname().
  70  *
  71  * Revision 1.8  2001/12/29 03:10:47  alex
  72  * - Client-Modes implementiert; Loglevel mal wieder angepasst.
  73  *
  74  * Revision 1.7  2001/12/27 19:13:47  alex
  75  * - neue Funktion Client_Search(), besseres Logging.
  76  *
  77  * Revision 1.6  2001/12/27 16:54:51  alex
  78  * - neue Funktion Client_GetID(), liefert die "Client ID".
  79  *
  80  * Revision 1.5  2001/12/26 14:45:37  alex
  81  * - "Code Cleanups".
  82  *
  83  * Revision 1.4  2001/12/26 03:19:16  alex
  84  * - neue Funktion Client_Nick().
  85  *
  86  * Revision 1.3  2001/12/25 19:21:26  alex
  87  * - Client-Typ ("Status") besser unterteilt, My_Clients ist zudem nun global.
  88  *
  89  * Revision 1.2  2001/12/23 22:03:47  alex
  90  * - einige neue Funktionen,
  91  * - Konstanten um "CLIENT_"-Prefix erweitert.
  92  *
  93  * Revision 1.1  2001/12/14 08:13:43  alex
  94  * - neues Modul begonnen :-)
  95  */
  96
  97
  98 #ifndef __client_h__
  99 #define __client_h__
 100
 101 #include "conn.h"
 102
 103
 104 typedef enum
 105 {
 106         CLIENT_UNKNOWN,                 /* Verbindung mit (noch) unbekanntem Typ */
 107         CLIENT_GOTPASS,                 /* Client hat PASS gesendet */
 108         CLIENT_GOTNICK,                 /* Client hat NICK gesendet */
 109         CLIENT_GOTUSER,                 /* Client hat USER gesendet */
 110         CLIENT_USER,                    /* Client ist ein Benutzer (USER wurde gesendet) */
 111         CLIENT_UNKNOWNSERVER,           /* unregistrierte Server-Verbindung */
 112         CLIENT_GOTPASSSERVER,           /* Client hat PASS nach "Server-Art" gesendet */
 113         CLIENT_SERVER,                  /* Client ist ein Server */
 114         CLIENT_SERVICE                  /* Client ist ein Service */
 115 } CLIENT_TYPE;
 116
 117
 118 #ifdef __client_c__
 119 typedef struct _CLIENT
 120 {
 121         CHAR id[CLIENT_ID_LEN];         /* Nick (User) bzw. ID (Server) */
 122         POINTER *next;                  /* Zeiger auf naechste Client-Struktur */
 123         CLIENT_TYPE type;               /* Typ des Client, vgl. CLIENT_TYPE */
 124         CONN_ID conn_id;                /* ID der Connection (wenn lokal) bzw. NONE (remote) */
 125         struct _CLIENT *introducer;     /* ID des Servers, der die Verbindung hat */
 126         struct _CLIENT *topserver;      /* Toplevel-Servers (nur gueltig, wenn Client ein Server ist) */
 127         CHAR pwd[CLIENT_PASS_LEN];      /* Passwort, welches der Client angegeben hat */
 128         CHAR host[CLIENT_HOST_LEN];     /* Hostname des Client */
 129         CHAR user[CLIENT_USER_LEN];     /* Benutzername ("Login") */
 130         CHAR info[CLIENT_INFO_LEN];     /* Langer Benutzername (User) bzw. Infotext (Server) */
 131         CHAR modes[CLIENT_MODE_LEN];    /* Client Modes */
 132         INT hops, token, mytoken;       /* "Hops" und "Token" (-> SERVER-Befehl) */
 133         BOOLEAN oper_by_me;             /* IRC-Operator-Status durch diesen Server? */
 134         CHAR away[CLIENT_AWAY_LEN];     /* AWAY-Text, wenn Mode 'a' gesetzt */
 135 } CLIENT;
 136 #else
 137 typedef POINTER CLIENT;
 138 #endif
 139
 140
 141 GLOBAL VOID Client_Init( VOID );
 142 GLOBAL VOID Client_Exit( VOID );
 143
 144 GLOBAL CLIENT *Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented );
 145 GLOBAL CLIENT *Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented );
 146 GLOBAL CLIENT *Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented );
 147 GLOBAL CLIENT *Client_New( 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 );
 148
 149 GLOBAL VOID Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit );
 150
 151 GLOBAL CLIENT *Client_ThisServer( VOID );
 152
 153 GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx );
 154 GLOBAL CLIENT *Client_GetFromID( CHAR *Nick );
 155 GLOBAL CLIENT *Client_GetFromToken( CLIENT *Client, INT Token );
 156
 157 GLOBAL CLIENT *Client_Search( CHAR *ID );
 158 GLOBAL CLIENT *Client_First( VOID );
 159 GLOBAL CLIENT *Client_Next( CLIENT *c );
 160
 161 GLOBAL INT Client_Type( CLIENT *Client );
 162 GLOBAL CONN_ID Client_Conn( CLIENT *Client );
 163 GLOBAL CHAR *Client_ID( CLIENT *Client );
 164 GLOBAL CHAR *Client_Mask( CLIENT *Client );
 165 GLOBAL CHAR *Client_Info( CLIENT *Client );
 166 GLOBAL CHAR *Client_User( CLIENT *Client );
 167 GLOBAL CHAR *Client_Hostname( CLIENT *Client );
 168 GLOBAL CHAR *Client_Password( CLIENT *Client );
 169 GLOBAL CHAR *Client_Modes( CLIENT *Client );
 170 GLOBAL CLIENT *Client_Introducer( CLIENT *Client );
 171 GLOBAL BOOLEAN Client_OperByMe( CLIENT *Client );
 172 GLOBAL INT Client_Hops( CLIENT *Client );
 173 GLOBAL INT Client_Token( CLIENT *Client );
 174 GLOBAL INT Client_MyToken( CLIENT *Client );
 175 GLOBAL CLIENT *Client_TopServer( CLIENT *Client );
 176 GLOBAL CLIENT *Client_NextHop( CLIENT *Client );
 177 GLOBAL CHAR *Client_Away( CLIENT *Client );
 178
 179 GLOBAL BOOLEAN Client_HasMode( CLIENT *Client, CHAR Mode );
 180
 181 GLOBAL VOID Client_SetHostname( CLIENT *Client, CHAR *Hostname );
 182 GLOBAL VOID Client_SetID( CLIENT *Client, CHAR *Nick );
 183 GLOBAL VOID Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented );
 184 GLOBAL VOID Client_SetInfo( CLIENT *Client, CHAR *Info );
 185 GLOBAL VOID Client_SetPassword( CLIENT *Client, CHAR *Pwd );
 186 GLOBAL VOID Client_SetType( CLIENT *Client, INT Type );
 187 GLOBAL VOID Client_SetHops( CLIENT *Client, INT Hops );
 188 GLOBAL VOID Client_SetToken( CLIENT *Client, INT Token );
 189 GLOBAL VOID Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe );
 190 GLOBAL VOID Client_SetModes( CLIENT *Client, CHAR *Modes );
 191 GLOBAL VOID Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer );
 192 GLOBAL VOID Client_SetAway( CLIENT *Client, CHAR *Txt );
 193
 194 GLOBAL BOOLEAN Client_ModeAdd( CLIENT *Client, CHAR Mode );
 195 GLOBAL BOOLEAN Client_ModeDel( CLIENT *Client, CHAR Mode );
 196
 197 GLOBAL BOOLEAN Client_CheckNick( CLIENT *Client, CHAR *Nick );
 198 GLOBAL BOOLEAN Client_CheckID( CLIENT *Client, CHAR *ID );
 199
 200 GLOBAL INT Client_UserCount( VOID );
 201 GLOBAL INT Client_ServiceCount( VOID );
 202 GLOBAL INT Client_ServerCount( VOID );
 203 GLOBAL INT Client_OperCount( VOID );
 204 GLOBAL INT Client_UnknownCount( VOID );
 205 GLOBAL INT Client_MyUserCount( VOID );
 206 GLOBAL INT Client_MyServiceCount( VOID );
 207 GLOBAL INT Client_MyServerCount( VOID );
 208
 209 GLOBAL BOOLEAN Client_IsValidNick( CHAR *Nick );
 210
 211
 212 #endif
 213
 214
 215 /* -eof- */