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 #ifndef USERS_H
  26 #define USERS_H
  27
  28 #include "socket.h"
  29 #include "inspsocket.h"
  30 #include "dns.h"
  31 #include "mode.h"
  32 #include "membership.h"
  33
  34 /** connect class types
  35  */
  36 enum ClassTypes {
  37         /** connect:allow */
  38         CC_ALLOW = 0,
  39         /** connect:deny */
  40         CC_DENY  = 1,
  41         /** named connect block (for opers, etc) */
  42         CC_NAMED = 2
  43 };
  44
  45 /** RFC1459 channel modes
  46  */
  47 enum UserModes {
  48         /** +s: Server notice mask */
  49         UM_SNOMASK = 's' - 65,
  50         /** +w: WALLOPS */
  51         UM_WALLOPS = 'w' - 65,
  52         /** +i: Invisible */
  53         UM_INVISIBLE = 'i' - 65,
  54         /** +o: Operator */
  55         UM_OPERATOR = 'o' - 65
  56 };
  57
  58 /** Registration state of a user, e.g.
  59  * have they sent USER, NICK, PASS yet?
  60  */
  61 enum RegistrationState {
  62
  63 #ifndef _WIN32   // Burlex: This is already defined in win32, luckily it is still 0.
  64         REG_NONE = 0,           /* Has sent nothing */
  65 #endif
  66
  67         REG_USER = 1,           /* Has sent USER */
  68         REG_NICK = 2,           /* Has sent NICK */
  69         REG_NICKUSER = 3,       /* Bitwise combination of REG_NICK and REG_USER */
  70         REG_ALL = 7             /* REG_NICKUSER plus next bit along */
  71 };
  72
  73 enum UserType {
  74         USERTYPE_LOCAL = 1,
  75         USERTYPE_REMOTE = 2,
  76         USERTYPE_SERVER = 3
  77 };
  78
  79 /** Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
  80  */
  81 struct CoreExport ConnectClass : public refcountbase
  82 {
  83         reference<ConfigTag> config;
  84         /** Type of line, either CC_ALLOW or CC_DENY
  85          */
  86         char type;
  87
  88         /** True if this class uses fake lag to manage flood, false if it kills */
  89         bool fakelag;
  90
  91         /** Connect class name
  92          */
  93         std::string name;
  94
  95         /** Max time to register the connection in seconds
  96          */
  97         unsigned int registration_timeout;
  98
  99         /** Host mask for this line
 100          */
 101         std::string host;
 102
 103         /** Number of seconds between pings for this line
 104          */
 105         unsigned int pingtime;
 106
 107         /** Maximum size of sendq for users in this class (bytes)
 108          * Users cannot send commands if they go over this limit
 109          */
 110         unsigned long softsendqmax;
 111
 112         /** Maximum size of sendq for users in this class (bytes)
 113          * Users are killed if they go over this limit
 114          */
 115         unsigned long hardsendqmax;
 116
 117         /** Maximum size of recvq for users in this class (bytes)
 118          */
 119         unsigned long recvqmax;
 120
 121         /** Seconds worth of penalty before penalty system activates
 122          */
 123         unsigned int penaltythreshold;
 124
 125         /** Maximum rate of commands (units: millicommands per second) */
 126         unsigned int commandrate;
 127
 128         /** Local max when connecting by this connection class
 129          */
 130         unsigned long maxlocal;
 131
 132         /** Global max when connecting by this connection class
 133          */
 134         unsigned long maxglobal;
 135
 136         /** True if max connections for this class is hit and a warning is wanted
 137          */
 138         bool maxconnwarn;
 139
 140         /** Max channels for this class
 141          */
 142         unsigned int maxchans;
 143
 144         /** How many users may be in this connect class before they are refused?
 145          * (0 = no limit = default)
 146          */
 147         unsigned long limit;
 148
 149         /** Create a new connect class with no settings.
 150          */
 151         ConnectClass(ConfigTag* tag, char type, const std::string& mask);
 152         /** Create a new connect class with inherited settings.
 153          */
 154         ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
 155
 156         /** Update the settings in this block to match the given block */
 157         void Update(const ConnectClass* newSettings);
 158
 159         const std::string& GetName() { return name; }
 160         const std::string& GetHost() { return host; }
 161
 162         /** Returns the registration timeout
 163          */
 164         time_t GetRegTimeout()
 165         {
 166                 return (registration_timeout ? registration_timeout : 90);
 167         }
 168
 169         /** Returns the ping frequency
 170          */
 171         unsigned int GetPingTime()
 172         {
 173                 return (pingtime ? pingtime : 120);
 174         }
 175
 176         /** Returns the maximum sendq value (soft limit)
 177          * Note that this is in addition to internal OS buffers
 178          */
 179         unsigned long GetSendqSoftMax()
 180         {
 181                 return (softsendqmax ? softsendqmax : 4096);
 182         }
 183
 184         /** Returns the maximum sendq value (hard limit)
 185          */
 186         unsigned long GetSendqHardMax()
 187         {
 188                 return (hardsendqmax ? hardsendqmax : 0x100000);
 189         }
 190
 191         /** Returns the maximum recvq value
 192          */
 193         unsigned long GetRecvqMax()
 194         {
 195                 return (recvqmax ? recvqmax : 4096);
 196         }
 197
 198         /** Returns the penalty threshold value
 199          */
 200         unsigned int GetPenaltyThreshold()
 201         {
 202                 return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
 203         }
 204
 205         unsigned int GetCommandRate()
 206         {
 207                 return commandrate ? commandrate : 1000;
 208         }
 209
 210         /** Return the maximum number of local sessions
 211          */
 212         unsigned long GetMaxLocal()
 213         {
 214                 return maxlocal;
 215         }
 216
 217         /** Returns the maximum number of global sessions
 218          */
 219         unsigned long GetMaxGlobal()
 220         {
 221                 return maxglobal;
 222         }
 223 };
 224
 225 /** Holds all information about a user
 226  * This class stores all information about a user connected to the irc server. Everything about a
 227  * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
 228  * user's nickname and hostname.
 229  */
 230 class CoreExport User : public Extensible
 231 {
 232  private:
 233         /** Cached nick!ident@dhost value using the displayed hostname
 234          */
 235         std::string cached_fullhost;
 236
 237         /** Cached ident@ip value using the real IP address
 238          */
 239         std::string cached_hostip;
 240
 241         /** Cached ident@realhost value using the real hostname
 242          */
 243         std::string cached_makehost;
 244
 245         /** Cached nick!ident@realhost value using the real hostname
 246          */
 247         std::string cached_fullrealhost;
 248
 249         /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
 250          */
 251         std::string cachedip;
 252
 253  public:
 254
 255         /** Hostname of connection.
 256          * This should be valid as per RFC1035.
 257          */
 258         std::string host;
 259
 260         /** Time that the object was instantiated (used for TS calculation etc)
 261         */
 262         time_t age;
 263
 264         /** Time the connection was created, set in the constructor. This
 265          * may be different from the time the user's classbase object was
 266          * created.
 267          */
 268         time_t signon;
 269
 270         /** Time that the connection last sent a message, used to calculate idle time
 271          */
 272         time_t idle_lastmsg;
 273
 274         /** Client address that the user is connected from.
 275          * Do not modify this value directly, use SetClientIP() to change it.
 276          * Port is not valid for remote users.
 277          */
 278         irc::sockets::sockaddrs client_sa;
 279
 280         /** The users nickname.
 281          * An invalid nickname indicates an unregistered connection prior to the NICK command.
 282          * Use InspIRCd::IsNick() to validate nicknames.
 283          */
 284         std::string nick;
 285
 286         /** The user's unique identifier.
 287          * This is the unique identifier which the user has across the network.
 288          */
 289         const std::string uuid;
 290
 291         /** The users ident reply.
 292          * Two characters are added to the user-defined limit to compensate for the tilde etc.
 293          */
 294         std::string ident;
 295
 296         /** The host displayed to non-opers (used for cloaking etc).
 297          * This usually matches the value of User::host.
 298          */
 299         std::string dhost;
 300
 301         /** The users full name (GECOS).
 302          */
 303         std::string fullname;
 304
 305         /** The user's mode list.
 306          * NOT a null terminated string.
 307          * Also NOT an array.
 308          * Much love to the STL for giving us an easy to use bitset, saving us RAM.
 309          * if (modes[modeletter-65]) is set, then the mode is
 310          * set, for example, to work out if mode +s is set, we  check the field
 311          * User::modes['s'-65] != 0.
 312          * The following RFC characters o, w, s, i have constants defined via an
 313          * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
 314          */
 315         std::bitset<64> modes;
 316
 317         /** What snomasks are set on this user.
 318          * This functions the same as the above modes.
 319          */
 320         std::bitset<64> snomasks;
 321
 322         /** Channels this user is on
 323          */
 324         UserChanList chans;
 325
 326         /** The server the user is connected to.
 327          */
 328         const std::string server;
 329
 330         /** The user's away message.
 331          * If this string is empty, the user is not marked as away.
 332          */
 333         std::string awaymsg;
 334
 335         /** Time the user last went away.
 336          * This is ONLY RELIABLE if user IS_AWAY()!
 337          */
 338         time_t awaytime;
 339
 340         /** The oper type they logged in as, if they are an oper.
 341          */
 342         reference<OperInfo> oper;
 343
 344         /** Used by User to indicate the registration status of the connection
 345          * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
 346          * the connection state.
 347          */
 348         unsigned int registered:3;
 349
 350         /** True when DNS lookups are completed.
 351          * The UserResolver classes res_forward and res_reverse will
 352          * set this value once they complete.
 353          */
 354         unsigned int dns_done:1;
 355
 356         /** Whether or not to send an snotice about this user's quitting
 357          */
 358         unsigned int quietquit:1;
 359
 360         /** If this is set to true, then all socket operations for the user
 361          * are dropped into the bit-bucket.
 362          * This value is set by QuitUser, and is not needed seperately from that call.
 363          * Please note that setting this value alone will NOT cause the user to quit.
 364          */
 365         unsigned int quitting:1;
 366
 367         /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
 368          * This can't be handled normally because QuitUser itself calls Write on other
 369          * users, which could trigger their SendQ to overrun.
 370          */
 371         unsigned int quitting_sendq:1;
 372
 373         /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
 374          */
 375         unsigned int exempt:1;
 376
 377         /** has the user responded to their previous ping?
 378          */
 379         unsigned int lastping:1;
 380
 381         /** What type of user is this? */
 382         const unsigned int usertype:2;
 383
 384         /** Get client IP string from sockaddr, using static internal buffer
 385          * @return The IP string
 386          */
 387         const char* GetIPString();
 388
 389         /** Get CIDR mask, using default range, for this user
 390          */
 391         irc::sockets::cidr_mask GetCIDRMask();
 392
 393         /** Sets the client IP for this user
 394          * @return true if the conversion was successful
 395          */
 396         virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
 397
 398         virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
 399
 400         /** Constructor
 401          * @throw CoreException if the UID allocated to the user already exists
 402          */
 403         User(const std::string &uid, const std::string& srv, int objtype);
 404
 405         /** Check if the user matches a G or K line, and disconnect them if they do.
 406          * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
 407          * Returns true if the user matched a ban, false else.
 408          */
 409         bool CheckLines(bool doZline = false);
 410
 411         /** Returns the full displayed host of the user
 412          * This member function returns the hostname of the user as seen by other users
 413          * on the server, in nick!ident\@host form.
 414          * @return The full masked host of the user
 415          */
 416         virtual const std::string& GetFullHost();
 417
 418         /** Returns the full real host of the user
 419          * This member function returns the hostname of the user as seen by other users
 420          * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
 421          * e.g. through a module, then this method will ignore it and return the true hostname.
 422          * @return The full real host of the user
 423          */
 424         virtual const std::string& GetFullRealHost();
 425
 426         /** This clears any cached results that are used for GetFullRealHost() etc.
 427          * The results of these calls are cached as generating them can be generally expensive.
 428          */
 429         void InvalidateCache();
 430
 431         /** Create a displayable mode string for this users snomasks
 432          * @return The notice mask character sequence
 433          */
 434         const char* FormatNoticeMasks();
 435
 436         /** Process a snomask modifier string, e.g. +abc-de
 437          * @param sm A sequence of notice mask characters
 438          * @return The cleaned mode sequence which can be output,
 439          * e.g. in the above example if masks c and e are not
 440          * valid, this function will return +ab-d
 441          */
 442         std::string ProcessNoticeMasks(const char *sm);
 443
 444         /** Returns true if a notice mask is set
 445          * @param sm A notice mask character to check
 446          * @return True if the notice mask is set
 447          */
 448         bool IsNoticeMaskSet(unsigned char sm);
 449
 450         /** Changed a specific notice mask value
 451          * @param sm The server notice mask to change
 452          * @param value An on/off value for this mask
 453          */
 454         void SetNoticeMask(unsigned char sm, bool value);
 455
 456         /** Create a displayable mode string for this users umodes
 457          * @param showparameters The mode string
 458          */
 459         const char* FormatModes(bool showparameters = false);
 460
 461         /** Returns true if a specific mode is set
 462          * @param m The user mode
 463          * @return True if the mode is set
 464          */
 465         bool IsModeSet(unsigned char m);
 466
 467         /** Set a specific usermode to on or off
 468          * @param m The user mode
 469          * @param value On or off setting of the mode
 470          */
 471         void SetMode(unsigned char m, bool value);
 472
 473         /** Returns true or false for if a user can execute a privilaged oper command.
 474          * This is done by looking up their oper type from User::oper, then referencing
 475          * this to their oper classes and checking the commands they can execute.
 476          * @param command A command (should be all CAPS)
 477          * @return True if this user can execute the command
 478          */
 479         virtual bool HasPermission(const std::string &command);
 480
 481         /** Returns true if a user has a given permission.
 482          * This is used to check whether or not users may perform certain actions which admins may not wish to give to
 483          * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
 484          *
 485          * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
 486          * @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.
 487          * @return True if this user has the permission in question.
 488          */
 489         virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
 490
 491         /** Returns true or false if a user can set a privileged user or channel mode.
 492          * This is done by looking up their oper type from User::oper, then referencing
 493          * this to their oper classes, and checking the modes they can set.
 494          * @param mode The mode the check
 495          * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
 496          * @return True if the user can set or unset this mode.
 497          */
 498         virtual bool HasModePermission(unsigned char mode, ModeType type);
 499
 500         /** Creates a wildcard host.
 501          * Takes a buffer to use and fills the given buffer with the host in the format *!*\@hostname
 502          * @return The wildcarded hostname in *!*\@host form
 503          */
 504         char* MakeWildHost();
 505
 506         /** Creates a usermask with real host.
 507          * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
 508          * @return the usermask in the format user\@host
 509          */
 510         const std::string& MakeHost();
 511
 512         /** Creates a usermask with real ip.
 513          * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
 514          * @return the usermask in the format user\@ip
 515          */
 516         const std::string& MakeHostIP();
 517
 518         /** Add the user to WHOWAS system
 519          */
 520         void AddToWhoWas();
 521
 522         /** Oper up the user using the given opertype.
 523          * This will also give the +o usermode.
 524          */
 525         void Oper(OperInfo* info);
 526
 527         /** Force a nickname change.
 528          * If the nickname change fails (for example, because the nick in question
 529          * already exists) this function will return false, and you must then either
 530          * output an error message, or quit the user for nickname collision.
 531          * @param newnick The nickname to change to
 532          * @return True if the nickchange was successful.
 533          */
 534         inline bool ForceNickChange(const char* newnick) { return ChangeNick(newnick, true); }
 535
 536         /** Oper down.
 537          * This will clear the +o usermode and unset the user's oper type
 538          */
 539         void UnOper();
 540
 541         /** Write text to this user, appending CR/LF. Works on local users only.
 542          * @param text A std::string to send to the user
 543          */
 544         virtual void Write(const std::string &text);
 545
 546         /** Write text to this user, appending CR/LF.
 547          * Works on local users only.
 548          * @param text The format string for text to send to the user
 549          * @param ... POD-type format arguments
 550          */
 551         virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
 552
 553         /** Write text to this user, appending CR/LF and prepending :server.name
 554          * Works on local users only.
 555          * @param text A std::string to send to the user
 556          */
 557         void WriteServ(const std::string& text);
 558
 559         /** Write text to this user, appending CR/LF and prepending :server.name
 560          * Works on local users only.
 561          * @param text The format string for text to send to the user
 562          * @param ... POD-type format arguments
 563          */
 564         void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
 565
 566         void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
 567
 568         void WriteNumeric(unsigned int numeric, const std::string &text);
 569
 570         /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
 571          * @param user The user to prepend the :nick!user\@host of
 572          * @param text A std::string to send to the user
 573          */
 574         void WriteFrom(User *user, const std::string &text);
 575
 576         /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
 577          * @param user The user to prepend the :nick!user\@host of
 578          * @param text The format string for text to send to the user
 579          * @param ... POD-type format arguments
 580          */
 581         void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
 582
 583         /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user\@host.
 584          * @param dest The user to route the message to
 585          * @param data A std::string to send to the user
 586          */
 587         void WriteTo(User *dest, const std::string &data);
 588
 589         /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user\@host.
 590          * @param dest The user to route the message to
 591          * @param data The format string for text to send to the user
 592          * @param ... POD-type format arguments
 593          */
 594         void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
 595
 596         /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
 597          * @param line A std::string to send to the users
 598          * @param include_self Should the message be sent back to the author?
 599          */
 600         void WriteCommonRaw(const std::string &line, bool include_self = true);
 601
 602         /** Write to all users that can see this user (including this user in the list), appending CR/LF
 603          * @param text The format string for text to send to the users
 604          * @param ... POD-type format arguments
 605          */
 606         void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
 607
 608         /** Write to all users that can see this user (not including this user in the list), appending CR/LF
 609          * @param text The format string for text to send to the users
 610          * @param ... POD-type format arguments
 611          */
 612         void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
 613
 614         /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
 615          * quit message for opers only.
 616          * @param normal_text Normal user quit message
 617          * @param oper_text Oper only quit message
 618          */
 619         void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
 620
 621         /** Dump text to a user target, splitting it appropriately to fit
 622          * @param LinePrefix text to prefix each complete line with
 623          * @param TextStream the text to send to the user
 624          */
 625         void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
 626
 627         /** Write to the user, routing the line if the user is remote.
 628          */
 629         virtual void SendText(const std::string& line) = 0;
 630
 631         /** Write to the user, routing the line if the user is remote.
 632          */
 633         void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
 634
 635         /** Return true if the user shares at least one channel with another user
 636          * @param other The other user to compare the channel list against
 637          * @return True if the given user shares at least one channel with this user
 638          */
 639         bool SharesChannelWith(User *other);
 640
 641         /** Send fake quit/join messages for host or ident cycle.
 642          * Run this after the item in question has changed.
 643          * You should not need to use this function, call ChangeDisplayedHost instead
 644          *
 645          * @param quitline The entire QUIT line, including the source using the old value
 646          */
 647         void DoHostCycle(const std::string &quitline);
 648
 649         /** Change the displayed host of a user.
 650          * ALWAYS use this function, rather than writing User::dhost directly,
 651          * as this triggers module events allowing the change to be syncronized to
 652          * remote servers. This will also emulate a QUIT and rejoin (where configured)
 653          * before setting their host field.
 654          * @param host The new hostname to set
 655          * @return True if the change succeeded, false if it didn't
 656          */
 657         bool ChangeDisplayedHost(const char* host);
 658
 659         /** Change the ident (username) of a user.
 660          * ALWAYS use this function, rather than writing User::ident directly,
 661          * as this correctly causes the user to seem to quit (where configured)
 662          * before setting their ident field.
 663          * @param newident The new ident to set
 664          * @return True if the change succeeded, false if it didn't
 665          */
 666         bool ChangeIdent(const char* newident);
 667
 668         /** Change a users realname field.
 669          * ALWAYS use this function, rather than writing User::fullname directly,
 670          * as this triggers module events allowing the change to be syncronized to
 671          * remote servers.
 672          * @param gecos The user's new realname
 673          * @return True if the change succeeded, false if otherwise
 674          */
 675         bool ChangeName(const char* gecos);
 676
 677         /** Change a user's nick
 678          * @param newnick The new nick
 679          * @param force True if the change is being forced (should not be blocked by modes like +N)
 680          * @return True if the change succeeded
 681          */
 682         bool ChangeNick(const std::string& newnick, bool force = false);
 683
 684         /** Send a command to all local users from this user
 685          * The command given must be able to send text with the
 686          * first parameter as a servermask (e.g. $*), so basically
 687          * you should use PRIVMSG or NOTICE.
 688          * @param command the command to send
 689          * @param text The text format string to send
 690          * @param ... Format arguments
 691          */
 692         void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
 693
 694         /** Compile a channel list for this user.  Used internally by WHOIS
 695          * @param source The user to prepare the channel list for
 696          * @param spy Whether to return the spy channel list rather than the normal one
 697          * @return This user's channel list
 698          */
 699         std::string ChannelList(User* source, bool spy);
 700
 701         /** Split the channel list in cl which came from dest, and spool it to this user
 702          * Used internally by WHOIS
 703          * @param dest The user the original channel list came from
 704          * @param cl The  channel list as a string obtained from User::ChannelList()
 705          */
 706         void SplitChanList(User* dest, const std::string &cl);
 707
 708         /** Remove this user from all channels they are on, and delete any that are now empty.
 709          * This is used by QUIT, and will not send part messages!
 710          */
 711         void PurgeEmptyChannels();
 712
 713         /** Get the connect class which this user belongs to. NULL for remote users.
 714          * @return A pointer to this user's connect class.
 715          */
 716         virtual ConnectClass* GetClass();
 717
 718         /** Default destructor
 719          */
 720         virtual ~User();
 721         virtual CullResult cull();
 722 };
 723
 724 class CoreExport UserIOHandler : public StreamSocket
 725 {
 726  public:
 727         LocalUser* const user;
 728         UserIOHandler(LocalUser* me) : user(me) {}
 729         void OnDataReady();
 730         void OnError(BufferedSocketError error);
 731
 732         /** Adds to the user's write buffer.
 733          * You may add any amount of text up to this users sendq value, if you exceed the
 734          * sendq value, the user will be removed, and further buffer adds will be dropped.
 735          * @param data The data to add to the write buffer
 736          */
 737         void AddWriteBuf(const std::string &data);
 738 };
 739
 740 typedef unsigned int already_sent_t;
 741
 742 class CoreExport LocalUser : public User, public InviteBase
 743 {
 744  public:
 745         LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 746         CullResult cull();
 747
 748         UserIOHandler eh;
 749
 750         /** Position in UserManager::local_users
 751          */
 752         LocalUserList::iterator localuseriter;
 753
 754         /** Stats counter for bytes inbound
 755          */
 756         unsigned int bytes_in;
 757
 758         /** Stats counter for bytes outbound
 759          */
 760         unsigned int bytes_out;
 761
 762         /** Stats counter for commands inbound
 763          */
 764         unsigned int cmds_in;
 765
 766         /** Stats counter for commands outbound
 767          */
 768         unsigned int cmds_out;
 769
 770         /** Password specified by the user when they registered (if any).
 771          * This is stored even if the \<connect> block doesnt need a password, so that
 772          * modules may check it.
 773          */
 774         std::string password;
 775
 776         /** Contains a pointer to the connect class a user is on from
 777          */
 778         reference<ConnectClass> MyClass;
 779
 780         ConnectClass* GetClass();
 781
 782         /** Call this method to find the matching \<connect> for a user, and to check them against it.
 783          */
 784         void CheckClass();
 785
 786         /** Server address and port that this user is connected to.
 787          */
 788         irc::sockets::sockaddrs server_sa;
 789
 790         /**
 791          * @return The port number of this user.
 792          */
 793         int GetServerPort();
 794
 795         /** Used by PING checking code
 796          */
 797         time_t nping;
 798
 799         /** This value contains how far into the penalty threshold the user is.
 800          * This is used either to enable fake lag or for excess flood quits
 801          */
 802         unsigned int CommandFloodPenalty;
 803
 804         static already_sent_t already_sent_id;
 805         already_sent_t already_sent;
 806
 807         /** Stored reverse lookup from res_forward. Should not be used after resolution.
 808          */
 809         std::string stored_host;
 810
 811         /** Starts a DNS lookup of the user's IP.
 812          * This will cause two UserResolver classes to be instantiated.
 813          * When complete, these objects set User::dns_done to true.
 814          */
 815         void StartDNSLookup();
 816
 817         /** Use this method to fully connect a user.
 818          * This will send the message of the day, check G/K/E lines, etc.
 819          */
 820         void FullConnect();
 821
 822         /** Set the connect class to which this user belongs to.
 823          * @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.
 824          * @return A reference to this user's current connect class.
 825          */
 826         void SetClass(const std::string &explicit_name = "");
 827
 828         bool SetClientIP(const char* sip, bool recheck_eline = true);
 829
 830         void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
 831
 832         void SendText(const std::string& line);
 833         void Write(const std::string& text);
 834         void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
 835
 836         /** Returns the list of channels this user has been invited to but has not yet joined.
 837          * @return A list of channels the user is invited to
 838          */
 839         InviteList& GetInviteList();
 840
 841         /** Returns true if a user is invited to a channel.
 842          * @param channel A channel name to look up
 843          * @return True if the user is invited to the given channel
 844          */
 845         bool IsInvited(const irc::string &channel);
 846
 847         /** Adds a channel to a users invite list (invites them to a channel)
 848          * @param channel A channel name to add
 849          * @param timeout When the invite should expire (0 == never)
 850          */
 851         void InviteTo(const irc::string &channel, time_t timeout);
 852
 853         /** Removes a channel from a users invite list.
 854          * This member function is called on successfully joining an invite only channel
 855          * to which the user has previously been invited, to clear the invitation.
 856          * @param channel The channel to remove the invite to
 857          */
 858         void RemoveInvite(const irc::string &channel);
 859
 860         void RemoveExpiredInvites();
 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);
 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);
 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 mode The mode the check
 884          * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
 885          * @return True if the user can set or unset this mode.
 886          */
 887         bool HasModePermission(unsigned char mode, ModeType type);
 888 };
 889
 890 class CoreExport RemoteUser : public User
 891 {
 892  public:
 893         RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
 894         {
 895         }
 896         virtual void SendText(const std::string& line);
 897 };
 898
 899 class CoreExport FakeUser : public User
 900 {
 901  public:
 902         FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
 903         {
 904                 nick = srv;
 905         }
 906
 907         virtual CullResult cull();
 908         virtual void SendText(const std::string& line);
 909         virtual const std::string& GetFullHost();
 910         virtual const std::string& GetFullRealHost();
 911 };
 912
 913 /* Faster than dynamic_cast */
 914 /** Is a local user */
 915 inline LocalUser* IS_LOCAL(User* u)
 916 {
 917         return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
 918 }
 919 /** Is a remote user */
 920 inline RemoteUser* IS_REMOTE(User* u)
 921 {
 922         return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
 923 }
 924 /** Is a server fakeuser */
 925 inline FakeUser* IS_SERVER(User* u)
 926 {
 927         return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
 928 }
 929 /** Is an oper */
 930 #define IS_OPER(x) (x->oper)
 931 /** Is away */
 932 #define IS_AWAY(x) (!x->awaymsg.empty())
 933
 934 /** Derived from Resolver, and performs user forward/reverse lookups.
 935  */
 936 class CoreExport UserResolver : public Resolver
 937 {
 938  private:
 939         /** UUID we are looking up */
 940         std::string uuid;
 941         /** True if the lookup is forward, false if is a reverse lookup
 942          */
 943         bool fwd;
 944  public:
 945         /** Create a resolver.
 946          * @param user The user to begin lookup on
 947          * @param to_resolve The IP or host to resolve
 948          * @param qt The query type
 949          * @param cache Modified by the constructor if the result was cached
 950          */
 951         UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
 952
 953         /** Called on successful lookup
 954          * @param result Result string
 955          * @param ttl Time to live for result
 956          * @param cached True if the result was found in the cache
 957          */
 958         void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
 959
 960         /** Called on failed lookup
 961          * @param e Error code
 962          * @param errormessage Error message string
 963          */
 964         void OnError(ResolverError e, const std::string &errormessage);
 965 };
 966
 967 #endif