2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
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.
11 * $Id: client.h,v 1.35 2005/03/19 18:43:48 fw Exp $
13 * Client management (header)
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 */
31 #define CLIENT_TYPE int
34 #if defined(__client_c__) | defined(S_SPLINT_S)
38 typedef struct _CLIENT
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 bool 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 */
60 typedef POINTER CLIENT;
65 GLOBAL void Client_Init PARAMS(( void ));
66 GLOBAL void Client_Exit PARAMS(( void ));
68 GLOBAL CLIENT *Client_NewLocal PARAMS(( CONN_ID Idx, char *Hostname, int Type, bool Idented ));
69 GLOBAL CLIENT *Client_NewRemoteServer PARAMS(( CLIENT *Introducer, char *Hostname, CLIENT *TopServer, int Hops, int Token, char *Info, bool Idented ));
70 GLOBAL CLIENT *Client_NewRemoteUser PARAMS(( CLIENT *Introducer, char *Nick, int Hops, char *User, char *Hostname, int Token, char *Modes, char *Info, bool 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, bool Idented ));
73 GLOBAL void Client_Destroy PARAMS(( CLIENT *Client, char *LogMsg, char *FwdMsg, bool SendQuit ));
75 GLOBAL void Client_DestroyNow PARAMS(( CLIENT *Client ));
78 GLOBAL CLIENT *Client_ThisServer PARAMS(( void ));
80 GLOBAL CLIENT *Client_GetFromConn PARAMS(( CONN_ID Idx ));
81 GLOBAL CLIENT *Client_GetFromToken PARAMS(( CLIENT *Client, int Token ));
83 GLOBAL CLIENT *Client_Search PARAMS(( char *ID ));
84 GLOBAL CLIENT *Client_First PARAMS(( void ));
85 GLOBAL CLIENT *Client_Next PARAMS(( CLIENT *c ));
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 bool 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 ));
106 GLOBAL bool Client_HasMode PARAMS(( CLIENT *Client, char Mode ));
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, bool 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, bool 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 ));
122 GLOBAL bool Client_ModeAdd PARAMS(( CLIENT *Client, char Mode ));
123 GLOBAL bool Client_ModeDel PARAMS(( CLIENT *Client, char Mode ));
125 GLOBAL bool Client_CheckNick PARAMS(( CLIENT *Client, char *Nick ));
126 GLOBAL bool Client_CheckID PARAMS(( CLIENT *Client, char *ID ));
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 ));
139 GLOBAL bool Client_IsValidNick PARAMS(( char *Nick ));