include/users.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   7  *   Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2007 Burlex <???@???>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 #pragma once
  26
  27 #include "socket.h"
  28 #include "inspsocket.h"
  29 #include "mode.h"
  30 #include "membership.h"
  31
  32 /** connect class types
  33  */
  34 enum ClassTypes {
  35         /** connect:allow */
  36         CC_ALLOW = 0,
  37         /** connect:deny */
  38         CC_DENY  = 1,
  39         /** named connect block (for opers, etc) */
  40         CC_NAMED = 2
  41 };
  42
  43 /** Registration state of a user, e.g.
  44  * have they sent USER, NICK, PASS yet?
  45  */
  46 enum RegistrationState {
  47
  48 #ifndef _WIN32   // Burlex: This is already defined in win32, luckily it is still 0.
  49         REG_NONE = 0,           /* Has sent nothing */
  50 #endif
  51
  52         REG_USER = 1,           /* Has sent USER */
  53         REG_NICK = 2,           /* Has sent NICK */
  54         REG_NICKUSER = 3,       /* Bitwise combination of REG_NICK and REG_USER */
  55         REG_ALL = 7             /* REG_NICKUSER plus next bit along */
  56 };
  57
  58 enum UserType {
  59         USERTYPE_LOCAL = 1,
  60         USERTYPE_REMOTE = 2,
  61         USERTYPE_SERVER = 3
  62 };
  63
  64 /** Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
  65  */
  66 struct CoreExport ConnectClass : public refcountbase
  67 {
  68         reference<ConfigTag> config;
  69         /** Type of line, either CC_ALLOW or CC_DENY
  70          */
  71         char type;
  72
  73         /** True if this class uses fake lag to manage flood, false if it kills */
  74         bool fakelag;
  75
  76         /** Connect class name
  77          */
  78         std::string name;
  79
  80         /** Max time to register the connection in seconds
  81          */
  82         unsigned int registration_timeout;
  83
  84         /** Host mask for this line
  85          */
  86         std::string host;
  87
  88         /** Number of seconds between pings for this line
  89          */
  90         unsigned int pingtime;
  91
  92         /** Maximum size of sendq for users in this class (bytes)
  93          * Users cannot send commands if they go over this limit
  94          */
  95         unsigned long softsendqmax;
  96
  97         /** Maximum size of sendq for users in this class (bytes)
  98          * Users are killed if they go over this limit
  99          */
 100         unsigned long hardsendqmax;
 101
 102         /** Maximum size of recvq for users in this class (bytes)
 103          */
 104         unsigned long recvqmax;
 105
 106         /** Seconds worth of penalty before penalty system activates
 107          */
 108         unsigned int penaltythreshold;
 109
 110         /** Maximum rate of commands (units: millicommands per second) */
 111         unsigned int commandrate;
 112
 113         /** Local max when connecting by this connection class
 114          */
 115         unsigned long maxlocal;
 116
 117         /** Global max when connecting by this connection class
 118          */
 119         unsigned long maxglobal;
 120
 121         /** True if max connections for this class is hit and a warning is wanted
 122          */
 123         bool maxconnwarn;
 124
 125         /** Max channels for this class
 126          */
 127         unsigned int maxchans;
 128
 129         /** How many users may be in this connect class before they are refused?
 130          * (0 = no limit = default)
 131          */
 132         unsigned long limit;
 133
 134         /** If set to true, no user DNS lookups are to be performed
 135          */
 136         bool resolvehostnames;
 137
 138         /**
 139          * If non-empty the server ports which this user has to be using
 140          */
 141         insp::flat_set<int> ports;
 142
 143         /** Create a new connect class with no settings.
 144          */
 145         ConnectClass(ConfigTag* tag, char type, const std::string& mask);
 146         /** Create a new connect class with inherited settings.
 147          */
 148         ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
 149
 150         /** Update the settings in this block to match the given block */
 151         void Update(const ConnectClass* newSettings);
 152
 153         const std::string& GetName() { return name; }
 154         const std::string& GetHost() { return host; }
 155
 156         /** Returns the registration timeout
 157          */
 158         time_t GetRegTimeout()
 159         {
 160                 return (registration_timeout ? registration_timeout : 90);
 161         }
 162
 163         /** Returns the ping frequency
 164          */
 165         unsigned int GetPingTime()
 166         {
 167                 return (pingtime ? pingtime : 120);
 168         }
 169
 170         /** Returns the maximum sendq value (soft limit)
 171          * Note that this is in addition to internal OS buffers
 172          */
 173         unsigned long GetSendqSoftMax()
 174         {
 175                 return (softsendqmax ? softsendqmax : 4096);
 176         }
 177
 178         /** Returns the maximum sendq value (hard limit)
 179          */
 180         unsigned long GetSendqHardMax()
 181         {
 182                 return (hardsendqmax ? hardsendqmax : 0x100000);
 183         }
 184
 185         /** Returns the maximum recvq value
 186          */
 187         unsigned long GetRecvqMax()
 188         {
 189                 return (recvqmax ? recvqmax : 4096);
 190         }
 191
 192         /** Returns the penalty threshold value
 193          */
 194         unsigned int GetPenaltyThreshold()
 195         {
 196                 return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
 197         }
 198
 199         unsigned int GetCommandRate()
 200         {
 201                 return commandrate ? commandrate : 1000;
 202         }
 203
 204         /** Return the maximum number of local sessions
 205          */
 206         unsigned long GetMaxLocal()
 207         {
 208                 return maxlocal;
 209         }
 210
 211         /** Returns the maximum number of global sessions
 212          */
 213         unsigned long GetMaxGlobal()
 214         {
 215                 return maxglobal;
 216         }
 217 };
 218
 219 /** Holds all information about a user
 220  * This class stores all information about a user connected to the irc server. Everything about a
 221  * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
 222  * user's nickname and hostname.
 223  */
 224 class CoreExport User : public Extensible
 225 {
 226  private:
 227         /** Cached nick!ident@dhost value using the displayed hostname
 228          */
 229         std::string cached_fullhost;
 230
 231         /** Cached ident@ip value using the real IP address
 232          */
 233         std::string cached_hostip;
 234
 235         /** Cached ident@realhost value using the real hostname
 236          */
 237         std::string cached_makehost;
 238
 239         /** Cached nick!ident@realhost value using the real hostname
 240          */
 241         std::string cached_fullrealhost;
 242
 243         /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
 244          */
 245         std::string cachedip;
 246
 247         /** If set then the hostname which is displayed to users. */
 248         std::string displayhost;
 249
 250         /** The real hostname of this user. */
 251         std::string realhost;
 252
 253         /** The user's mode list.
 254          * Much love to the STL for giving us an easy to use bitset, saving us RAM.
 255          * if (modes[modeid]) is set, then the mode is set.
 256          * For example, to work out if mode +i is set, we check the field
 257          * User::modes[invisiblemode->modeid] == true.
 258          */
 259         std::bitset<ModeParser::MODEID_MAX> modes;
 260
 261  public:
 262         /** To execute a function for each local neighbor of a user, inherit from this class and
 263          * pass an instance of it to User::ForEachNeighbor().
 264          */
 265         class ForEachNeighborHandler
 266         {
 267          public:
 268                 /** Method to execute for each local neighbor of a user.
 269                  * Derived classes must implement this.
 270                  * @param user Current neighbor
 271                  */
 272                 virtual void Execute(LocalUser* user) = 0;
 273         };
 274
 275         /** List of Memberships for this user
 276          */
 277         typedef insp::intrusive_list<Membership> ChanList;
 278
 279         /** Time that the object was instantiated (used for TS calculation etc)
 280         */
 281         time_t age;
 282
 283         /** Time the connection was created, set in the constructor. This
 284          * may be different from the time the user's classbase object was
 285          * created.
 286          */
 287         time_t signon;
 288
 289         /** Client address that the user is connected from.
 290          * Do not modify this value directly, use SetClientIP() to change it.
 291          * Port is not valid for remote users.
 292          */
 293         irc::sockets::sockaddrs client_sa;
 294
 295         /** The users nickname.
 296          * An invalid nickname indicates an unregistered connection prior to the NICK command.
 297          * Use InspIRCd::IsNick() to validate nicknames.
 298          */
 299         std::string nick;
 300
 301         /** The user's unique identifier.
 302          * This is the unique identifier which the user has across the network.
 303          */
 304         const std::string uuid;
 305
 306         /** The users ident reply.
 307          * Two characters are added to the user-defined limit to compensate for the tilde etc.
 308          */
 309         std::string ident;
 310
 311         /** The users full name (GECOS).
 312          */
 313         std::string fullname;
 314
 315         /** What snomasks are set on this user.
 316          * This functions the same as the above modes.
 317          */
 318         std::bitset<64> snomasks;
 319
 320         /** Channels this user is on
 321          */
 322         ChanList chans;
 323
 324         /** The server the user is connected to.
 325          */
 326         Server* server;
 327
 328         /** The user's away message.
 329          * If this string is empty, the user is not marked as away.
 330          */
 331         std::string awaymsg;
 332
 333         /** Time the user last went away.
 334          * This is ONLY RELIABLE if user IsAway()!
 335          */
 336         time_t awaytime;
 337
 338         /** The oper type they logged in as, if they are an oper.
 339          */
 340         reference<OperInfo> oper;
 341
 342         /** Used by User to indicate the registration status of the connection
 343          * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
 344          * the connection state.
 345          */
 346         unsigned int registered:3;
 347
 348         /** If this is set to true, then all socket operations for the user
 349          * are dropped into the bit-bucket.
 350          * This value is set by QuitUser, and is not needed seperately from that call.
 351          * Please note that setting this value alone will NOT cause the user to quit.
 352          */
 353         unsigned int quitting:1;
 354
 355         /** What type of user is this? */
 356         const UserType usertype:2;
 357
 358         /** Get client IP string from sockaddr, using static internal buffer
 359          * @return The IP string
 360          */
 361         const std::string& GetIPString();
 362
 363         /** Retrieves this user's hostname.
 364          * @param uncloak If true then return the real host; otherwise, the display host.
 365          */
 366         const std::string& GetHost(bool uncloak) const;
 367
 368         /** Retrieves this user's displayed hostname. */
 369         const std::string& GetDisplayedHost() const;
 370
 371         /** Retrieves this user's real hostname. */
 372         const std::string& GetRealHost() const;
 373
 374         /** Get CIDR mask, using default range, for this user
 375          */
 376         irc::sockets::cidr_mask GetCIDRMask();
 377
 378         /** Sets the client IP for this user
 379          * @return true if the conversion was successful
 380          */
 381         virtual bool SetClientIP(const std::string& address, bool recheck_eline = true);
 382
 383         virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
 384
 385         /** Constructor
 386          * @throw CoreException if the UID allocated to the user already exists
 387          */
 388         User(const std::string& uid, Server* srv, UserType objtype);
 389
 390         /** Returns the full displayed host of the user
 391          * This member function returns the hostname of the user as seen by other users
 392          * on the server, in nick!ident\@host form.
 393          * @return The full masked host of the user
 394          */
 395         virtual const std::string& GetFullHost();
 396
 397         /** Returns the full real host of the user
 398          * This member function returns the hostname of the user as seen by other users
 399          * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
 400          * e.g. through a module, then this method will ignore it and return the true hostname.
 401          * @return The full real host of the user
 402          */
 403         virtual const std::string& GetFullRealHost();
 404
 405         /** This clears any cached results that are used for GetFullRealHost() etc.
 406          * The results of these calls are cached as generating them can be generally expensive.
 407          */
 408         void InvalidateCache();
 409
 410         /** Returns whether this user is currently away or not. If true,
 411          * further information can be found in User::awaymsg and User::awaytime
 412          * @return True if the user is away, false otherwise
 413          */
 414         bool IsAway() const { return (!awaymsg.empty()); }
 415
 416         /** Returns whether this user is an oper or not. If true,
 417          * oper information can be obtained from User::oper
 418          * @return True if the user is an oper, false otherwise
 419          */
 420         bool IsOper() const { return oper; }
 421
 422         /** Returns true if a notice mask is set
 423          * @param sm A notice mask character to check
 424          * @return True if the notice mask is set
 425          */
 426         bool IsNoticeMaskSet(unsigned char sm);
 427
 428         /** Get the mode letters of modes set on the user as a string.
 429          * @param includeparams True to get the parameters of the modes as well. Defaults to false.
 430          * @return Mode letters of modes set on the user and optionally the parameters of those modes, if any.
 431          * The returned string always begins with a '+' character. If the user has no modes set, "+" is returned.
 432          */
 433         std::string GetModeLetters(bool includeparams = false) const;
 434
 435         /** Returns true if a specific mode is set
 436          * @param m The user mode
 437          * @return True if the mode is set
 438          */
 439         bool IsModeSet(unsigned char m) const;
 440         bool IsModeSet(const ModeHandler* mh) const;
 441         bool IsModeSet(const ModeHandler& mh) const { return IsModeSet(&mh); }
 442         bool IsModeSet(UserModeReference& moderef) const;
 443
 444         /** Set a specific usermode to on or off
 445          * @param mh The user mode
 446          * @param value On or off setting of the mode
 447          */
 448         void SetMode(ModeHandler* mh, bool value);
 449         void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); }
 450
 451         /** Returns true or false for if a user can execute a privilaged oper command.
 452          * This is done by looking up their oper type from User::oper, then referencing
 453          * this to their oper classes and checking the commands they can execute.
 454          * @param command A command (should be all CAPS)
 455          * @return True if this user can execute the command
 456          */
 457         virtual bool HasPermission(const std::string &command);
 458
 459         /** Returns true if a user has a given permission.
 460          * This is used to check whether or not users may perform certain actions which admins may not wish to give to
 461          * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
 462          *
 463          * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
 464          * @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent.
 465          * @return True if this user has the permission in question.
 466          */
 467         virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
 468
 469         /** Returns true or false if a user can set a privileged user or channel mode.
 470          * This is done by looking up their oper type from User::oper, then referencing
 471          * this to their oper classes, and checking the modes they can set.
 472          * @param mh Mode to check
 473          * @return True if the user can set or unset this mode.
 474          */
 475         virtual bool HasModePermission(const ModeHandler* mh) const;
 476
 477         /** Creates a usermask with real host.
 478          * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
 479          * @return the usermask in the format user\@host
 480          */
 481         const std::string& MakeHost();
 482
 483         /** Creates a usermask with real ip.
 484          * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
 485          * @return the usermask in the format user\@ip
 486          */
 487         const std::string& MakeHostIP();
 488
 489         /** Oper up the user using the given opertype.
 490          * This will also give the +o usermode.
 491          */
 492         void Oper(OperInfo* info);
 493
 494         /** Oper down.
 495          * This will clear the +o usermode and unset the user's oper type
 496          */
 497         void UnOper();
 498
 499         /** Write text to this user, appending CR/LF. Works on local users only.
 500          * @param text A std::string to send to the user
 501          */
 502         virtual void Write(const std::string &text);
 503
 504         /** Write text to this user, appending CR/LF.
 505          * Works on local users only.
 506          * @param text The format string for text to send to the user
 507          * @param ... POD-type format arguments
 508          */
 509         virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
 510
 511         /** Write text to this user, appending CR/LF and prepending :server.name
 512          * Works on local users only.
 513          * @param text A std::string to send to the user
 514          */
 515         void WriteServ(const std::string& text);
 516
 517         /** Write text to this user, appending CR/LF and prepending :server.name
 518          * Works on local users only.
 519          * @param text The format string for text to send to the user
 520          * @param ... POD-type format arguments
 521          */
 522         void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
 523
 524         /** Sends a command to this user.
 525          * @param command The command to be sent.
 526          * @param text The message to send.
 527          */
 528         void WriteCommand(const char* command, const std::string& text);
 529
 530         /** Sends a server notice to this user.
 531          * @param text The contents of the message to send.
 532          */
 533         void WriteNotice(const std::string& text) { this->WriteCommand("NOTICE", ":" + text); }
 534
 535         /** Send a NOTICE message from the local server to the user.
 536          * @param text Text to send
 537          */
 538         virtual void WriteRemoteNotice(const std::string& text);
 539
 540         virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric);
 541
 542         template <typename T1>
 543         void WriteRemoteNumeric(unsigned int numeric, T1 p1)
 544         {
 545                 Numeric::Numeric n(numeric);
 546                 n.push(p1);
 547                 WriteRemoteNumeric(n);
 548         }
 549
 550         template <typename T1, typename T2>
 551         void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2)
 552         {
 553                 Numeric::Numeric n(numeric);
 554                 n.push(p1);
 555                 n.push(p2);
 556                 WriteRemoteNumeric(n);
 557         }
 558
 559         template <typename T1, typename T2, typename T3>
 560         void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
 561         {
 562                 Numeric::Numeric n(numeric);
 563                 n.push(p1);
 564                 n.push(p2);
 565                 n.push(p3);
 566                 WriteRemoteNumeric(n);
 567         }
 568
 569         template <typename T1, typename T2, typename T3, typename T4>
 570         void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
 571         {
 572                 Numeric::Numeric n(numeric);
 573                 n.push(p1);
 574                 n.push(p2);
 575                 n.push(p3);
 576                 n.push(p4);
 577                 WriteRemoteNumeric(n);
 578         }
 579
 580         template <typename T1, typename T2, typename T3, typename T4, typename T5>
 581         void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
 582         {
 583                 Numeric::Numeric n(numeric);
 584                 n.push(p1);
 585                 n.push(p2);
 586                 n.push(p3);
 587                 n.push(p4);
 588                 n.push(p5);
 589                 WriteRemoteNumeric(n);
 590         }
 591
 592         void WriteNumeric(const Numeric::Numeric& numeric);
 593
 594         template <typename T1>
 595         void WriteNumeric(unsigned int numeric, T1 p1)
 596         {
 597                 Numeric::Numeric n(numeric);
 598                 n.push(p1);
 599                 WriteNumeric(n);
 600         }
 601
 602         template <typename T1, typename T2>
 603         void WriteNumeric(unsigned int numeric, T1 p1, T2 p2)
 604         {
 605                 Numeric::Numeric n(numeric);
 606                 n.push(p1);
 607                 n.push(p2);
 608                 WriteNumeric(n);
 609         }
 610
 611         template <typename T1, typename T2, typename T3>
 612         void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
 613         {
 614                 Numeric::Numeric n(numeric);
 615                 n.push(p1);
 616                 n.push(p2);
 617                 n.push(p3);
 618                 WriteNumeric(n);
 619         }
 620
 621         template <typename T1, typename T2, typename T3, typename T4>
 622         void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
 623         {
 624                 Numeric::Numeric n(numeric);
 625                 n.push(p1);
 626                 n.push(p2);
 627                 n.push(p3);
 628                 n.push(p4);
 629                 WriteNumeric(n);
 630         }
 631
 632         template <typename T1, typename T2, typename T3, typename T4, typename T5>
 633         void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
 634         {
 635                 Numeric::Numeric n(numeric);
 636                 n.push(p1);
 637                 n.push(p2);
 638                 n.push(p3);
 639                 n.push(p4);
 640                 n.push(p5);
 641                 WriteNumeric(n);
 642         }
 643
 644         /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
 645          * @param user The user to prepend the :nick!user\@host of
 646          * @param text A std::string to send to the user
 647          */
 648         void WriteFrom(User *user, const std::string &text);
 649
 650         /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
 651          * @param user The user to prepend the :nick!user\@host of
 652          * @param text The format string for text to send to the user
 653          * @param ... POD-type format arguments
 654          */
 655         void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
 656
 657         /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
 658          * @param line A std::string to send to the users
 659          * @param include_self Should the message be sent back to the author?
 660          */
 661         void WriteCommonRaw(const std::string &line, bool include_self = true);
 662
 663         /** Write to all users that can see this user (including this user in the list), appending CR/LF
 664          * @param text The format string for text to send to the users
 665          * @param ... POD-type format arguments
 666          */
 667         void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
 668
 669         /** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users
 670          * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely.
 671          * This function is used for example to send something conditionally to neighbors, or to send different messages
 672          * to different users depending on their oper status.
 673          * @param handler Function object to call, inherited from ForEachNeighborHandler.
 674          * @param include_self True to include this user in the set of neighbors, false otherwise.
 675          * Modules may override this. Has no effect if this user is not local.
 676          */
 677         void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true);
 678
 679         /** Return true if the user shares at least one channel with another user
 680          * @param other The other user to compare the channel list against
 681          * @return True if the given user shares at least one channel with this user
 682          */
 683         bool SharesChannelWith(User *other);
 684
 685         /** Change the displayed hostname of this user.
 686          * @param host The new displayed hostname of this user.
 687          * @return True if the hostname was changed successfully; otherwise, false.
 688          */
 689         bool ChangeDisplayedHost(const std::string& host);
 690
 691         /** Change the real hostname of this user.
 692          * @param host The new real hostname of this user.
 693          * @param resetdisplay Whether to reset the display host to this value.
 694          */
 695         void ChangeRealHost(const std::string& host, bool resetdisplay);
 696
 697         /** Change the ident (username) of a user.
 698          * ALWAYS use this function, rather than writing User::ident directly,
 699          * as this triggers module events allowing the change to be syncronized to
 700          * remote servers.
 701          * @param newident The new ident to set
 702          * @return True if the change succeeded, false if it didn't
 703          */
 704         bool ChangeIdent(const std::string& newident);
 705
 706         /** Change a users realname field.
 707          * ALWAYS use this function, rather than writing User::fullname directly,
 708          * as this triggers module events allowing the change to be syncronized to
 709          * remote servers.
 710          * @param gecos The user's new realname
 711          * @return True if the change succeeded, false if otherwise
 712          */
 713         bool ChangeName(const std::string& gecos);
 714
 715         /** Change a user's nick
 716          * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
 717          * @param newts The time at which this nick change happened.
 718          * @return True if the change succeeded
 719          */
 720         bool ChangeNick(const std::string& newnick, time_t newts = 0);
 721
 722         /** Remove this user from all channels they are on, and delete any that are now empty.
 723          * This is used by QUIT, and will not send part messages!
 724          */
 725         void PurgeEmptyChannels();
 726
 727         /** Default destructor
 728          */
 729         virtual ~User();
 730         virtual CullResult cull() CXX11_OVERRIDE;
 731 };
 732
 733 class CoreExport UserIOHandler : public StreamSocket
 734 {
 735  public:
 736         LocalUser* const user;
 737         UserIOHandler(LocalUser* me) : user(me) {}
 738         void OnDataReady();
 739         void OnError(BufferedSocketError error);
 740
 741         /** Adds to the user's write buffer.
 742          * You may add any amount of text up to this users sendq value, if you exceed the
 743          * sendq value, the user will be removed, and further buffer adds will be dropped.
 744          * @param data The data to add to the write buffer
 745          */
 746         void AddWriteBuf(const std::string &data);
 747 };
 748
 749 typedef unsigned int already_sent_t;
 750
 751 class CoreExport LocalUser : public User, public insp::intrusive_list_node<LocalUser>
 752 {
 753  public:
 754         LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 755         CullResult cull() CXX11_OVERRIDE;
 756
 757         UserIOHandler eh;
 758
 759         /** Stats counter for bytes inbound
 760          */
 761         unsigned int bytes_in;
 762
 763         /** Stats counter for bytes outbound
 764          */
 765         unsigned int bytes_out;
 766
 767         /** Stats counter for commands inbound
 768          */
 769         unsigned int cmds_in;
 770
 771         /** Stats counter for commands outbound
 772          */
 773         unsigned int cmds_out;
 774
 775         /** Password specified by the user when they registered (if any).
 776          * This is stored even if the \<connect> block doesnt need a password, so that
 777          * modules may check it.
 778          */
 779         std::string password;
 780
 781         /** Contains a pointer to the connect class a user is on from
 782          */
 783         reference<ConnectClass> MyClass;
 784
 785         /** Get the connect class which this user belongs to.
 786          * @return A pointer to this user's connect class.
 787          */
 788         ConnectClass* GetClass() const { return MyClass; }
 789
 790         /** Call this method to find the matching \<connect> for a user, and to check them against it.
 791          */
 792         void CheckClass(bool clone_count = true);
 793
 794         /** Server address and port that this user is connected to.
 795          */
 796         irc::sockets::sockaddrs server_sa;
 797
 798         /**
 799          * @return The port number of this user.
 800          */
 801         int GetServerPort();
 802
 803         /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
 804          * This can't be handled normally because QuitUser itself calls Write on other
 805          * users, which could trigger their SendQ to overrun.
 806          */
 807         unsigned int quitting_sendq:1;
 808
 809         /** has the user responded to their previous ping?
 810          */
 811         unsigned int lastping:1;
 812
 813         /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
 814          */
 815         unsigned int exempt:1;
 816
 817         /** Used by PING checking code
 818          */
 819         time_t nping;
 820
 821         /** Time that the connection last sent a message, used to calculate idle time
 822          */
 823         time_t idle_lastmsg;
 824
 825         /** This value contains how far into the penalty threshold the user is.
 826          * This is used either to enable fake lag or for excess flood quits
 827          */
 828         unsigned int CommandFloodPenalty;
 829
 830         already_sent_t already_sent;
 831
 832         /** Check if the user matches a G or K line, and disconnect them if they do.
 833          * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
 834          * Returns true if the user matched a ban, false else.
 835          */
 836         bool CheckLines(bool doZline = false);
 837
 838         /** Use this method to fully connect a user.
 839          * This will send the message of the day, check G/K/E lines, etc.
 840          */
 841         void FullConnect();
 842
 843         /** Set the connect class to which this user belongs to.
 844          * @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.
 845          * @return A reference to this user's current connect class.
 846          */
 847         void SetClass(const std::string &explicit_name = "");
 848
 849         bool SetClientIP(const std::string& address, bool recheck_eline = true) CXX11_OVERRIDE;
 850
 851         void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true) CXX11_OVERRIDE;
 852
 853         void Write(const std::string& text) CXX11_OVERRIDE;
 854         void Write(const char*, ...) CXX11_OVERRIDE CUSTOM_PRINTF(2, 3);
 855
 856         /** Send a NOTICE message from the local server to the user.
 857          * The message will be sent even if the user is connected to a remote server.
 858          * @param text Text to send
 859          */
 860         void WriteRemoteNotice(const std::string& text) CXX11_OVERRIDE;
 861
 862         /** Returns true or false for if a user can execute a privilaged oper command.
 863          * This is done by looking up their oper type from User::oper, then referencing
 864          * this to their oper classes and checking the commands they can execute.
 865          * @param command A command (should be all CAPS)
 866          * @return True if this user can execute the command
 867          */
 868         bool HasPermission(const std::string &command) CXX11_OVERRIDE;
 869
 870         /** Returns true if a user has a given permission.
 871          * This is used to check whether or not users may perform certain actions which admins may not wish to give to
 872          * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
 873          *
 874          * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
 875          * @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent.
 876          * @return True if this user has the permission in question.
 877          */
 878         bool HasPrivPermission(const std::string &privstr, bool noisy = false) CXX11_OVERRIDE;
 879
 880         /** Returns true or false if a user can set a privileged user or channel mode.
 881          * This is done by looking up their oper type from User::oper, then referencing
 882          * this to their oper classes, and checking the modes they can set.
 883          * @param mh Mode to check
 884          * @return True if the user can set or unset this mode.
 885          */
 886         bool HasModePermission(const ModeHandler* mh) const CXX11_OVERRIDE;
 887
 888         /** Change nick to uuid, unset REG_NICK and send a nickname overruled numeric.
 889          * This is called when another user (either local or remote) needs the nick of this user and this user
 890          * isn't registered.
 891          */
 892         void OverruleNick();
 893 };
 894
 895 class RemoteUser : public User
 896 {
 897  public:
 898         RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE)
 899         {
 900         }
 901 };
 902
 903 class CoreExport FakeUser : public User
 904 {
 905  public:
 906         FakeUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_SERVER)
 907         {
 908                 nick = srv->GetName();
 909         }
 910
 911         FakeUser(const std::string& uid, const std::string& sname, const std::string& sdesc)
 912                 : User(uid, new Server(sname, sdesc), USERTYPE_SERVER)
 913         {
 914                 nick = sname;
 915         }
 916
 917         virtual CullResult cull() CXX11_OVERRIDE;
 918         virtual const std::string& GetFullHost() CXX11_OVERRIDE;
 919         virtual const std::string& GetFullRealHost() CXX11_OVERRIDE;
 920 };
 921
 922 /* Faster than dynamic_cast */
 923 /** Is a local user */
 924 inline LocalUser* IS_LOCAL(User* u)
 925 {
 926         return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
 927 }
 928 /** Is a remote user */
 929 inline RemoteUser* IS_REMOTE(User* u)
 930 {
 931         return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
 932 }
 933 /** Is a server fakeuser */
 934 inline FakeUser* IS_SERVER(User* u)
 935 {
 936         return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
 937 }
 938
 939 inline bool User::IsModeSet(const ModeHandler* mh) const
 940 {
 941         return (modes[mh->GetId()]);
 942 }
 943
 944 inline bool User::IsModeSet(UserModeReference& moderef) const
 945 {
 946         if (!moderef)
 947                 return false;
 948         return IsModeSet(*moderef);
 949 }
 950
 951 inline void User::SetMode(ModeHandler* mh, bool value)
 952 {
 953         modes[mh->GetId()] = value;
 954 }