SocialMgr.h

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __TRINITY_SOCIALMGR_H
#define __TRINITY_SOCIALMGR_H
 
#include "DatabaseEnvFwd.h"
#include "Common.h"
#include "ObjectGuid.h"
#include <map>
 
class Player;
class WorldPacket;
 
enum FriendStatus
{
    FRIEND_STATUS_OFFLINE   = 0x00,
    FRIEND_STATUS_ONLINE    = 0x01,
    FRIEND_STATUS_AFK       = 0x02,
    FRIEND_STATUS_DND       = 0x04,
    FRIEND_STATUS_RAF       = 0x08
};
 
enum SocialFlag
{
    SOCIAL_FLAG_FRIEND      = 0x01,
    SOCIAL_FLAG_IGNORED     = 0x02,
    SOCIAL_FLAG_MUTED       = 0x04,                          // guessed
    SOCIAL_FLAG_UNK         = 0x08,                          // Unknown - does not appear to be RaF
 
    SOCIAL_FLAG_ALL         = SOCIAL_FLAG_FRIEND | SOCIAL_FLAG_IGNORED | SOCIAL_FLAG_MUTED
};
 
struct FriendInfo
{
    ObjectGuid WowAccountGuid;
    FriendStatus Status;
    uint8 Flags;
    uint32 Area;
    uint8 Level;
    uint8 Class;
    std::string Note;
 
    FriendInfo() : Status(FRIEND_STATUS_OFFLINE), Flags(0), Area(0), Level(0), Class(0), Note()
    { }
 
    FriendInfo(ObjectGuid const& accountGuid, uint8 flags, std::string const& note) : WowAccountGuid(accountGuid), Status(FRIEND_STATUS_OFFLINE),
        Flags(flags), Area(0), Level(0), Class(0), Note(note)
    { }
};
 
enum FriendsResult : uint8
{
    FRIEND_DB_ERROR         = 0x00,
    FRIEND_LIST_FULL        = 0x01,
    FRIEND_ONLINE           = 0x02,
    FRIEND_OFFLINE          = 0x03,
    FRIEND_NOT_FOUND        = 0x04,
    FRIEND_REMOVED          = 0x05,
    FRIEND_ADDED_ONLINE     = 0x06,
    FRIEND_ADDED_OFFLINE    = 0x07,
    FRIEND_ALREADY          = 0x08,
    FRIEND_SELF             = 0x09,
    FRIEND_ENEMY            = 0x0A,
    FRIEND_IGNORE_FULL      = 0x0B,
    FRIEND_IGNORE_SELF      = 0x0C,
    FRIEND_IGNORE_NOT_FOUND = 0x0D,
    FRIEND_IGNORE_ALREADY   = 0x0E,
    FRIEND_IGNORE_ADDED     = 0x0F,
    FRIEND_IGNORE_REMOVED   = 0x10,
    FRIEND_IGNORE_AMBIGUOUS = 0x11,                         // That name is ambiguous, type more of the player's server name
    FRIEND_MUTE_FULL        = 0x12,
    FRIEND_MUTE_SELF        = 0x13,
    FRIEND_MUTE_NOT_FOUND   = 0x14,
    FRIEND_MUTE_ALREADY     = 0x15,
    FRIEND_MUTE_ADDED       = 0x16,
    FRIEND_MUTE_REMOVED     = 0x17,
    FRIEND_MUTE_AMBIGUOUS   = 0x18,                         // That name is ambiguous, type more of the player's server name
    FRIEND_UNK1             = 0x19,                         // no message at client
    FRIEND_UNK2             = 0x1A,
    FRIEND_UNK3             = 0x1B,
    FRIEND_UNKNOWN          = 0x1C                          // Unknown friend response from server
};
 
#define SOCIALMGR_FRIEND_LIMIT  50u
#define SOCIALMGR_IGNORE_LIMIT  50u
 
class TC_GAME_API PlayerSocial
{
    friend class SocialMgr;
 
    public:
        PlayerSocial();
        PlayerSocial(PlayerSocial const&);
        PlayerSocial(PlayerSocial&&) noexcept;
        PlayerSocial& operator=(PlayerSocial const&);
        PlayerSocial& operator=(PlayerSocial&&) noexcept;
        ~PlayerSocial();
 
        // adding/removing
        bool AddToSocialList(ObjectGuid const& guid, ObjectGuid const& accountGuid, SocialFlag flag);
        void RemoveFromSocialList(ObjectGuid const& guid, SocialFlag flag);
        void SetFriendNote(ObjectGuid const& guid, std::string const& note);
 
        // Packet send's
        void SendSocialList(Player* player, uint32 flags);
 
        // Misc
        bool HasFriend(ObjectGuid const& friendGuid);
        bool HasIgnore(ObjectGuid const& ignoreGuid, ObjectGuid const& ignoreAccountGuid);
 
        ObjectGuid const& GetPlayerGUID() const { return _playerGUID; }
        void SetPlayerGUID(ObjectGuid const& guid) { _playerGUID = guid; }
 
        uint32 GetNumberOfSocialsWithFlag(SocialFlag flag);
 
    private:
        bool _HasContact(ObjectGuid const& guid, SocialFlag flags);
 
        typedef std::map<ObjectGuid, FriendInfo> PlayerSocialMap;
        PlayerSocialMap _playerSocialMap;
        GuidUnorderedSet _ignoredAccounts;
 
        ObjectGuid _playerGUID;
};
 
class SocialMgr
{
    private:
        SocialMgr();
        ~SocialMgr();
 
    public:
        SocialMgr(SocialMgr const&) = delete;
        SocialMgr(SocialMgr&&) = delete;
        SocialMgr& operator=(SocialMgr const&) = delete;
        SocialMgr& operator=(SocialMgr&&) = delete;
 
        static SocialMgr* instance();
 
        // Misc
        void RemovePlayerSocial(ObjectGuid const& guid) { _socialMap.erase(guid); }
 
        static void GetFriendInfo(Player* player, ObjectGuid const& friendGUID, FriendInfo& friendInfo);
 
        // Packet send's
        void SendFriendStatus(Player* player, FriendsResult result, ObjectGuid const& friendGuid, bool broadcast = false);
        void BroadcastToFriendListers(Player* player, WorldPacket const* packet);
 
        // Loading
        PlayerSocial* LoadFromDB(PreparedQueryResult result, ObjectGuid const& guid);
 
    private:
        typedef std::map<ObjectGuid, PlayerSocial> SocialMap;
        SocialMap _socialMap;
};
 
#define sSocialMgr SocialMgr::instance()
 
#endif