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.14 2002/01/04 01:21:22 alex Exp $
  13  *
  14  * client.h: Konfiguration des ngircd (Header)
  15  *
  16  * $Log: client.h,v $
  17  * Revision 1.14  2002/01/04 01:21:22  alex
  18  * - Client-Strukturen koennen von anderen Modulen nun nur noch ueber die
  19  *   enstprechenden (zum Teil neuen) Funktionen angesprochen werden.
  20  *
  21  * Revision 1.13  2002/01/03 02:28:06  alex
  22  * - neue Funktion Client_CheckID(), diverse Aenderungen fuer Server-Links.
  23  *
  24  * Revision 1.12  2002/01/02 02:42:58  alex
  25  * - Copyright-Texte aktualisiert.
  26  *
  27  * Revision 1.11  2001/12/31 15:33:13  alex
  28  * - neuer Befehl NAMES, kleinere Bugfixes.
  29  * - Bug bei PING behoben: war zu restriktiv implementiert :-)
  30  *
  31  * Revision 1.10  2001/12/31 02:18:51  alex
  32  * - viele neue Befehle (WHOIS, ISON, OPER, DIE, RESTART),
  33  * - neuen Header "defines.h" mit (fast) allen Konstanten.
  34  * - Code Cleanups und viele "kleine" Aenderungen & Bugfixes.
  35  *
  36  * Revision 1.9  2001/12/29 20:18:18  alex
  37  * - neue Funktion Client_SetHostname().
  38  *
  39  * Revision 1.8  2001/12/29 03:10:47  alex
  40  * - Client-Modes implementiert; Loglevel mal wieder angepasst.
  41  *
  42  * Revision 1.7  2001/12/27 19:13:47  alex
  43  * - neue Funktion Client_Search(), besseres Logging.
  44  *
  45  * Revision 1.6  2001/12/27 16:54:51  alex
  46  * - neue Funktion Client_GetID(), liefert die "Client ID".
  47  *
  48  * Revision 1.5  2001/12/26 14:45:37  alex
  49  * - "Code Cleanups".
  50  *
  51  * Revision 1.4  2001/12/26 03:19:16  alex
  52  * - neue Funktion Client_Nick().
  53  *
  54  * Revision 1.3  2001/12/25 19:21:26  alex
  55  * - Client-Typ ("Status") besser unterteilt, My_Clients ist zudem nun global.
  56  *
  57  * Revision 1.2  2001/12/23 22:03:47  alex
  58  * - einige neue Funktionen,
  59  * - Konstanten um "CLIENT_"-Prefix erweitert.
  60  *
  61  * Revision 1.1  2001/12/14 08:13:43  alex
  62  * - neues Modul begonnen :-)
  63  */
  64
  65
  66 #ifndef __client_h__
  67 #define __client_h__
  68
  69 #include "channel.h"
  70 #include "conn.h"
  71
  72
  73 typedef enum
  74 {
  75         CLIENT_UNKNOWN,                 /* Verbindung mit (noch) unbekanntem Typ */
  76         CLIENT_GOTPASS,                 /* Client hat PASS gesendet */
  77         CLIENT_GOTNICK,                 /* Client hat NICK gesendet */
  78         CLIENT_GOTUSER,                 /* Client hat USER gesendet */
  79         CLIENT_USER,                    /* Client ist ein Benutzer (USER wurde gesendet) */
  80         CLIENT_UNKNOWNSERVER,           /* unregistrierte Server-Verbindung */
  81         CLIENT_GOTPASSSERVER,           /* Client hat PASS nach "Server-Art" gesendet */
  82         CLIENT_SERVER,                  /* Client ist ein Server */
  83         CLIENT_SERVICE                  /* Client ist ein Service */
  84 } CLIENT_TYPE;
  85
  86
  87 #ifdef __client_c__
  88 typedef struct _CLIENT
  89 {
  90         CHAR id[CLIENT_ID_LEN];         /* Nick (User) bzw. ID (Server) */
  91         POINTER *next;                  /* Zeiger auf naechste Client-Struktur */
  92         CLIENT_TYPE type;               /* Typ des Client, vgl. CLIENT_TYPE */
  93         CONN_ID conn_id;                /* ID der Connection (wenn lokal) bzw. NONE (remote) */
  94         struct _CLIENT *introducer;     /* ID des Servers, der die Verbindung hat */
  95         CHAR pwd[CLIENT_PASS_LEN];      /* Passwort, welches der Client angegeben hat */
  96         CHAR host[CLIENT_HOST_LEN];     /* Hostname des Client */
  97         CHAR user[CLIENT_USER_LEN];     /* Benutzername ("Login") */
  98         CHAR info[CLIENT_INFO_LEN];     /* Langer Benutzername (User) bzw. Infotext (Server) */
  99         CHANNEL *channels[MAX_CHANNELS];/* Channel, in denen der Client Mitglied ist */
 100         CHAR modes[CLIENT_MODE_LEN];    /* Client Modes */
 101         INT hops, token;                /* "Hops" und "Token" (-> SERVER-Befehl) */
 102         BOOLEAN oper_by_me;             /* IRC-Operator-Status durch diesen Server? */
 103 } CLIENT;
 104 #else
 105 typedef POINTER CLIENT;
 106 #endif
 107
 108
 109 GLOBAL VOID Client_Init( VOID );
 110 GLOBAL VOID Client_Exit( VOID );
 111
 112 GLOBAL CLIENT *Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type );
 113 GLOBAL CLIENT *Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, INT Hops, INT Token, CHAR *Info );
 114 GLOBAL CLIENT *Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info );
 115 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 );
 116
 117 GLOBAL VOID Client_Destroy( CLIENT *Client );
 118
 119 GLOBAL CLIENT *Client_ThisServer( VOID );
 120
 121 GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx );
 122 GLOBAL CLIENT *Client_GetFromID( CHAR *Nick );
 123 GLOBAL CLIENT *Client_GetFromToken( CLIENT *Client, INT Token );
 124
 125 GLOBAL CLIENT *Client_Search( CHAR *ID );
 126 GLOBAL CLIENT *Client_First( VOID );
 127 GLOBAL CLIENT *Client_Next( CLIENT *c );
 128
 129 GLOBAL INT Client_Type( CLIENT *Client );
 130 GLOBAL CONN_ID Client_Conn( CLIENT *Client );
 131 GLOBAL CHAR *Client_ID( CLIENT *Client );
 132 GLOBAL CHAR *Client_Mask( CLIENT *Client );
 133 GLOBAL CHAR *Client_Info( CLIENT *Client );
 134 GLOBAL CHAR *Client_User( CLIENT *Client );
 135 GLOBAL CHAR *Client_Hostname( CLIENT *Client );
 136 GLOBAL CHAR *Client_Password( CLIENT *Client );
 137 GLOBAL CHAR *Client_Modes( CLIENT *Client );
 138 GLOBAL CLIENT *Client_Introducer( CLIENT *Client );
 139 GLOBAL BOOLEAN Client_OperByMe( CLIENT *Client );
 140 GLOBAL INT Client_Hops( CLIENT *Client );
 141 GLOBAL INT Client_Token( CLIENT *Client );
 142
 143 GLOBAL BOOLEAN Client_HasMode( CLIENT *Client, CHAR Mode );
 144
 145 GLOBAL VOID Client_SetHostname( CLIENT *Client, CHAR *Hostname );
 146 GLOBAL VOID Client_SetID( CLIENT *Client, CHAR *Nick );
 147 GLOBAL VOID Client_SetUser( CLIENT *Client, CHAR *User );
 148 GLOBAL VOID Client_SetInfo( CLIENT *Client, CHAR *Info );
 149 GLOBAL VOID Client_SetPassword( CLIENT *Client, CHAR *Pwd );
 150 GLOBAL VOID Client_SetType( CLIENT *Client, INT Type );
 151 GLOBAL VOID Client_SetHops( CLIENT *Client, INT Hops );
 152 GLOBAL VOID Client_SetToken( CLIENT *Client, INT Token );
 153 GLOBAL VOID Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe );
 154 GLOBAL VOID Client_SetModes( CLIENT *Client, CHAR *Modes );
 155 GLOBAL VOID Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer );
 156
 157 GLOBAL BOOLEAN Client_ModeAdd( CLIENT *Client, CHAR Mode );
 158 GLOBAL BOOLEAN Client_ModeDel( CLIENT *Client, CHAR Mode );
 159
 160 GLOBAL BOOLEAN Client_CheckNick( CLIENT *Client, CHAR *Nick );
 161 GLOBAL BOOLEAN Client_CheckID( CLIENT *Client, CHAR *ID );
 162
 163 #endif
 164
 165
 166 /* -eof- */