- New function Client_DestroyNow().
[ngircd-alex.git] / 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  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * Please read the file COPYING, README and AUTHORS for more information.
10  *
11  * $Id: client.h,v 1.34 2003/01/15 14:28:25 alex Exp $
12  *
13  * Client management (header)
14  */
15
16
17 #ifndef __client_h__
18 #define __client_h__
19
20
21 #define CLIENT_UNKNOWN 1                /* connection of unknown type */
22 #define CLIENT_GOTPASS 2                /* client did send PASS */
23 #define CLIENT_GOTNICK 4                /* client did send NICK */
24 #define CLIENT_GOTUSER 8                /* client did send USER */
25 #define CLIENT_USER 16                  /* client is an IRC user */
26 #define CLIENT_UNKNOWNSERVER 32         /* unregistered server connection */
27 #define CLIENT_GOTPASSSERVER 64         /* client did send PASS in "server style" */
28 #define CLIENT_SERVER 128               /* client is a server */
29 #define CLIENT_SERVICE 256              /* client is a service */
30
31 #define CLIENT_TYPE INT
32
33
34 #if defined(__client_c__) | defined(S_SPLINT_S)
35
36 #include "defines.h"
37
38 typedef struct _CLIENT
39 {
40         CHAR id[CLIENT_ID_LEN];         /* nick (user) / ID (server) */
41         UINT32 hash;                    /* hash of lower-case ID */
42         POINTER *next;                  /* pointer to next client structure */
43         CLIENT_TYPE type;               /* type of client, see CLIENT_xxx */
44         CONN_ID conn_id;                /* ID of the connection (if local) or NONE (remote) */
45         struct _CLIENT *introducer;     /* ID of the servers which the client is connected to */
46         struct _CLIENT *topserver;      /* toplevel servers (only valid if client is a server) */
47         CHAR pwd[CLIENT_PASS_LEN];      /* password received of the client */
48         CHAR host[CLIENT_HOST_LEN];     /* hostname of the client */
49         CHAR user[CLIENT_USER_LEN];     /* user name ("login") */
50         CHAR info[CLIENT_INFO_LEN];     /* long user name (user) / info text (server) */
51         CHAR modes[CLIENT_MODE_LEN];    /* client modes */
52         INT hops, token, mytoken;       /* "hops" and "Token" (see SERVER command) */
53         BOOLEAN oper_by_me;             /* client is local IRC operator on this server? */
54         CHAR away[CLIENT_AWAY_LEN];     /* AWAY text (valid if mode 'a' is set) */
55         CHAR flags[CLIENT_FLAGS_LEN];   /* flags of the client */
56 } CLIENT;
57
58 #else
59
60 typedef POINTER CLIENT;
61
62 #endif
63
64
65 GLOBAL VOID Client_Init PARAMS(( VOID ));
66 GLOBAL VOID Client_Exit PARAMS(( VOID ));
67
68 GLOBAL CLIENT *Client_NewLocal PARAMS(( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented ));
69 GLOBAL CLIENT *Client_NewRemoteServer PARAMS(( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented ));
70 GLOBAL CLIENT *Client_NewRemoteUser PARAMS(( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented ));
71 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 ));
72
73 GLOBAL VOID Client_Destroy PARAMS(( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit ));
74 #ifdef CONN_MODULE
75 GLOBAL VOID Client_DestroyNow PARAMS(( CLIENT *Client ));
76 #endif
77
78 GLOBAL CLIENT *Client_ThisServer PARAMS(( VOID ));
79
80 GLOBAL CLIENT *Client_GetFromConn PARAMS(( CONN_ID Idx ));
81 GLOBAL CLIENT *Client_GetFromToken PARAMS(( CLIENT *Client, INT Token ));
82
83 GLOBAL CLIENT *Client_Search PARAMS(( CHAR *ID ));
84 GLOBAL CLIENT *Client_First PARAMS(( VOID ));
85 GLOBAL CLIENT *Client_Next PARAMS(( CLIENT *c ));
86
87 GLOBAL INT Client_Type PARAMS(( CLIENT *Client ));
88 GLOBAL CONN_ID Client_Conn PARAMS(( CLIENT *Client ));
89 GLOBAL CHAR *Client_ID PARAMS(( CLIENT *Client ));
90 GLOBAL CHAR *Client_Mask PARAMS(( CLIENT *Client ));
91 GLOBAL CHAR *Client_Info PARAMS(( CLIENT *Client ));
92 GLOBAL CHAR *Client_User PARAMS(( CLIENT *Client ));
93 GLOBAL CHAR *Client_Hostname PARAMS(( CLIENT *Client ));
94 GLOBAL CHAR *Client_Password PARAMS(( CLIENT *Client ));
95 GLOBAL CHAR *Client_Modes PARAMS(( CLIENT *Client ));
96 GLOBAL CHAR *Client_Flags PARAMS(( CLIENT *Client ));
97 GLOBAL CLIENT *Client_Introducer PARAMS(( CLIENT *Client ));
98 GLOBAL BOOLEAN Client_OperByMe PARAMS(( CLIENT *Client ));
99 GLOBAL INT Client_Hops PARAMS(( CLIENT *Client ));
100 GLOBAL INT Client_Token PARAMS(( CLIENT *Client ));
101 GLOBAL INT Client_MyToken PARAMS(( CLIENT *Client ));
102 GLOBAL CLIENT *Client_TopServer PARAMS(( CLIENT *Client ));
103 GLOBAL CLIENT *Client_NextHop PARAMS(( CLIENT *Client ));
104 GLOBAL CHAR *Client_Away PARAMS(( CLIENT *Client ));
105
106 GLOBAL BOOLEAN Client_HasMode PARAMS(( CLIENT *Client, CHAR Mode ));
107
108 GLOBAL VOID Client_SetHostname PARAMS(( CLIENT *Client, CHAR *Hostname ));
109 GLOBAL VOID Client_SetID PARAMS(( CLIENT *Client, CHAR *Nick ));
110 GLOBAL VOID Client_SetUser PARAMS(( CLIENT *Client, CHAR *User, BOOLEAN Idented ));
111 GLOBAL VOID Client_SetInfo PARAMS(( CLIENT *Client, CHAR *Info ));
112 GLOBAL VOID Client_SetPassword PARAMS(( CLIENT *Client, CHAR *Pwd ));
113 GLOBAL VOID Client_SetType PARAMS(( CLIENT *Client, INT Type ));
114 GLOBAL VOID Client_SetHops PARAMS(( CLIENT *Client, INT Hops ));
115 GLOBAL VOID Client_SetToken PARAMS(( CLIENT *Client, INT Token ));
116 GLOBAL VOID Client_SetOperByMe PARAMS(( CLIENT *Client, BOOLEAN OperByMe ));
117 GLOBAL VOID Client_SetModes PARAMS(( CLIENT *Client, CHAR *Modes ));
118 GLOBAL VOID Client_SetFlags PARAMS(( CLIENT *Client, CHAR *Flags ));
119 GLOBAL VOID Client_SetIntroducer PARAMS(( CLIENT *Client, CLIENT *Introducer ));
120 GLOBAL VOID Client_SetAway PARAMS(( CLIENT *Client, CHAR *Txt ));
121
122 GLOBAL BOOLEAN Client_ModeAdd PARAMS(( CLIENT *Client, CHAR Mode ));
123 GLOBAL BOOLEAN Client_ModeDel PARAMS(( CLIENT *Client, CHAR Mode ));
124
125 GLOBAL BOOLEAN Client_CheckNick PARAMS(( CLIENT *Client, CHAR *Nick ));
126 GLOBAL BOOLEAN Client_CheckID PARAMS(( CLIENT *Client, CHAR *ID ));
127
128 GLOBAL LONG Client_UserCount PARAMS(( VOID ));
129 GLOBAL LONG Client_ServiceCount PARAMS(( VOID ));
130 GLOBAL LONG Client_ServerCount PARAMS(( VOID ));
131 GLOBAL LONG Client_OperCount PARAMS(( VOID ));
132 GLOBAL LONG Client_UnknownCount PARAMS(( VOID ));
133 GLOBAL LONG Client_MyUserCount PARAMS(( VOID ));
134 GLOBAL LONG Client_MyServiceCount PARAMS(( VOID ));
135 GLOBAL LONG Client_MyServerCount PARAMS(( VOID ));
136 GLOBAL LONG Client_MaxUserCount PARAMS((  VOID ));
137 GLOBAL LONG Client_MyMaxUserCount PARAMS((  VOID ));
138
139 GLOBAL BOOLEAN Client_IsValidNick PARAMS(( CHAR *Nick ));
140
141
142 #endif
143
144
145 /* -eof- */