include/users.h

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