2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2008 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 * Client management (header)
17 #define CLIENT_UNKNOWN 1 /* connection of unknown type */
18 #define CLIENT_GOTPASS 2 /* client did send PASS */
19 #define CLIENT_GOTNICK 4 /* client did send NICK */
20 #define CLIENT_GOTUSER 8 /* client did send USER */
21 #define CLIENT_USER 16 /* client is an IRC user */
22 #define CLIENT_SERVER 32 /* client is a server */
23 #define CLIENT_SERVICE 64 /* client is a service */
24 #define CLIENT_UNKNOWNSERVER 128 /* unregistered server connection */
25 #define CLIENT_GOTPASS_2813 256 /* client did send PASS, RFC 2813 style */
27 #define CLIENT_TYPE int
31 #if defined(__client_c__) | defined(S_SPLINT_S)
33 typedef struct _CLIENT
35 time_t starttime; /* Start time of link */
36 char id[CLIENT_ID_LEN]; /* nick (user) / ID (server) */
37 UINT32 hash; /* hash of lower-case ID */
38 POINTER *next; /* pointer to next client structure */
39 CLIENT_TYPE type; /* type of client, see CLIENT_xxx */
40 CONN_ID conn_id; /* ID of the connection (if local) or NONE (remote) */
41 struct _CLIENT *introducer; /* ID of the servers which the client is connected to */
42 struct _CLIENT *topserver; /* toplevel servers (only valid if client is a server) */
43 char pwd[CLIENT_PASS_LEN]; /* password received of the client */
44 char host[CLIENT_HOST_LEN]; /* hostname of the client */
45 char user[CLIENT_USER_LEN]; /* user name ("login") */
46 char info[CLIENT_INFO_LEN]; /* long user name (user) / info text (server) */
47 char modes[CLIENT_MODE_LEN]; /* client modes */
48 int hops, token, mytoken; /* "hops" and "Token" (see SERVER command) */
49 bool oper_by_me; /* client is local IRC operator on this server? */
50 char away[CLIENT_AWAY_LEN]; /* AWAY text (valid if mode 'a' is set) */
51 char flags[CLIENT_FLAGS_LEN]; /* flags of the client */
56 typedef POINTER CLIENT;
61 typedef struct _WHOWAS
63 time_t time; /* time stamp of entry or 0 if unused */
64 char id[CLIENT_NICK_LEN]; /* client nick name */
65 char host[CLIENT_HOST_LEN]; /* hostname of the client */
66 char user[CLIENT_USER_LEN]; /* user name ("login") */
67 char info[CLIENT_INFO_LEN]; /* long user name */
68 char server[CLIENT_HOST_LEN]; /* server name */
72 GLOBAL void Client_Init PARAMS(( void ));
73 GLOBAL void Client_Exit PARAMS(( void ));
75 GLOBAL CLIENT *Client_NewLocal PARAMS(( CONN_ID Idx, char *Hostname, int Type, bool Idented ));
76 GLOBAL CLIENT *Client_NewRemoteServer PARAMS(( CLIENT *Introducer, char *Hostname, CLIENT *TopServer, int Hops, int Token, char *Info, bool Idented ));
77 GLOBAL CLIENT *Client_NewRemoteUser PARAMS(( CLIENT *Introducer, char *Nick, int Hops, char *User, char *Hostname, int Token, char *Modes, char *Info, bool Idented ));
79 GLOBAL void Client_Destroy PARAMS(( CLIENT *Client, char *LogMsg, char *FwdMsg, bool SendQuit ));
81 GLOBAL CLIENT *Client_ThisServer PARAMS(( void ));
83 GLOBAL CLIENT *Client_GetFromToken PARAMS(( CLIENT *Client, int Token ));
85 GLOBAL CLIENT *Client_Search PARAMS(( const char *ID ));
86 GLOBAL CLIENT *Client_First PARAMS(( void ));
87 GLOBAL CLIENT *Client_Next PARAMS(( CLIENT *c ));
89 GLOBAL int Client_Type PARAMS(( CLIENT *Client ));
90 GLOBAL CONN_ID Client_Conn PARAMS(( CLIENT *Client ));
91 GLOBAL char *Client_ID PARAMS(( CLIENT *Client ));
92 GLOBAL char *Client_Mask PARAMS(( CLIENT *Client ));
93 GLOBAL char *Client_Info PARAMS(( CLIENT *Client ));
94 GLOBAL char *Client_User PARAMS(( CLIENT *Client ));
95 GLOBAL char *Client_Hostname PARAMS(( CLIENT *Client ));
96 GLOBAL char *Client_Password PARAMS(( CLIENT *Client ));
97 GLOBAL char *Client_Modes PARAMS(( CLIENT *Client ));
98 GLOBAL char *Client_Flags PARAMS(( CLIENT *Client ));
99 GLOBAL CLIENT *Client_Introducer PARAMS(( CLIENT *Client ));
100 GLOBAL bool Client_OperByMe PARAMS(( CLIENT *Client ));
101 GLOBAL int Client_Hops PARAMS(( CLIENT *Client ));
102 GLOBAL int Client_Token PARAMS(( CLIENT *Client ));
103 GLOBAL int Client_MyToken PARAMS(( CLIENT *Client ));
104 GLOBAL CLIENT *Client_TopServer PARAMS(( CLIENT *Client ));
105 GLOBAL CLIENT *Client_NextHop PARAMS(( CLIENT *Client ));
106 GLOBAL char *Client_Away PARAMS(( CLIENT *Client ));
107 GLOBAL time_t Client_StartTime PARAMS(( CLIENT *Client ));
109 GLOBAL bool Client_HasMode PARAMS(( CLIENT *Client, char Mode ));
111 GLOBAL void Client_SetHostname PARAMS(( CLIENT *Client, char *Hostname ));
112 GLOBAL void Client_SetID PARAMS(( CLIENT *Client, char *Nick ));
113 GLOBAL void Client_SetUser PARAMS(( CLIENT *Client, char *User, bool Idented ));
114 GLOBAL void Client_SetInfo PARAMS(( CLIENT *Client, char *Info ));
115 GLOBAL void Client_SetPassword PARAMS(( CLIENT *Client, char *Pwd ));
116 GLOBAL void Client_SetType PARAMS(( CLIENT *Client, int Type ));
117 GLOBAL void Client_SetHops PARAMS(( CLIENT *Client, int Hops ));
118 GLOBAL void Client_SetToken PARAMS(( CLIENT *Client, int Token ));
119 GLOBAL void Client_SetOperByMe PARAMS(( CLIENT *Client, bool OperByMe ));
120 GLOBAL void Client_SetModes PARAMS(( CLIENT *Client, char *Modes ));
121 GLOBAL void Client_SetFlags PARAMS(( CLIENT *Client, char *Flags ));
122 GLOBAL void Client_SetIntroducer PARAMS(( CLIENT *Client, CLIENT *Introducer ));
123 GLOBAL void Client_SetAway PARAMS(( CLIENT *Client, char *Txt ));
125 GLOBAL bool Client_ModeAdd PARAMS(( CLIENT *Client, char Mode ));
126 GLOBAL bool Client_ModeDel PARAMS(( CLIENT *Client, char Mode ));
128 GLOBAL bool Client_CheckNick PARAMS(( CLIENT *Client, char *Nick ));
129 GLOBAL bool Client_CheckID PARAMS(( CLIENT *Client, char *ID ));
131 GLOBAL long Client_UserCount PARAMS(( void ));
132 GLOBAL long Client_ServiceCount PARAMS(( void ));
133 GLOBAL long Client_ServerCount PARAMS(( void ));
134 GLOBAL unsigned long Client_OperCount PARAMS(( void ));
135 GLOBAL unsigned long Client_UnknownCount PARAMS(( void ));
136 GLOBAL long Client_MyUserCount PARAMS(( void ));
137 GLOBAL long Client_MyServiceCount PARAMS(( void ));
138 GLOBAL unsigned long Client_MyServerCount PARAMS(( void ));
139 GLOBAL long Client_MaxUserCount PARAMS(( void ));
140 GLOBAL long Client_MyMaxUserCount PARAMS(( void ));
142 GLOBAL bool Client_IsValidNick PARAMS(( const char *Nick ));
144 GLOBAL WHOWAS *Client_GetWhowas PARAMS(( void ));
145 GLOBAL int Client_GetLastWhowasIndex PARAMS(( void ));
147 GLOBAL void Client_RegisterWhowas PARAMS(( CLIENT *Client ));
149 GLOBAL char * Client_TypeText PARAMS((CLIENT *Client));