include/users.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  Inspire is copyright (C) 2002-2004 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 #include "inspircd_config.h"
  18 #include "channels.h"
  19 #include "inspstring.h"
  20 #include "connection.h"
  21 #include <string>
  22 #ifdef THREADED_DNS
  23 #include <pthread.h>
  24 #endif
  25
  26 #ifndef __USERS_H__
  27 #define __USERS_H__
  28
  29 #include "hashcomp.h"
  30
  31 #define STATUS_OP       4
  32 #define STATUS_HOP      2
  33 #define STATUS_VOICE    1
  34 #define STATUS_NORMAL   0
  35
  36 #define CC_ALLOW        0
  37 #define CC_DENY         1
  38
  39 template<typename T> inline string ConvToStr(const T &in);
  40
  41 /** Holds a channel name to which a user has been invited.
  42  */
  43 class Invited : public classbase
  44 {
  45  public:
  46          irc::string channel;
  47 };
  48
  49
  50 /** Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
  51  */
  52 class ConnectClass : public classbase
  53 {
  54  public:
  55         /** Type of line, either CC_ALLOW or CC_DENY
  56          */
  57         char type;
  58         /** Max time to register the connection in seconds
  59          */
  60         int registration_timeout;
  61         /** Number of lines in buffer before excess flood is triggered
  62          */
  63         int flood;
  64         /** Host mask for this line
  65          */
  66         std::string host;
  67         /** Number of seconds between pings for this line
  68          */
  69         int pingtime;
  70         /** (Optional) Password for this line
  71          */
  72         std::string pass;
  73
  74         /** Threshold value for flood disconnect
  75          */
  76         int threshold;
  77
  78         /** Maximum size of sendq for users in this class (bytes)
  79          */
  80         long sendqmax;
  81
  82         /** Maximum size of recvq for users in this class (bytes)
  83          */
  84         long recvqmax;
  85
  86         ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
  87         {
  88         }
  89 };
  90
  91 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
  92  */
  93 typedef std::vector<Invited> InvitedList;
  94
  95
  96
  97 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
  98  */
  99 typedef std::vector<ConnectClass> ClassVector;
 100
 101 /** Holds all information about a user
 102  * This class stores all information about a user connected to the irc server. Everything about a
 103  * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
 104  * user's nickname and hostname. Use the Find method of the server class to locate a specific user
 105  * by nickname.
 106  */
 107 class userrec : public connection
 108 {
 109  private:
 110
 111         /** A list of channels the user has a pending invite to.
 112          */
 113         InvitedList invites;
 114  public:
 115
 116         /** The users nickname.
 117          * An invalid nickname indicates an unregistered connection prior to the NICK command.
 118          */
 119
 120         char nick[NICKMAX];
 121
 122         /** The users ident reply.
 123          * Two characters are added to the user-defined limit to compensate for the tilde etc.
 124          */
 125         char ident[IDENTMAX+2];
 126
 127         /** The host displayed to non-opers (used for cloaking etc).
 128          * This usually matches the value of userrec::host.
 129          */
 130         char dhost[160];
 131
 132         /** The users full name.
 133          */
 134         char fullname[MAXGECOS+1];
 135
 136         /** The user's mode string.
 137          * This may contain any of the following RFC characters: o, w, s, i
 138          * Your module may define other mode characters as it sees fit.
 139          * it is limited to length 54, as there can only be a maximum of 52
 140          * user modes (26 upper, 26 lower case) a null terminating char, and
 141          * an optional + character.
 142          */
 143         char modes[54];
 144
 145         std::vector<ucrec> chans;
 146
 147         /** The server the user is connected to.
 148          */
 149         char* server;
 150
 151         /** The user's away message.
 152          * If this string is empty, the user is not marked as away.
 153          */
 154         char awaymsg[MAXAWAY+1];
 155
 156         /** Number of lines the user can place into the buffer
 157          * (up to the global NetBufferSize bytes) before they
 158          * are disconnected for excess flood
 159          */
 160         int flood;
 161
 162         /** Number of seconds this user is given to send USER/NICK
 163          * If they do not send their details in this time limit they
 164          * will be disconnected
 165          */
 166         unsigned int timeout;
 167
 168         /** The oper type they logged in as, if they are an oper.
 169          * This is used to check permissions in operclasses, so that
 170          * we can say 'yay' or 'nay' to any commands they issue.
 171          * The value of this is the value of a valid 'type name=' tag.
 172          */
 173         char oper[NICKMAX];
 174
 175         /** True when DNS lookups are completed.
 176          */
 177         bool dns_done;
 178
 179         /** Number of seconds between PINGs for this user (set from &lt;connect:allow&gt; tag
 180          */
 181         unsigned int pingmax;
 182
 183         /** Password specified by the user when they registered.
 184          * This is stored even if the <connect> block doesnt need a password, so that
 185          * modules may check it.
 186          */
 187         char password[MAXBUF];
 188
 189         /** User's receive queue.
 190          * Lines from the IRCd awaiting processing are stored here.
 191          * Upgraded april 2005, old system a bit hairy.
 192          */
 193         std::string recvq;
 194
 195         /** User's send queue.
 196          * Lines waiting to be sent are stored here until their buffer is flushed.
 197          */
 198         std::string sendq;
 199
 200         /** Flood counters
 201          */
 202         int lines_in;
 203         time_t reset_due;
 204         long threshold;
 205
 206         /* Write error string
 207          */
 208         std::string WriteError;
 209
 210         /** Maximum size this user's sendq can become
 211          */
 212         long sendqmax;
 213
 214         /** Maximum size this user's recvq can become
 215          */
 216         long recvqmax;
 217
 218         userrec();
 219
 220         /** Returns the full displayed host of the user
 221          * This member function returns the hostname of the user as seen by other users
 222          * on the server, in nick!ident&at;host form.
 223          */
 224         virtual char* GetFullHost();
 225
 226         /** Returns the full real host of the user
 227          * This member function returns the hostname of the user as seen by other users
 228          * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
 229          * e.g. through a module, then this method will ignore it and return the true hostname.
 230          */
 231         virtual char* GetFullRealHost();
 232
 233         /** Returns true if a user is invited to a channel.
 234          */
 235         virtual bool IsInvited(irc::string &channel);
 236
 237         /** Adds a channel to a users invite list (invites them to a channel)
 238          */
 239         virtual void InviteTo(irc::string &channel);
 240
 241         /** Removes a channel from a users invite list.
 242          * This member function is called on successfully joining an invite only channel
 243          * to which the user has previously been invited, to clear the invitation.
 244          */
 245         virtual void RemoveInvite(irc::string &channel);
 246
 247         /** Returns true or false for if a user can execute a privilaged oper command.
 248          * This is done by looking up their oper type from userrec::oper, then referencing
 249          * this to their oper classes and checking the commands they can execute.
 250          */
 251         bool HasPermission(std::string &command);
 252
 253         /** Calls read() to read some data for this user using their fd.
 254          */
 255         int ReadData(void* buffer, size_t size);
 256
 257         /** This method adds data to the buffer of the user.
 258          * The buffer can grow to any size within limits of the available memory,
 259          * managed by the size of a std::string, however if any individual line in
 260          * the buffer grows over 600 bytes in length (which is 88 chars over the
 261          * RFC-specified limit per line) then the method will return false and the
 262          * text will not be inserted.
 263          */
 264         bool AddBuffer(std::string a);
 265
 266         /** This method returns true if the buffer contains at least one carriage return
 267          * character (e.g. one complete line may be read)
 268          */
 269         bool BufferIsReady();
 270
 271         /** This function clears the entire buffer by setting it to an empty string.
 272          */
 273         void ClearBuffer();
 274
 275         /** This method returns the first available string at the tail end of the buffer
 276          * and advances the tail end of the buffer past the string. This means it is
 277          * a one way operation in a similar way to strtok(), and multiple calls return
 278          * multiple lines if they are available. The results of this function if there
 279          * are no lines to be read are unknown, always use BufferIsReady() to check if
 280          * it is ok to read the buffer before calling GetBuffer().
 281          */
 282         std::string GetBuffer();
 283
 284         /** Sets the write error for a connection. This is done because the actual disconnect
 285          * of a client may occur at an inopportune time such as half way through /LIST output.
 286          * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
 287          * errored clients purged.
 288          */
 289         void SetWriteError(std::string error);
 290
 291         /** Returns the write error which last occured on this connection or an empty string
 292          * if none occured.
 293          */
 294         std::string GetWriteError();
 295
 296         /** Adds to the user's write buffer.
 297          * You may add any amount of text up to this users sendq value, if you exceed the
 298          * sendq value, SetWriteError() will be called to set the users error string to
 299          * "SendQ exceeded", and further buffer adds will be dropped.
 300          */
 301         void AddWriteBuf(std::string data);
 302
 303         /** Flushes as much of the user's buffer to the file descriptor as possible.
 304          * This function may not always flush the entire buffer, rather instead as much of it
 305          * as it possibly can. If the send() call fails to send the entire buffer, the buffer
 306          * position is advanced forwards and the rest of the data sent at the next call to
 307          * this method.
 308          */
 309         void FlushWriteBuf();
 310
 311         /** Returns the list of channels this user has been invited to but has not yet joined.
 312          */
 313         InvitedList* GetInviteList();
 314
 315         /** Shuts down and closes the user's socket
 316          */
 317         void CloseSocket();
 318
 319         virtual ~userrec();
 320
 321 #ifdef THREADED_DNS
 322         pthread_t dnsthread;
 323 #endif
 324 };
 325
 326 /** A lightweight userrec used by WHOWAS
 327  */
 328 class WhoWasUser
 329 {
 330  public:
 331         char nick[NICKMAX];
 332         char ident[IDENTMAX+1];
 333         char dhost[160];
 334         char host[160];
 335         char fullname[MAXGECOS+1];
 336         char server[256];
 337         time_t signon;
 338 };
 339
 340 void AddOper(userrec* user);
 341 void DeleteOper(userrec* user);
 342 void kill_link(userrec *user,const char* r);
 343 void kill_link_silent(userrec *user,const char* r);
 344 void AddWhoWas(userrec* u);
 345 void AddClient(int socket, char* host, int port, bool iscached, char* ip);
 346 void FullConnectUser(userrec* user);
 347 void ConnectUser(userrec *user);
 348 userrec* ReHashNick(char* Old, char* New);
 349 void force_nickchange(userrec* user,const char* newnick);
 350
 351 #endif