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.27 2002/03/25 19:11:01 alex Exp $
  13  *
  14  * client.h: Konfiguration des ngircd (Header)
  15  */
  16
  17
  18 #ifndef __client_h__
  19 #define __client_h__
  20
  21 #include "conn.h"
  22
  23
  24 typedef enum
  25 {
  26         CLIENT_UNKNOWN,                 /* Verbindung mit (noch) unbekanntem Typ */
  27         CLIENT_GOTPASS,                 /* Client hat PASS gesendet */
  28         CLIENT_GOTNICK,                 /* Client hat NICK gesendet */
  29         CLIENT_GOTUSER,                 /* Client hat USER gesendet */
  30         CLIENT_USER,                    /* Client ist ein Benutzer (USER wurde gesendet) */
  31         CLIENT_UNKNOWNSERVER,           /* unregistrierte Server-Verbindung */
  32         CLIENT_GOTPASSSERVER,           /* Client hat PASS nach "Server-Art" gesendet */
  33         CLIENT_SERVER,                  /* Client ist ein Server */
  34         CLIENT_SERVICE                  /* Client ist ein Service */
  35 } CLIENT_TYPE;
  36
  37
  38 #if defined(__client_c__) | defined(S_SPLINT_S)
  39
  40 #include "defines.h"
  41
  42 typedef struct _CLIENT
  43 {
  44         CHAR id[CLIENT_ID_LEN];         /* Nick (User) bzw. ID (Server) */
  45         UINT32 hash;                    /* Hash ueber die (kleingeschriebene) ID */
  46         POINTER *next;                  /* Zeiger auf naechste Client-Struktur */
  47         CLIENT_TYPE type;               /* Typ des Client, vgl. CLIENT_TYPE */
  48         CONN_ID conn_id;                /* ID der Connection (wenn lokal) bzw. NONE (remote) */
  49         struct _CLIENT *introducer;     /* ID des Servers, der die Verbindung hat */
  50         struct _CLIENT *topserver;      /* Toplevel-Servers (nur gueltig, wenn Client ein Server ist) */
  51         CHAR pwd[CLIENT_PASS_LEN];      /* Passwort, welches der Client angegeben hat */
  52         CHAR host[CLIENT_HOST_LEN];     /* Hostname des Client */
  53         CHAR user[CLIENT_USER_LEN];     /* Benutzername ("Login") */
  54         CHAR info[CLIENT_INFO_LEN];     /* Langer Benutzername (User) bzw. Infotext (Server) */
  55         CHAR modes[CLIENT_MODE_LEN];    /* Client Modes */
  56         INT hops, token, mytoken;       /* "Hops" und "Token" (-> SERVER-Befehl) */
  57         BOOLEAN oper_by_me;             /* IRC-Operator-Status durch diesen Server? */
  58         CHAR away[CLIENT_AWAY_LEN];     /* AWAY-Text, wenn Mode 'a' gesetzt */
  59 } CLIENT;
  60
  61 #else
  62
  63 typedef POINTER CLIENT;
  64
  65 #endif
  66
  67
  68 GLOBAL VOID Client_Init( VOID );
  69 GLOBAL VOID Client_Exit( VOID );
  70
  71 GLOBAL CLIENT *Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented );
  72 GLOBAL CLIENT *Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented );
  73 GLOBAL CLIENT *Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented );
  74 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 );
  75
  76 GLOBAL VOID Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit );
  77
  78 GLOBAL CLIENT *Client_ThisServer( VOID );
  79
  80 GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx );
  81 GLOBAL CLIENT *Client_GetFromToken( CLIENT *Client, INT Token );
  82
  83 GLOBAL CLIENT *Client_Search( CHAR *ID );
  84 GLOBAL CLIENT *Client_First( VOID );
  85 GLOBAL CLIENT *Client_Next( CLIENT *c );
  86
  87 GLOBAL INT Client_Type( CLIENT *Client );
  88 GLOBAL CONN_ID Client_Conn( CLIENT *Client );
  89 GLOBAL CHAR *Client_ID( CLIENT *Client );
  90 GLOBAL CHAR *Client_Mask( CLIENT *Client );
  91 GLOBAL CHAR *Client_Info( CLIENT *Client );
  92 GLOBAL CHAR *Client_User( CLIENT *Client );
  93 GLOBAL CHAR *Client_Hostname( CLIENT *Client );
  94 GLOBAL CHAR *Client_Password( CLIENT *Client );
  95 GLOBAL CHAR *Client_Modes( CLIENT *Client );
  96 GLOBAL CLIENT *Client_Introducer( CLIENT *Client );
  97 GLOBAL BOOLEAN Client_OperByMe( CLIENT *Client );
  98 GLOBAL INT Client_Hops( CLIENT *Client );
  99 GLOBAL INT Client_Token( CLIENT *Client );
 100 GLOBAL INT Client_MyToken( CLIENT *Client );
 101 GLOBAL CLIENT *Client_TopServer( CLIENT *Client );
 102 GLOBAL CLIENT *Client_NextHop( CLIENT *Client );
 103 GLOBAL CHAR *Client_Away( CLIENT *Client );
 104
 105 GLOBAL BOOLEAN Client_HasMode( CLIENT *Client, CHAR Mode );
 106
 107 GLOBAL VOID Client_SetHostname( CLIENT *Client, CHAR *Hostname );
 108 GLOBAL VOID Client_SetID( CLIENT *Client, CHAR *Nick );
 109 GLOBAL VOID Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented );
 110 GLOBAL VOID Client_SetInfo( CLIENT *Client, CHAR *Info );
 111 GLOBAL VOID Client_SetPassword( CLIENT *Client, CHAR *Pwd );
 112 GLOBAL VOID Client_SetType( CLIENT *Client, INT Type );
 113 GLOBAL VOID Client_SetHops( CLIENT *Client, INT Hops );
 114 GLOBAL VOID Client_SetToken( CLIENT *Client, INT Token );
 115 GLOBAL VOID Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe );
 116 GLOBAL VOID Client_SetModes( CLIENT *Client, CHAR *Modes );
 117 GLOBAL VOID Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer );
 118 GLOBAL VOID Client_SetAway( CLIENT *Client, CHAR *Txt );
 119
 120 GLOBAL BOOLEAN Client_ModeAdd( CLIENT *Client, CHAR Mode );
 121 GLOBAL BOOLEAN Client_ModeDel( CLIENT *Client, CHAR Mode );
 122
 123 GLOBAL BOOLEAN Client_CheckNick( CLIENT *Client, CHAR *Nick );
 124 GLOBAL BOOLEAN Client_CheckID( CLIENT *Client, CHAR *ID );
 125
 126 GLOBAL INT Client_UserCount( VOID );
 127 GLOBAL INT Client_ServiceCount( VOID );
 128 GLOBAL INT Client_ServerCount( VOID );
 129 GLOBAL INT Client_OperCount( VOID );
 130 GLOBAL INT Client_UnknownCount( VOID );
 131 GLOBAL INT Client_MyUserCount( VOID );
 132 GLOBAL INT Client_MyServiceCount( VOID );
 133 GLOBAL INT Client_MyServerCount( VOID );
 134
 135 GLOBAL BOOLEAN Client_IsValidNick( CHAR *Nick );
 136
 137
 138 #endif
 139
 140
 141 /* -eof- */