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