include/users.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __USERS_H__
  15 #define __USERS_H__
  16
  17 #include <string>
  18 #include "inspircd_config.h"
  19 #include "socket.h"
  20 #include "channels.h"
  21 #include "inspstring.h"
  22 #include "connection.h"
  23 #include "hashcomp.h"
  24 #include "dns.h"
  25
  26 /** Channel status for a user
  27  */
  28 enum ChanStatus {
  29         /** Op */
  30         STATUS_OP     = 4,
  31         /** Halfop */
  32         STATUS_HOP    = 2,
  33         /** Voice */
  34         STATUS_VOICE  = 1,
  35         /** None */
  36         STATUS_NORMAL = 0
  37 };
  38
  39 /** connect class types
  40  */
  41 enum ClassTypes {
  42         /** connect:allow */
  43         CC_ALLOW = 0,
  44         /** connect:deny */
  45         CC_DENY  = 1
  46 };
  47
  48 /** RFC1459 channel modes
  49  */
  50 enum UserModes {
  51         /** +s: Server notices */
  52         UM_SERVERNOTICE = 's' - 65,
  53         /** +w: WALLOPS */
  54         UM_WALLOPS = 'w' - 65,
  55         /** +i: Invisible */
  56         UM_INVISIBLE = 'i' - 65,
  57         /** +o: Operator */
  58         UM_OPERATOR = 'o' - 65,
  59         /** +n: Server notice mask */
  60         UM_SNOMASK = 'n' - 65
  61 };
  62
  63 /** Registration state of a user, e.g.
  64  * have they sent USER, NICK, PASS yet?
  65  */
  66 enum RegistrationState {
  67
  68 #ifndef WIN32   // Burlex: This is already defined in win32, luckily it is still 0.
  69         REG_NONE = 0,           /* Has sent nothing */
  70 #endif
  71
  72         REG_USER = 1,           /* Has sent USER */
  73         REG_NICK = 2,           /* Has sent NICK */
  74         REG_NICKUSER = 3,       /* Bitwise combination of REG_NICK and REG_USER */
  75         REG_ALL = 7             /* REG_NICKUSER plus next bit along */
  76 };
  77
  78 /* Required forward declaration */
  79 class InspIRCd;
  80
  81 /** Derived from Resolver, and performs user forward/reverse lookups.
  82  */
  83 class CoreExport UserResolver : public Resolver
  84 {
  85  private:
  86         /** User this class is 'attached' to.
  87          */
  88         User* bound_user;
  89         /** File descriptor teh lookup is bound to
  90          */
  91         int bound_fd;
  92         /** True if the lookup is forward, false if is a reverse lookup
  93          */
  94         bool fwd;
  95  public:
  96         /** Create a resolver.
  97          * @param Instance The creating instance
  98          * @param user The user to begin lookup on
  99          * @param to_resolve The IP or host to resolve
 100          * @param qt The query type
 101          * @param cache Modified by the constructor if the result was cached
 102          */
 103         UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
 104
 105         /** Called on successful lookup
 106          * @param result Result string
 107          * @param ttl Time to live for result
 108          * @param cached True if the result was found in the cache
 109          * @param resultnum Result number, we are only interested in result 0
 110          */
 111         void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
 112
 113         /** Called on failed lookup
 114          * @param e Error code
 115          * @param errormessage Error message string
 116          */
 117         void OnError(ResolverError e, const std::string &errormessage);
 118 };
 119
 120
 121 /** Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
 122  */
 123 class CoreExport ConnectClass : public classbase
 124 {
 125  private:
 126         /** Type of line, either CC_ALLOW or CC_DENY
 127          */
 128         char type;
 129         /** Connect class name
 130          */
 131         std::string name;
 132         /** Max time to register the connection in seconds
 133          */
 134         unsigned int registration_timeout;
 135         /** Number of lines in buffer before excess flood is triggered
 136          */
 137         unsigned int flood;
 138         /** Host mask for this line
 139          */
 140         std::string host;
 141         /** Number of seconds between pings for this line
 142          */
 143         unsigned int pingtime;
 144         /** (Optional) Password for this line
 145          */
 146         std::string pass;
 147
 148         /** (Optional) Hash Method for this line
 149          */
 150         std::string hash;
 151
 152         /** Threshold value for flood disconnect
 153          */
 154         unsigned int threshold;
 155
 156         /** Maximum size of sendq for users in this class (bytes)
 157          */
 158         unsigned long sendqmax;
 159
 160         /** Maximum size of recvq for users in this class (bytes)
 161          */
 162         unsigned long recvqmax;
 163
 164         /** Local max when connecting by this connection class
 165          */
 166         unsigned long maxlocal;
 167
 168         /** Global max when connecting by this connection class
 169          */
 170         unsigned long maxglobal;
 171
 172         /** Max channels for this class
 173          */
 174         unsigned int maxchans;
 175
 176         /** Port number this connect class applies to
 177          */
 178         int port;
 179
 180 public:
 181
 182         /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
 183          */
 184         ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
 185                 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
 186                 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
 187                 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
 188                 port(source->port), RefCount(0), disabled(false), limit(0)
 189         {
 190         }
 191
 192         /** Create a new connect class with no settings.
 193          */
 194         ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
 195                         threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
 196         {
 197         }
 198
 199         /** Create a new connect class to ALLOW connections.
 200          * @param thename Name of the connect class
 201          * @param timeout The registration timeout
 202          * @param fld The flood value
 203          * @param hst The IP mask to allow
 204          * @param ping The ping frequency
 205          * @param pas The password to be used
 206          * @param hsh The hash to be used
 207          * @param thres The flooding threshold
 208          * @param sendq The maximum sendq value
 209          * @param recvq The maximum recvq value
 210          * @param maxl The maximum local sessions
 211          * @param maxg The maximum global sessions
 212          */
 213         ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
 214                         const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
 215                         unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
 216                         type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
 217                         threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
 218
 219         /** Create a new connect class to DENY connections
 220          * @param thename Name of the connect class
 221          * @param hst The IP mask to deny
 222          */
 223         ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
 224                         flood(0), host(hst), pingtime(0), pass(""), hash(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
 225         {
 226         }
 227
 228         /* Create a new connect class based on another class
 229          * @param thename The name of the connect class
 230          * @param source Another connect class to inherit all but the name from
 231          */
 232         ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
 233                                 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
 234                                 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
 235                                 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
 236                                 port(source->port), RefCount(0), disabled(false), limit(0)
 237         {
 238         }
 239
 240         void SetDisabled(bool t)
 241         {
 242                 this->disabled = t;
 243         }
 244
 245         bool GetDisabled()
 246         {
 247                 return this->disabled;
 248         }
 249
 250         /* Update an existing entry with new values
 251          */
 252         void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
 253                                 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
 254                                 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long limit)
 255         {
 256                 if (timeout)
 257                         registration_timeout = timeout;
 258                 if (fld)
 259                         flood = fld;
 260                 if (!hst.empty())
 261                         host = hst;
 262                 if (ping)
 263                         pingtime = ping;
 264                 if (!pas.empty())
 265                         pass = pas;
 266                 if (thres)
 267                         threshold = thres;
 268                 if (sendq)
 269                         sendqmax = sendq;
 270                 if (recvq)
 271                         recvqmax = recvq;
 272                 if (maxl)
 273                         maxlocal = maxl;
 274                 if (maxg)
 275                         maxglobal = maxg;
 276                 if (maxc)
 277                         maxchans = maxc;
 278                 if (p)
 279                         port = p;
 280
 281                 this->limit = limit;
 282         }
 283
 284         /** Reference counter. Contains an int as to how many users are connected to this class. :)
 285          * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
 286          * are 0 users on it - it will go away in RAM. :)
 287          */
 288         unsigned long RefCount;
 289
 290         /** If this is true, any attempt to set a user to this class will fail. Default false. This is really private, it's only in the public section thanks to the way this class is written
 291          */
 292         bool disabled;
 293
 294         /** How many users may be in this connect class before they are refused? (0 = disabled = default)
 295          */
 296         unsigned long limit;
 297
 298         int GetMaxChans()
 299         {
 300                 return maxchans;
 301         }
 302
 303         /** Returns the type, CC_ALLOW or CC_DENY
 304          */
 305         char GetType()
 306         {
 307                 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
 308         }
 309
 310         std::string& GetName()
 311         {
 312                 return name;
 313         }
 314
 315         /** Returns the registration timeout
 316          */
 317         unsigned int GetRegTimeout()
 318         {
 319                 return (registration_timeout ? registration_timeout : 90);
 320         }
 321
 322         /** Returns the flood limit
 323          */
 324         unsigned int GetFlood()
 325         {
 326                 return (threshold ? flood : 999);
 327         }
 328
 329         /** Returns the allowed or denied IP mask
 330          */
 331         const std::string& GetHost()
 332         {
 333                 return host;
 334         }
 335
 336         /** Get port number
 337          */
 338         int GetPort()
 339         {
 340                 return port;
 341         }
 342
 343         /** Set port number
 344          */
 345         void SetPort(int p)
 346         {
 347                 port = p;
 348         }
 349
 350         /** Returns the ping frequency
 351          */
 352         unsigned int GetPingTime()
 353         {
 354                 return (pingtime ? pingtime : 120);
 355         }
 356
 357         /** Returns the password or an empty string
 358          */
 359         const std::string& GetPass()
 360         {
 361                 return pass;
 362         }
 363
 364         /** Returns the hash or an empty string
 365          */
 366         const std::string& GetHash()
 367         {
 368                 return hash;
 369         }
 370
 371         /** Returns the flood threshold value
 372          */
 373         unsigned int GetThreshold()
 374         {
 375                 return (threshold ? threshold : 1);
 376         }
 377
 378         /** Returns the maximum sendq value
 379          */
 380         unsigned long GetSendqMax()
 381         {
 382                 return (sendqmax ? sendqmax : 262114);
 383         }
 384
 385         /** Returns the maximum recvq value
 386          */
 387         unsigned long GetRecvqMax()
 388         {
 389                 return (recvqmax ? recvqmax : 4096);
 390         }
 391
 392         /** Returusn the maximum number of local sessions
 393          */
 394         unsigned long GetMaxLocal()
 395         {
 396                 return maxlocal;
 397         }
 398
 399         /** Returns the maximum number of global sessions
 400          */
 401         unsigned long GetMaxGlobal()
 402         {
 403                 return maxglobal;
 404         }
 405 };
 406
 407 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
 408  */
 409 typedef std::vector<irc::string> InvitedList;
 410
 411 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
 412  */
 413 typedef std::vector<ConnectClass*> ClassVector;
 414
 415 /** Typedef for the list of user-channel records for a user
 416  */
 417 typedef std::map<Channel*, char> UserChanList;
 418
 419 /** Shorthand for an iterator into a UserChanList
 420  */
 421 typedef UserChanList::iterator UCListIter;
 422
 423 /* Required forward declaration
 424  */
 425 class User;
 426
 427 /** Visibility data for a user.
 428  * If a user has a non-null instance of this class in their User,
 429  * then it is used to determine if this user is visible to other users
 430  * or not.
 431  */
 432 class CoreExport VisData
 433 {
 434  public:
 435         /** Create a visdata
 436          */
 437         VisData();
 438         /** Destroy a visdata
 439          */
 440         virtual ~VisData();
 441         /** Is this user visible to some other user?
 442          * @param user The other user to compare to
 443          * @return true True if the user is visible to the other user, false if not
 444          */
 445         virtual bool VisibleTo(User* user);
 446 };
 447
 448 /** Holds all information about a user
 449  * This class stores all information about a user connected to the irc server. Everything about a
 450  * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
 451  * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
 452  * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
 453  * file descriptor value.
 454  */
 455 class CoreExport User : public connection
 456 {
 457  private:
 458         /** Pointer to creator.
 459          * This is required to make use of core functions
 460          * from within the User class.
 461          */
 462         InspIRCd* ServerInstance;
 463
 464         /** A list of channels the user has a pending invite to.
 465          * Upon INVITE channels are added, and upon JOIN, the
 466          * channels are removed from this list.
 467          */
 468         InvitedList invites;
 469
 470         /** Number of channels this user is currently on
 471          */
 472         unsigned int ChannelCount;
 473
 474         /** Cached nick!ident@host value using the real hostname
 475          */
 476         char* cached_fullhost;
 477
 478         /** Cached nick!ident@ip value using the real IP address
 479          */
 480         char* cached_hostip;
 481
 482         /** Cached nick!ident@host value using the masked hostname
 483          */
 484         char* cached_makehost;
 485
 486         /** Cached nick!ident@realhost value using the real hostname
 487          */
 488         char* cached_fullrealhost;
 489
 490         /** When we erase the user (in the destructor),
 491          * we call this method to subtract one from all
 492          * mode characters this user is making use of.
 493          */
 494         void DecrementModes();
 495
 496         /** Max channels for this user
 497          */
 498         unsigned int MaxChans;
 499
 500         std::map<std::string, bool>* AllowedOperCommands;
 501
 502  public:
 503         /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
 504          * The pointer is guarenteed to *always* be valid. :)
 505          */
 506         ConnectClass *MyClass;
 507
 508         /** Resolvers for looking up this users IP address
 509          * This will occur if and when res_reverse completes.
 510          * When this class completes its lookup, User::dns_done
 511          * will be set from false to true.
 512          */
 513         UserResolver* res_forward;
 514
 515         /** Resolvers for looking up this users hostname
 516          * This is instantiated by User::StartDNSLookup(),
 517          * and on success, instantiates User::res_reverse.
 518          */
 519         UserResolver* res_reverse;
 520
 521         /** User visibility state, see definition of VisData.
 522          */
 523         VisData* Visibility;
 524
 525         /** Stored reverse lookup from res_forward
 526          */
 527         std::string stored_host;
 528
 529         /** Starts a DNS lookup of the user's IP.
 530          * This will cause two UserResolver classes to be instantiated.
 531          * When complete, these objects set User::dns_done to true.
 532          */
 533         void StartDNSLookup();
 534
 535         unsigned int GetMaxChans();
 536
 537         /** The users nickname.
 538          * An invalid nickname indicates an unregistered connection prior to the NICK command.
 539          * Use InspIRCd::IsNick() to validate nicknames.
 540          */
 541         char nick[NICKMAX];
 542
 543         /** The user's unique identifier.
 544          * This is the unique identifier which the user has across the network.
 545          */
 546         char uuid[UUID_LENGTH];
 547
 548         /** The users ident reply.
 549          * Two characters are added to the user-defined limit to compensate for the tilde etc.
 550          */
 551         char ident[IDENTMAX+2];
 552
 553         /** The host displayed to non-opers (used for cloaking etc).
 554          * This usually matches the value of User::host.
 555          */
 556         char dhost[65];
 557
 558         /** The users full name (GECOS).
 559          */
 560         char fullname[MAXGECOS+1];
 561
 562         /** The user's mode list.
 563          * This is NOT a null terminated string! In the 1.1 version of InspIRCd
 564          * this is an array of values in a similar way to channel modes.
 565          * A value of 1 in field (modeletter-65) indicates that the mode is
 566          * set, for example, to work out if mode +s is set, we  check the field
 567          * User::modes['s'-65] != 0.
 568          * The following RFC characters o, w, s, i have constants defined via an
 569          * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
 570          */
 571         char modes[64];
 572
 573         /** What snomasks are set on this user.
 574          * This functions the same as the above modes.
 575          */
 576         char snomasks[64];
 577
 578         /** Channels this user is on, and the permissions they have there
 579          */
 580         UserChanList chans;
 581
 582         /** The server the user is connected to.
 583          */
 584         const char* server;
 585
 586         /** The user's away message.
 587          * If this string is empty, the user is not marked as away.
 588          */
 589         char awaymsg[MAXAWAY+1];
 590
 591         /** Timestamp of current time + connection class timeout.
 592          * This user must send USER/NICK before this timestamp is
 593          * reached or they will be disconnected.
 594          */
 595         time_t timeout;
 596
 597         /** The oper type they logged in as, if they are an oper.
 598          * This is used to check permissions in operclasses, so that
 599          * we can say 'yay' or 'nay' to any commands they issue.
 600          * The value of this is the value of a valid 'type name=' tag.
 601          */
 602         char oper[NICKMAX];
 603
 604         /** True when DNS lookups are completed.
 605          * The UserResolver classes res_forward and res_reverse will
 606          * set this value once they complete.
 607          */
 608         bool dns_done;
 609
 610         /** Password specified by the user when they registered.
 611          * This is stored even if the <connect> block doesnt need a password, so that
 612          * modules may check it.
 613          */
 614         char password[64];
 615
 616         /** User's receive queue.
 617          * Lines from the IRCd awaiting processing are stored here.
 618          * Upgraded april 2005, old system a bit hairy.
 619          */
 620         std::string recvq;
 621
 622         /** User's send queue.
 623          * Lines waiting to be sent are stored here until their buffer is flushed.
 624          */
 625         std::string sendq;
 626
 627         /** Message user will quit with. Not to be set externally.
 628          */
 629         std::string quitmsg;
 630
 631         /** Quit message shown to opers - not to be set externally.
 632          */
 633         std::string operquitmsg;
 634
 635         /** Whether or not to send an snotice about this user's quitting
 636          */
 637         bool quietquit;
 638
 639         /** Flood counters - lines received
 640          */
 641         unsigned int lines_in;
 642
 643         /** Flood counters - time lines_in is due to be reset
 644          */
 645         time_t reset_due;
 646
 647         /** If this is set to true, then all socket operations for the user
 648          * are dropped into the bit-bucket.
 649          * This value is set by QuitUser, and is not needed seperately from that call.
 650          * Please note that setting this value alone will NOT cause the user to quit.
 651          */
 652         bool quitting;
 653
 654         /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
 655          * GetIPString/GetPort to obtain its values.
 656          */
 657         sockaddr* ip;
 658
 659         /** Initialize the clients sockaddr
 660          * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
 661          * @param ip A human-readable IP address for this user matching the protcol_family
 662          * @param port The port number of this user or zero for a remote user
 663          */
 664         void SetSockAddr(int protocol_family, const char* ip, int port);
 665
 666         /** Get port number from sockaddr
 667          * @return The port number of this user.
 668          */
 669         int GetPort();
 670
 671         /** Get protocol family from sockaddr
 672          * @return The protocol family of this user, either AF_INET or AF_INET6
 673          */
 674         int GetProtocolFamily();
 675
 676         /** Get IP string from sockaddr, using static internal buffer
 677          * @return The IP string
 678          */
 679         const char* GetIPString();
 680
 681         /* Write error string
 682          */
 683         std::string WriteError;
 684
 685         /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
 686          */
 687         bool exempt;
 688
 689         /** This value contains how far into the penalty threshold the user is. Once its over
 690          * the penalty threshold then commands are held and processed on-timer.
 691          */
 692         int Penalty;
 693
 694         /** True if we are flushing penalty lines
 695          */
 696         bool OverPenalty;
 697
 698         /** If this bool is set then penalty rules do not apply to this user
 699          */
 700         bool ExemptFromPenalty;
 701
 702         /** Default constructor
 703          * @throw CoreException if the UID allocated to the user already exists
 704          * @param Instance Creator instance
 705          * @param uid User UUID, or empty to allocate one automatically
 706          */
 707         User(InspIRCd* Instance, const std::string &uid = "");
 708
 709         /** Returns the full displayed host of the user
 710          * This member function returns the hostname of the user as seen by other users
 711          * on the server, in nick!ident&at;host form.
 712          * @return The full masked host of the user
 713          */
 714         virtual char* GetFullHost();
 715
 716         /** Returns the full real host of the user
 717          * This member function returns the hostname of the user as seen by other users
 718          * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
 719          * e.g. through a module, then this method will ignore it and return the true hostname.
 720          * @return The full real host of the user
 721          */
 722         virtual char* GetFullRealHost();
 723
 724         /** This clears any cached results that are used for GetFullRealHost() etc.
 725          * The results of these calls are cached as generating them can be generally expensive.
 726          */
 727         void InvalidateCache();
 728
 729         /** Create a displayable mode string for this users snomasks
 730          * @return The notice mask character sequence
 731          */
 732         const char* FormatNoticeMasks();
 733
 734         /** Process a snomask modifier string, e.g. +abc-de
 735          * @param sm A sequence of notice mask characters
 736          * @return The cleaned mode sequence which can be output,
 737          * e.g. in the above example if masks c and e are not
 738          * valid, this function will return +ab-d
 739          */
 740         std::string ProcessNoticeMasks(const char *sm);
 741
 742         /** Returns true if a notice mask is set
 743          * @param sm A notice mask character to check
 744          * @return True if the notice mask is set
 745          */
 746         bool IsNoticeMaskSet(unsigned char sm);
 747
 748         /** Changed a specific notice mask value
 749          * @param sm The server notice mask to change
 750          * @param value An on/off value for this mask
 751          */
 752         void SetNoticeMask(unsigned char sm, bool value);
 753
 754         /** Create a displayable mode string for this users umodes
 755          * @param The mode string
 756          */
 757         const char* FormatModes();
 758
 759         /** Returns true if a specific mode is set
 760          * @param m The user mode
 761          * @return True if the mode is set
 762          */
 763         bool IsModeSet(unsigned char m);
 764
 765         /** Set a specific usermode to on or off
 766          * @param m The user mode
 767          * @param value On or off setting of the mode
 768          */
 769         void SetMode(unsigned char m, bool value);
 770
 771         /** Returns true if a user is invited to a channel.
 772          * @param channel A channel name to look up
 773          * @return True if the user is invited to the given channel
 774          */
 775         virtual bool IsInvited(const irc::string &channel);
 776
 777         /** Adds a channel to a users invite list (invites them to a channel)
 778          * @param channel A channel name to add
 779          */
 780         virtual void InviteTo(const irc::string &channel);
 781
 782         /** Removes a channel from a users invite list.
 783          * This member function is called on successfully joining an invite only channel
 784          * to which the user has previously been invited, to clear the invitation.
 785          * @param channel The channel to remove the invite to
 786          */
 787         virtual void RemoveInvite(const irc::string &channel);
 788
 789         /** Returns true or false for if a user can execute a privilaged oper command.
 790          * This is done by looking up their oper type from User::oper, then referencing
 791          * this to their oper classes and checking the commands they can execute.
 792          * @param command A command (should be all CAPS)
 793          * @return True if this user can execute the command
 794          */
 795         bool HasPermission(const std::string &command);
 796
 797         /** Calls read() to read some data for this user using their fd.
 798          * @param buffer The buffer to read into
 799          * @param size The size of data to read
 800          * @return The number of bytes read, or -1 if an error occured.
 801          */
 802         int ReadData(void* buffer, size_t size);
 803
 804         /** This method adds data to the read buffer of the user.
 805          * The buffer can grow to any size within limits of the available memory,
 806          * managed by the size of a std::string, however if any individual line in
 807          * the buffer grows over 600 bytes in length (which is 88 chars over the
 808          * RFC-specified limit per line) then the method will return false and the
 809          * text will not be inserted.
 810          * @param a The string to add to the users read buffer
 811          * @return True if the string was successfully added to the read buffer
 812          */
 813         bool AddBuffer(std::string a);
 814
 815         /** This method returns true if the buffer contains at least one carriage return
 816          * character (e.g. one complete line may be read)
 817          * @return True if there is at least one complete line in the users buffer
 818          */
 819         bool BufferIsReady();
 820
 821         /** This function clears the entire buffer by setting it to an empty string.
 822          */
 823         void ClearBuffer();
 824
 825         /** This method returns the first available string at the tail end of the buffer
 826          * and advances the tail end of the buffer past the string. This means it is
 827          * a one way operation in a similar way to strtok(), and multiple calls return
 828          * multiple lines if they are available. The results of this function if there
 829          * are no lines to be read are unknown, always use BufferIsReady() to check if
 830          * it is ok to read the buffer before calling GetBuffer().
 831          * @return The string at the tail end of this users buffer
 832          */
 833         std::string GetBuffer();
 834
 835         /** Sets the write error for a connection. This is done because the actual disconnect
 836          * of a client may occur at an inopportune time such as half way through /LIST output.
 837          * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
 838          * errored clients purged.
 839          * @param error The error string to set.
 840          */
 841         void SetWriteError(const std::string &error);
 842
 843         /** Returns the write error which last occured on this connection or an empty string
 844          * if none occured.
 845          * @return The error string which has occured for this user
 846          */
 847         const char* GetWriteError();
 848
 849         /** Adds to the user's write buffer.
 850          * You may add any amount of text up to this users sendq value, if you exceed the
 851          * sendq value, SetWriteError() will be called to set the users error string to
 852          * "SendQ exceeded", and further buffer adds will be dropped.
 853          * @param data The data to add to the write buffer
 854          */
 855         void AddWriteBuf(const std::string &data);
 856
 857         /** Flushes as much of the user's buffer to the file descriptor as possible.
 858          * This function may not always flush the entire buffer, rather instead as much of it
 859          * as it possibly can. If the send() call fails to send the entire buffer, the buffer
 860          * position is advanced forwards and the rest of the data sent at the next call to
 861          * this method.
 862          */
 863         void FlushWriteBuf();
 864
 865         /** Returns the list of channels this user has been invited to but has not yet joined.
 866          * @return A list of channels the user is invited to
 867          */
 868         InvitedList* GetInviteList();
 869
 870         /** Creates a wildcard host.
 871          * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
 872          * @return The wildcarded hostname in *!*@host form
 873          */
 874         char* MakeWildHost();
 875
 876         /** Creates a usermask with real host.
 877          * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
 878          * @return the usermask in the format user@host
 879          */
 880         char* MakeHost();
 881
 882         /** Creates a usermask with real ip.
 883          * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
 884          * @return the usermask in the format user@ip
 885          */
 886         char* MakeHostIP();
 887
 888         /** Shuts down and closes the user's socket
 889          * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
 890          * which will call CloseSocket() for you.
 891          */
 892         void CloseSocket();
 893
 894         /** Disconnect a user gracefully
 895          * @param user The user to remove
 896          * @param r The quit reason to show to normal users
 897          * @param oreason The quit reason to show to opers
 898          * @return Although this function has no return type, on exit the user provided will no longer exist.
 899          */
 900         static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = "");
 901
 902         /** Add the user to WHOWAS system
 903          */
 904         void AddToWhoWas();
 905
 906         /** Oper up the user using the given opertype.
 907          * This will also give the +o usermode.
 908          * @param opertype The oper type to oper as
 909          */
 910         void Oper(const std::string &opertype, const std::string &opername);
 911
 912         /** Call this method to find the matching <connect> for a user, and to check them against it.
 913          */
 914         void CheckClass();
 915
 916         /** Use this method to fully connect a user.
 917          * This will send the message of the day, check G/K/E lines, etc.
 918          */
 919         void FullConnect();
 920
 921         /** Change this users hash key to a new string.
 922          * You should not call this function directly. It is used by the core
 923          * to update the users hash entry on a nickchange.
 924          * @param New new user_hash key
 925          * @return Pointer to User in hash (usually 'this')
 926          */
 927         User* UpdateNickHash(const char* New);
 928
 929         /** Force a nickname change.
 930          * If the nickname change fails (for example, because the nick in question
 931          * already exists) this function will return false, and you must then either
 932          * output an error message, or quit the user for nickname collision.
 933          * @param newnick The nickname to change to
 934          * @return True if the nickchange was successful.
 935          */
 936         bool ForceNickChange(const char* newnick);
 937
 938         /** Oper down.
 939          * This will clear the +o usermode and unset the user's oper type
 940          */
 941         void UnOper();
 942
 943         /** Write text to this user, appending CR/LF.
 944          * @param text A std::string to send to the user
 945          */
 946         void Write(std::string text);
 947
 948         /** Write text to this user, appending CR/LF.
 949          * @param text The format string for text to send to the user
 950          * @param ... POD-type format arguments
 951          */
 952         void Write(const char *text, ...);
 953
 954         /** Write text to this user, appending CR/LF and prepending :server.name
 955          * @param text A std::string to send to the user
 956          */
 957         void WriteServ(const std::string& text);
 958
 959         /** Write text to this user, appending CR/LF and prepending :server.name
 960          * @param text The format string for text to send to the user
 961          * @param ... POD-type format arguments
 962          */
 963         void WriteServ(const char* text, ...);
 964
 965         /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
 966          * @param user The user to prepend the :nick!user@host of
 967          * @param text A std::string to send to the user
 968          */
 969         void WriteFrom(User *user, const std::string &text);
 970
 971         /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
 972          * @param user The user to prepend the :nick!user@host of
 973          * @param text The format string for text to send to the user
 974          * @param ... POD-type format arguments
 975          */
 976         void WriteFrom(User *user, const char* text, ...);
 977
 978         /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
 979          * @param dest The user to route the message to
 980          * @param text A std::string to send to the user
 981          */
 982         void WriteTo(User *dest, const std::string &data);
 983
 984         /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
 985          * @param dest The user to route the message to
 986          * @param text The format string for text to send to the user
 987          * @param ... POD-type format arguments
 988          */
 989         void WriteTo(User *dest, const char *data, ...);
 990
 991         /** Write to all users that can see this user (including this user in the list), appending CR/LF
 992          * @param text A std::string to send to the users
 993          */
 994         void WriteCommon(const std::string &text);
 995
 996         /** Write to all users that can see this user (including this user in the list), appending CR/LF
 997          * @param text The format string for text to send to the users
 998          * @param ... POD-type format arguments
 999          */
