users.h

Go to the documentation of this file.

/*
 *
 * (C) 2008-2011 Robin Burchell <w00t@inspircd.org>
 * (C) 2003-2013 Anope Team
 * Contact us at team@anope.org
 *
 * Please read COPYING and README for further details.
 *
 * Based on the original code of Epona by Lara.
 * Based on the original code of Services by Andy Church.
 *
 */

#ifndef USERS_H
#define USERS_H

#include "anope.h"
#include "modes.h"
#include "extensible.h"
#include "serialize.h"
#include "commands.h"
#include "account.h"

typedef Anope::hash_map<User *> user_map;

extern CoreExport user_map UserListByNick, UserListByUID;

extern CoreExport int OperCount;
extern CoreExport unsigned MaxUserCount;
extern CoreExport time_t MaxUserTime;

/* Online user and channel data. */
class CoreExport User : public virtual Base, public Extensible, public CommandReply
{
        /* true if the user was quit or killed */
        bool quit;
        /* Users that are in the process of quitting */
        static std::list<User *> quitting_users;
 protected:
        Anope::string vident;
        Anope::string ident;
        Anope::string uid;
        /* If the user is on the access list of the nick theyre on */
        bool on_access;
        /* Map of user modes and the params this user has (if any) */
        std::map<Anope::string, Anope::string> modes;
        /* NickCore account the user is currently loggged in as, if they are logged in */
        Serialize::Reference<NickCore> nc;

        /* # of invalid password attempts */
        unsigned short invalid_pw_count;
        /* Time of last invalid password */
        time_t invalid_pw_time;


 public: // XXX: exposing a tiny bit too much
        /* User's current nick */
        Anope::string nick;

        /* User's real hostname */
        Anope::string host;
        /* User's virtual hostname */
        Anope::string vhost;
        /* User's cloaked hostname */
        Anope::string chost;
        /* Realname */
        Anope::string realname;
        /* SSL Fingerprint */
        Anope::string fingerprint;
        /* User's IP */
        Anope::string ip;
        /* Server user is connected to */
        Server *server;
        /* When the user signed on. Set on connect and never modified. */
        time_t signon;
        /* Timestamp of the nick. Updated when the nick changes. */
        time_t timestamp;
        /* Is the user as super admin? */
        bool super_admin;

        /* Channels the user is in */
        typedef std::list<ChanUserContainer *> ChanUserList;
        ChanUserList chans;

        /* Last time this user sent a memo command used */
        time_t lastmemosend;
        /* Last time this user registered */
        time_t lastnickreg;
        /* Last time this user sent an email */
        time_t lastmail;

        User(const Anope::string &snick, const Anope::string &sident, const Anope::string &shost, const Anope::string &svhost, const Anope::string &sip, Server *sserver, const Anope::string &srealname, time_t ssignon, const Anope::string &smodes, const Anope::string &suid = "");

 protected:
        virtual ~User();

 public:
        void ChangeNick(const Anope::string &newnick, time_t ts = Anope::CurTime);

        void SetDisplayedHost(const Anope::string &host);

        const Anope::string &GetDisplayedHost() const;

        void SetCloakedHost(const Anope::string &newhost);

        const Anope::string &GetCloakedHost() const;

        const Anope::string &GetUID() const;

        void SetVIdent(const Anope::string &ident);

        const Anope::string &GetVIdent() const;

        void SetIdent(const Anope::string &ident);

        const Anope::string &GetIdent() const;

        Anope::string GetMask() const;

        Anope::string GetDisplayedMask() const;

        void SetRealname(const Anope::string &realname);

        void SendMessage(const BotInfo *source, const char *fmt, ...);
        void SendMessage(const BotInfo *source, const Anope::string &msg) anope_override;

        void Collide(NickAlias *na);

        void Identify(NickAlias *na);

        void Login(NickCore *core);

        void Logout();

        virtual NickCore *Account() const;

        bool IsIdentified(bool check_nick = false) const;

        bool IsRecognized(bool check_nick = true) const;

        bool IsServicesOper();

        bool HasCommand(const Anope::string &cmdstr);

        bool HasPriv(const Anope::string &privstr);

        void UpdateHost();

        bool HasMode(const Anope::string &name) const;

        void SetModeInternal(UserMode *um, const Anope::string &param = "");

        void RemoveModeInternal(UserMode *um);

        void SetMode(const BotInfo *bi, UserMode *um, const Anope::string &param = "");

        void SetMode(const BotInfo *bi, const Anope::string &name, const Anope::string &param = "");

        void RemoveMode(const BotInfo *bi, UserMode *um);

        void RemoveMode(const BotInfo *bi, const Anope::string &name);

        void SetModes(const BotInfo *bi, const char *umodes, ...);

        void SetModesInternal(const char *umodes, ...);

        Anope::string GetModes() const;

        ChanUserContainer *FindChannel(const Channel *c) const;

        bool IsProtected() const;

        void Kill(const Anope::string &source, const Anope::string &reason);

        void KillInternal(const Anope::string &source, const Anope::string &reason);

        void Quit(const Anope::string &reason = "");

        bool Quitting() const;

        /* Returns a mask that will most likely match any address the
         * user will have from that location.  For IP addresses, wildcards the
         * appropriate subnet mask (e.g. 35.1.1.1 -> 35.*; 128.2.1.1 -> 128.2.*);
         * for named addresses, wildcards the leftmost part of the name unless the
         * name only contains two parts.  If the username begins with a ~, delete
         * it.
         */
        Anope::string Mask() const;

        bool BadPassword();

        static User* Find(const Anope::string &name, bool nick_only = false);

        static void QuitUsers();
};

#endif // USERS_H