16b2a61ab8564808ad6c58066898602e30431cab
[ngircd-alex.git] / src / ngircd / client.h
1 /*
2  * ngIRCd -- The Next Generation IRC Daemon
3  * Copyright (c)2001-2012 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
12 #ifndef __client_h__
13 #define __client_h__
14
15 /**
16  * @file
17  * Client management (header)
18  */
19
20 #define CLIENT_UNKNOWN 1                /* connection of unknown type */
21 #define CLIENT_GOTPASS 2                /* client did send PASS */
22 #define CLIENT_GOTNICK 4                /* client did send NICK */
23 #define CLIENT_GOTUSER 8                /* client did send USER */
24 #define CLIENT_USER 16                  /* client is an IRC user */
25 #define CLIENT_SERVER 32                /* client is a server */
26 #define CLIENT_SERVICE 64               /* client is a service */
27 #define CLIENT_UNKNOWNSERVER 128        /* unregistered server connection */
28 #define CLIENT_GOTPASS_2813 256         /* client did send PASS, RFC 2813 style */
29 #ifndef STRICT_RFC
30 # define CLIENT_WAITAUTHPING 512        /* waiting for AUTH PONG from client */
31 #endif
32 #define CLIENT_WAITCAPEND 1024          /* waiting for "CAP END" command */
33
34 #define CLIENT_TYPE int
35
36 #include "defines.h"
37
38 #if defined(__client_c__) | defined(__client_cap_c__) | defined(S_SPLINT_S)
39
40 typedef struct _CLIENT
41 {
42         time_t starttime;               /* Start time of link */
43         char id[CLIENT_ID_LEN];         /* nick (user) / ID (server) */
44         UINT32 hash;                    /* hash of lower-case ID */
45         POINTER *next;                  /* pointer to next client structure */
46         CLIENT_TYPE type;               /* type of client, see CLIENT_xxx */
47         CONN_ID conn_id;                /* ID of the connection (if local) or NONE (remote) */
48         struct _CLIENT *introducer;     /* ID of the servers which the client is connected to */
49         struct _CLIENT *topserver;      /* toplevel servers (only valid if client is a server) */
50         char host[CLIENT_HOST_LEN];     /* hostname of the client */
51         char user[CLIENT_USER_LEN];     /* user name ("login") */
52 #if defined(PAM) && defined(IDENTAUTH)
53         char orig_user[CLIENT_USER_LEN];/* user name supplied by USER command */
54 #endif
55         char info[CLIENT_INFO_LEN];     /* long user name (user) / info text (server) */
56         char modes[CLIENT_MODE_LEN];    /* client modes */
57         int hops, token, mytoken;       /* "hops" and "Token" (see SERVER command) */
58         bool oper_by_me;                /* client is local IRC operator on this server? */
59         char away[CLIENT_AWAY_LEN];     /* AWAY text (valid if mode 'a' is set) */
60         char flags[CLIENT_FLAGS_LEN];   /* flags of the client */
61         int capabilities;               /* enabled IRC capabilities */
62 } CLIENT;
63
64 #else
65
66 typedef POINTER CLIENT;
67
68 #endif
69
70
71 typedef struct _WHOWAS
72 {
73         time_t time;                    /* time stamp of entry or 0 if unused */
74         char id[CLIENT_NICK_LEN];       /* client nick name */
75         char host[CLIENT_HOST_LEN];     /* hostname of the client */
76         char user[CLIENT_USER_LEN];     /* user name ("login") */
77         char info[CLIENT_INFO_LEN];     /* long user name */
78         char server[CLIENT_HOST_LEN];   /* server name */
79 } WHOWAS;
80
81
82 GLOBAL void Client_Init PARAMS(( void ));
83 GLOBAL void Client_Exit PARAMS(( void ));
84
85 GLOBAL CLIENT *Client_NewLocal PARAMS(( CONN_ID Idx, const char *Hostname, int Type, bool Idented ));
86 GLOBAL CLIENT *Client_NewRemoteServer PARAMS(( CLIENT *Introducer, const char *Hostname, CLIENT *TopServer, int Hops, int Token, const char *Info, bool Idented ));
87 GLOBAL CLIENT *Client_NewRemoteUser PARAMS(( CLIENT *Introducer, const char *Nick, int Hops, const char *User, const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented ));
88
89 GLOBAL void Client_Destroy PARAMS(( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit ));
90
91 GLOBAL CLIENT *Client_ThisServer PARAMS(( void ));
92
93 GLOBAL CLIENT *Client_GetFromToken PARAMS(( CLIENT *Client, int Token ));
94
95 GLOBAL CLIENT *Client_Search PARAMS(( const char *ID ));
96 GLOBAL CLIENT *Client_First PARAMS(( void ));
97 GLOBAL CLIENT *Client_Next PARAMS(( CLIENT *c ));
98
99 GLOBAL int Client_Type PARAMS(( CLIENT *Client ));
100 GLOBAL CONN_ID Client_Conn PARAMS(( CLIENT *Client ));
101 GLOBAL char *Client_ID PARAMS(( CLIENT *Client ));
102 GLOBAL char *Client_Mask PARAMS(( CLIENT *Client ));
103 GLOBAL char *Client_MaskCloaked PARAMS(( CLIENT *Client ));
104 GLOBAL char *Client_Info PARAMS(( CLIENT *Client ));
105 GLOBAL char *Client_User PARAMS(( CLIENT *Client ));
106 #ifdef PAM
107 GLOBAL char *Client_OrigUser PARAMS(( CLIENT *Client ));
108 #endif
109 GLOBAL char *Client_Hostname PARAMS(( CLIENT *Client ));
110 GLOBAL char *Client_HostnameCloaked PARAMS(( CLIENT *Client ));
111 GLOBAL char *Client_Modes PARAMS(( CLIENT *Client ));
112 GLOBAL char *Client_Flags PARAMS(( CLIENT *Client ));
113 GLOBAL CLIENT *Client_Introducer PARAMS(( CLIENT *Client ));
114 GLOBAL bool Client_OperByMe PARAMS(( CLIENT *Client ));
115 GLOBAL int Client_Hops PARAMS(( CLIENT *Client ));
116 GLOBAL int Client_Token PARAMS(( CLIENT *Client ));
117 GLOBAL int Client_MyToken PARAMS(( CLIENT *Client ));
118 GLOBAL CLIENT *Client_TopServer PARAMS(( CLIENT *Client ));
119 GLOBAL CLIENT *Client_NextHop PARAMS(( CLIENT *Client ));
120 GLOBAL char *Client_Away PARAMS(( CLIENT *Client ));
121 GLOBAL time_t Client_StartTime PARAMS(( CLIENT *Client ));
122
123 GLOBAL bool Client_HasMode PARAMS(( CLIENT *Client, char Mode ));
124
125 GLOBAL void Client_SetHostname PARAMS(( CLIENT *Client, const char *Hostname ));
126 GLOBAL void Client_SetID PARAMS(( CLIENT *Client, const char *Nick ));
127 GLOBAL void Client_SetUser PARAMS(( CLIENT *Client, const char *User, bool Idented ));
128 GLOBAL void Client_SetOrigUser PARAMS(( CLIENT *Client, const char *User ));
129 GLOBAL void Client_SetInfo PARAMS(( CLIENT *Client, const char *Info ));
130 GLOBAL void Client_SetType PARAMS(( CLIENT *Client, int Type ));
131 GLOBAL void Client_SetHops PARAMS(( CLIENT *Client, int Hops ));
132 GLOBAL void Client_SetToken PARAMS(( CLIENT *Client, int Token ));
133 GLOBAL void Client_SetOperByMe PARAMS(( CLIENT *Client, bool OperByMe ));
134 GLOBAL void Client_SetModes PARAMS(( CLIENT *Client, const char *Modes ));
135 GLOBAL void Client_SetFlags PARAMS(( CLIENT *Client, const char *Flags ));
136 GLOBAL void Client_SetIntroducer PARAMS(( CLIENT *Client, CLIENT *Introducer ));
137 GLOBAL void Client_SetAway PARAMS(( CLIENT *Client, const char *Txt ));
138
139 GLOBAL bool Client_ModeAdd PARAMS(( CLIENT *Client, char Mode ));
140 GLOBAL bool Client_ModeDel PARAMS(( CLIENT *Client, char Mode ));
141
142 GLOBAL bool Client_CheckNick PARAMS(( CLIENT *Client, char *Nick ));
143 GLOBAL bool Client_CheckID PARAMS(( CLIENT *Client, char *ID ));
144
145 GLOBAL long Client_UserCount PARAMS(( void ));
146 GLOBAL long Client_ServiceCount PARAMS(( void ));
147 GLOBAL long Client_ServerCount PARAMS(( void ));
148 GLOBAL unsigned long Client_OperCount PARAMS(( void ));
149 GLOBAL unsigned long Client_UnknownCount PARAMS(( void ));
150 GLOBAL long Client_MyUserCount PARAMS(( void ));
151 GLOBAL long Client_MyServiceCount PARAMS(( void ));
152 GLOBAL unsigned long Client_MyServerCount PARAMS(( void ));
153 GLOBAL long Client_MaxUserCount PARAMS((  void ));
154 GLOBAL long Client_MyMaxUserCount PARAMS((  void ));
155
156 GLOBAL bool Client_IsValidNick PARAMS(( const char *Nick ));
157
158 GLOBAL WHOWAS *Client_GetWhowas PARAMS(( void ));
159 GLOBAL int Client_GetLastWhowasIndex PARAMS(( void ));
160
161 GLOBAL void Client_RegisterWhowas PARAMS(( CLIENT *Client ));
162
163 GLOBAL const char *Client_TypeText PARAMS((CLIENT *Client));
164
165 GLOBAL void Client_Reject PARAMS((CLIENT *Client, const char *Reason,
166                                   bool InformClient));
167 GLOBAL void Client_Introduce PARAMS((CLIENT *From, CLIENT *Client, int Type));
168
169
170 #ifdef DEBUG
171 GLOBAL void Client_DebugDump PARAMS((void));
172 #endif
173
174 #endif
175
176 /* -eof- */