include/users.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef __USERS_H__
  18 #define __USERS_H__
  19
  20 #include <string>
  21 #include "inspircd_config.h"
  22 #include "socket.h"
  23 #include "channels.h"
  24 #include "inspstring.h"
  25 #include "connection.h"
  26 #include "hashcomp.h"
  27 #include "dns.h"
  28 #include "cull_list.h"
  29
  30 enum ChanStatus {
  31         STATUS_OP     = 4,
  32         STATUS_HOP    = 2,
  33         STATUS_VOICE  = 1,
  34         STATUS_NORMAL = 0
  35 };
  36
  37 enum ClassTypes {
  38         CC_ALLOW = 0,
  39         CC_DENY  = 1
  40 };
  41
  42 /** RFC1459 channel modes
  43  *  */
  44 enum UserModes {
  45         UM_SERVERNOTICE = 's'-65,
  46         UM_WALLOPS = 'w'-65,
  47         UM_INVISIBLE = 'i'-65,
  48         UM_OPERATOR = 'o'-65,
  49 };
  50
  51 enum RegistrationState {
  52         REG_NONE = 0,           /* Has sent nothing */
  53         REG_USER = 1,           /* Has sent USER */
  54         REG_NICK = 2,           /* Has sent NICK */
  55         REG_NICKUSER = 3,       /* Bitwise combination of REG_NICK and REG_USER */
  56         REG_ALL = 7             /* REG_NICKUSER plus next bit along */
  57 };
  58
  59 /** Holds a channel name to which a user has been invited.
  60  */
  61 class Invited : public classbase
  62 {
  63  public:
  64          irc::string channel;
  65 };
  66
  67
  68
  69 /** Derived from Resolver, and performs user forward/reverse lookups.
  70  */
  71 class UserResolver : public Resolver
  72 {
  73  private:
  74         /** User this class is 'attached' to.
  75          */
  76         userrec* bound_user;
  77         int bound_fd;
  78         bool fwd;
  79  public:
  80         UserResolver(userrec* user, std::string to_resolve, bool forward);
  81
  82         void OnLookupComplete(const std::string &result);
  83         void OnError(ResolverError e, const std::string &errormessage);
  84 };
  85
  86
  87 /** Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
  88  */
  89 class ConnectClass : public classbase
  90 {
  91  public:
  92         /** Type of line, either CC_ALLOW or CC_DENY
  93          */
  94         char type;
  95         /** Max time to register the connection in seconds
  96          */
  97         int registration_timeout;
  98         /** Number of lines in buffer before excess flood is triggered
  99          */
 100         int flood;
 101         /** Host mask for this line
 102          */
 103         std::string host;
 104         /** Number of seconds between pings for this line
 105          */
 106         int pingtime;
 107         /** (Optional) Password for this line
 108          */
 109         std::string pass;
 110
 111         /** Threshold value for flood disconnect
 112          */
 113         int threshold;
 114
 115         /** Maximum size of sendq for users in this class (bytes)
 116          */
 117         long sendqmax;
 118
 119         /** Maximum size of recvq for users in this class (bytes)
 120          */
 121         long recvqmax;
 122
 123         /** Local max when connecting by this connection class
 124          */
 125         long maxlocal;
 126
 127         /** Global max when connecting by this connection class
 128          */
 129         long maxglobal;
 130
 131         ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
 132         {
 133         }
 134 };
 135
 136 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
 137  */
 138 typedef std::vector<Invited> InvitedList;
 139
 140
 141
 142 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
 143  */
 144 typedef std::vector<ConnectClass> ClassVector;
 145
 146 /** Typedef for the list of user-channel records for a user
 147  */
 148 typedef std::vector<ucrec*> UserChanList;
 149
 150 /** Holds all information about a user
 151  * This class stores all information about a user connected to the irc server. Everything about a
 152  * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
 153  * user's nickname and hostname. Use the Find method of the server class to locate a specific user
 154  * by nickname.
 155  */
 156 class userrec : public connection
 157 {
 158  private:
 159
 160         /** A list of channels the user has a pending invite to.
 161          */
 162         InvitedList invites;
 163  public:
 164         /** Resolvers for looking up this users hostname
 165          */
 166         UserResolver* res_forward;
 167         UserResolver* res_reverse;
 168         std::string stored_host;
 169
 170         void StartDNSLookup();
 171
 172         /** The users nickname.
 173          * An invalid nickname indicates an unregistered connection prior to the NICK command.
 174          */
 175
 176         char nick[NICKMAX];
 177
 178         /** The users ident reply.
 179          * Two characters are added to the user-defined limit to compensate for the tilde etc.
 180          */
 181         char ident[IDENTMAX+2];
 182
 183         /** The host displayed to non-opers (used for cloaking etc).
 184          * This usually matches the value of userrec::host.
 185          */
 186         char dhost[65];
 187
 188         /** The users full name.
 189          */
 190         char fullname[MAXGECOS+1];
 191
 192         /** The user's mode list.
 193          * This is NOT a null terminated string! In the 1.1 version of InspIRCd
 194          * this is an array of values in a similar way to channel modes.
 195          * A value of 1 in field (modeletter-65) indicates that the mode is
 196          * set, for example, to work out if mode +s is set, we  check the field
 197          * userrec::modes['s'-65] != 0.
 198          * The following RFC characters o, w, s, i have constants defined via an
 199          * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
 200          */
 201         char modes[64];
 202
 203         /** What snomasks are set on this user.
 204          * This functions the same as the above modes.
 205          */
 206         char snomasks[64];
 207
 208         UserChanList chans;
 209
 210         /** The server the user is connected to.
 211          */
 212         const char* server;
 213
 214         /** The user's away message.
 215          * If this string is empty, the user is not marked as away.
 216          */
 217         char awaymsg[MAXAWAY+1];
 218
 219         /** Number of lines the user can place into the buffer
 220          * (up to the global NetBufferSize bytes) before they
 221          * are disconnected for excess flood
 222          */
 223         int flood;
 224
 225         /** Number of seconds this user is given to send USER/NICK
 226          * If they do not send their details in this time limit they
 227          * will be disconnected
 228          */
 229         unsigned int timeout;
 230
 231         /** The oper type they logged in as, if they are an oper.
 232          * This is used to check permissions in operclasses, so that
 233          * we can say 'yay' or 'nay' to any commands they issue.
 234          * The value of this is the value of a valid 'type name=' tag.
 235          */
 236         char oper[NICKMAX];
 237
 238         /** True when DNS lookups are completed.
 239          */
 240         bool dns_done;
 241
 242         /** Number of seconds between PINGs for this user (set from &lt;connect:allow&gt; tag
 243          */
 244         unsigned int pingmax;
 245
 246         /** Password specified by the user when they registered.
 247          * This is stored even if the <connect> block doesnt need a password, so that
 248          * modules may check it.
 249          */
 250         char password[64];
 251
 252         /** User's receive queue.
 253          * Lines from the IRCd awaiting processing are stored here.
 254          * Upgraded april 2005, old system a bit hairy.
 255          */
 256         std::string recvq;
 257
 258         /** User's send queue.
 259          * Lines waiting to be sent are stored here until their buffer is flushed.
 260          */
 261         std::string sendq;
 262
 263         /** Flood counters
 264          */
 265         int lines_in;
 266         time_t reset_due;
 267         long threshold;
 268
 269         /** IPV4 ip address
 270          */
 271         insp_inaddr ip4;
 272
 273         /* Write error string
 274          */
 275         std::string WriteError;
 276
 277         /** Maximum size this user's sendq can become
 278          */
 279         long sendqmax;
 280
 281         /** Maximum size this user's recvq can become
 282          */
 283         long recvqmax;
 284
 285         /** Default constructor
 286          */
 287         userrec();
 288
 289         /** Returns the full displayed host of the user
 290          * This member function returns the hostname of the user as seen by other users
 291          * on the server, in nick!ident&at;host form.
 292          */
 293         virtual char* GetFullHost();
 294
 295         /** Returns the full real host of the user
 296          * This member function returns the hostname of the user as seen by other users
 297          * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
 298          * e.g. through a module, then this method will ignore it and return the true hostname.
 299          */
 300         virtual char* GetFullRealHost();
 301
 302         /*
 303          * Create a displayable mode string for this users umodes
 304          */
 305         const char* FormatNoticeMasks();
 306
 307         bool userrec::ProcessNoticeMasks(const char *sm);
 308
 309         bool IsNoticeMaskSet(unsigned char sm);
 310
 311         void SetNoticeMask(unsigned char sm, bool value);
 312
 313         /*
 314          * Create a displayable mode string for this users umodes
 315          */
 316         const char* FormatModes();
 317
 318         bool IsModeSet(unsigned char m);
 319
 320         void SetMode(unsigned char m, bool value);
 321
 322         /** Returns true if a user is invited to a channel.
 323          */
 324         virtual bool IsInvited(irc::string &channel);
 325
 326         /** Adds a channel to a users invite list (invites them to a channel)
 327          */
 328         virtual void InviteTo(irc::string &channel);
 329
 330         /** Removes a channel from a users invite list.
 331          * This member function is called on successfully joining an invite only channel
 332          * to which the user has previously been invited, to clear the invitation.
 333          */
 334         virtual void RemoveInvite(irc::string &channel);
 335
 336         /** Returns true or false for if a user can execute a privilaged oper command.
 337          * This is done by looking up their oper type from userrec::oper, then referencing
 338          * this to their oper classes and checking the commands they can execute.
 339          */
 340         bool HasPermission(const std::string &command);
 341
 342         /** Calls read() to read some data for this user using their fd.
 343          */
 344         int ReadData(void* buffer, size_t size);
 345
 346         /** This method adds data to the buffer of the user.
 347          * The buffer can grow to any size within limits of the available memory,
 348          * managed by the size of a std::string, however if any individual line in
 349          * the buffer grows over 600 bytes in length (which is 88 chars over the
 350          * RFC-specified limit per line) then the method will return false and the
 351          * text will not be inserted.
 352          */
 353         bool AddBuffer(const std::string &a);
 354
 355         /** This method returns true if the buffer contains at least one carriage return
 356          * character (e.g. one complete line may be read)
 357          */
 358         bool BufferIsReady();
 359
 360         /** This function clears the entire buffer by setting it to an empty string.
 361          */
 362         void ClearBuffer();
 363
 364         /** This method returns the first available string at the tail end of the buffer
 365          * and advances the tail end of the buffer past the string. This means it is
 366          * a one way operation in a similar way to strtok(), and multiple calls return
 367          * multiple lines if they are available. The results of this function if there
 368          * are no lines to be read are unknown, always use BufferIsReady() to check if
 369          * it is ok to read the buffer before calling GetBuffer().
 370          */
 371         std::string GetBuffer();
 372
 373         /** Sets the write error for a connection. This is done because the actual disconnect
 374          * of a client may occur at an inopportune time such as half way through /LIST output.
 375          * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
 376          * errored clients purged.
 377          */
 378         void SetWriteError(const std::string &error);
 379
 380         /** Returns the write error which last occured on this connection or an empty string
 381          * if none occured.
 382          */
 383         const char* GetWriteError();
 384
 385         /** Adds to the user's write buffer.
 386          * You may add any amount of text up to this users sendq value, if you exceed the
 387          * sendq value, SetWriteError() will be called to set the users error string to
 388          * "SendQ exceeded", and further buffer adds will be dropped.
 389          */
 390         void AddWriteBuf(const std::string &data);
 391
 392         /** Flushes as much of the user's buffer to the file descriptor as possible.
 393          * This function may not always flush the entire buffer, rather instead as much of it
 394          * as it possibly can. If the send() call fails to send the entire buffer, the buffer
 395          * position is advanced forwards and the rest of the data sent at the next call to
 396          * this method.
 397          */
 398         void FlushWriteBuf();
 399
 400         /** Returns the list of channels this user has been invited to but has not yet joined.
 401          */
 402         InvitedList* GetInviteList();
 403
 404         /** Creates a wildcard host.
 405          * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
 406          */
 407         char* MakeWildHost();
 408
 409         /** Creates a host.
 410          * Takes a buffer to use and fills the given buffer with the host in the format nick!user@host
 411          */
 412         void MakeHost(char* nhost);
 413
 414         /** Shuts down and closes the user's socket
 415          */
 416         void CloseSocket();
 417
 418         /** Default destructor
 419          */
 420         virtual ~userrec();
 421 };
 422
 423 /** Used to hold WHOWAS information
 424  */
 425 class WhoWasGroup : public classbase
 426 {
 427  public:
 428         char* host;
 429         char* dhost;
 430         char* ident;
 431         const char* server;
 432         char* gecos;
 433         time_t signon;
 434
 435         WhoWasGroup(userrec* user);
 436         ~WhoWasGroup();
 437 };
 438
 439 typedef std::deque<WhoWasGroup*> whowas_set;
 440 typedef std::map<irc::string,whowas_set*> whowas_users;
 441
 442 void AddOper(userrec* user);
 443 void DeleteOper(userrec* user);
 444 void kill_link(userrec *user,const char* r);
 445 void kill_link_silent(userrec *user,const char* r);
 446 void AddWhoWas(userrec* u);
 447 void MaintainWhoWas(time_t TIME);
 448 void AddClient(int socket, int port, bool iscached, insp_inaddr ip4);
 449 void FullConnectUser(userrec* user, CullList* Goners);
 450 userrec* ReHashNick(const char* Old, const char* New);
 451 void force_nickchange(userrec* user,const char* newnick);
 452
 453 /* Configuration callbacks */
 454 bool InitTypes(const char* tag);
 455 bool InitClasses(const char* tag);
 456 bool DoType(const char* tag, char** entries, void** values, int* types);
 457 bool DoClass(const char* tag, char** entries, void** values, int* types);
 458 bool DoneClassesAndTypes(const char* tag);
 459
 460 long FindMatchingGlobal(userrec* user);
 461 long FindMatchingLocal(userrec* user);
 462
 463 #endif