1000         void WriteCommon(const char* text, ...);
1001
1002         /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1003          * @param text The format string for text to send to the users
1004          * @param ... POD-type format arguments
1005          */
1006         void WriteCommonExcept(const char* text, ...);
1007
1008         /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1009          * @param text A std::string to send to the users
1010          */
1011         void WriteCommonExcept(const std::string &text);
1012
1013         /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
1014          * quit message for opers only.
1015          * @param normal_text Normal user quit message
1016          * @param oper_text Oper only quit message
1017          */
1018         void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
1019
1020         /** Write a WALLOPS message from this user to all local opers.
1021          * If this user is not opered, the function will return without doing anything.
1022          * @param text The format string to send in the WALLOPS message
1023          * @param ... Format arguments
1024          */
1025         void WriteWallOps(const char* text, ...);
1026
1027         /** Write a WALLOPS message from this user to all local opers.
1028          * If this user is not opered, the function will return without doing anything.
1029          * @param text The text to send in the WALLOPS message
1030          */
1031         void WriteWallOps(const std::string &text);
1032
1033         /** Return true if the user shares at least one channel with another user
1034          * @param other The other user to compare the channel list against
1035          * @return True if the given user shares at least one channel with this user
1036          */
1037         bool SharesChannelWith(User *other);
1038
1039         /** Change the displayed host of a user.
1040          * ALWAYS use this function, rather than writing User::dhost directly,
1041          * as this triggers module events allowing the change to be syncronized to
1042          * remote servers. This will also emulate a QUIT and rejoin (where configured)
1043          * before setting their host field.
1044          * @param host The new hostname to set
1045          * @return True if the change succeeded, false if it didn't
1046          */
1047         bool ChangeDisplayedHost(const char* host);
1048
1049         /** Change the ident (username) of a user.
1050          * ALWAYS use this function, rather than writing User::ident directly,
1051          * as this correctly causes the user to seem to quit (where configured)
1052          * before setting their ident field.
1053          * @param host The new ident to set
1054          * @return True if the change succeeded, false if it didn't
1055          */
1056         bool ChangeIdent(const char* newident);
1057
1058         /** Change a users realname field.
1059          * ALWAYS use this function, rather than writing User::fullname directly,
1060          * as this triggers module events allowing the change to be syncronized to
1061          * remote servers.
1062          * @param gecos The user's new realname
1063          * @return True if the change succeeded, false if otherwise
1064          */
1065         bool ChangeName(const char* gecos);
1066
1067         /** Send a command to all local users from this user
1068          * The command given must be able to send text with the
1069          * first parameter as a servermask (e.g. $*), so basically
1070          * you should use PRIVMSG or NOTICE.
1071          * @param command the command to send
1072          * @param text The text format string to send
1073          * @param ... Format arguments
1074          */
1075         void SendAll(const char* command, char* text, ...);
1076
1077         /** Compile a channel list for this user, and send it to the user 'source'
1078          * Used internally by WHOIS
1079          * @param The user to send the channel list to if it is not too long
1080          * @return This user's channel list
1081          */
1082         std::string ChannelList(User* source);
1083
1084         /** Split the channel list in cl which came from dest, and spool it to this user
1085          * Used internally by WHOIS
1086          * @param dest The user the original channel list came from
1087          * @param cl The  channel list as a string obtained from User::ChannelList()
1088          */
1089         void SplitChanList(User* dest, const std::string &cl);
1090
1091         /** Remove this user from all channels they are on, and delete any that are now empty.
1092          * This is used by QUIT, and will not send part messages!
1093          */
1094         void PurgeEmptyChannels();
1095
1096         /** Get the connect class which this user belongs to.
1097          * @return A pointer to this user's connect class
1098          */
1099         ConnectClass *GetClass();
1100
1101         /** Set the connect class to which this user belongs to.
1102          * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking <connect> tags from the configuration file.
1103          * @return A reference to this user's current connect class.
1104          */
1105         ConnectClass *SetClass(const std::string &explicit_name = "");
1106
1107         /** Show the message of the day to this user
1108          */
1109         void ShowMOTD();
1110
1111         /** Show the server RULES file to this user
1112          */
1113         void ShowRULES();
1114
1115         /** Set oper-specific quit message shown to opers only when the user quits
1116          * (overrides any sent by QuitUser)
1117          */
1118         void SetOperQuit(const std::string &oquit);
1119
1120         /** Get oper-specific quit message shown only to opers when the user quits.
1121          * (overrides any sent by QuitUser)
1122          */
1123         const char* GetOperQuit();
1124
1125         /** Increases a user's command penalty by a set amount.
1126          */
1127         void IncreasePenalty(int increase);
1128
1129         /** Decreases a user's command penalty by a set amount.
1130          */
1131         void DecreasePenalty(int decrease);
1132
1133         /** Handle socket event.
1134          * From EventHandler class.
1135          * @param et Event type
1136          * @param errornum Error number for EVENT_ERROR events
1137          */
1138         void HandleEvent(EventType et, int errornum = 0);
1139
1140         /** Default destructor
1141          */
1142         virtual ~User();
1143 };
1144
1145 /* Configuration callbacks */
1146 class ServerConfig;
1147
1148 #endif
1149