src/game/Guild.h

   1 /*
   2  * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef MANGOSSERVER_GUILD_H
  20 #define MANGOSSERVER_GUILD_H
  21
  22 #define WITHDRAW_MONEY_UNLIMITED    0xFFFFFFFF
  23 #define WITHDRAW_SLOT_UNLIMITED     0xFFFFFFFF
  24
  25 #include "Item.h"
  26
  27 class Item;
  28
  29 enum GuildDefaultRanks
  30 {
  31     GR_GUILDMASTER  = 0,
  32     GR_OFFICER      = 1,
  33     //GR_VETERAN      = 2, -- not used anywhere and possible incorrect in modified rank list
  34     //GR_MEMBER       = 3,
  35     //GR_INITIATE     = 4, -- use Guild::GetLowestRank() instead for lowest rank
  36 };
  37
  38 enum GuildRankRights
  39 {
  40     GR_RIGHT_EMPTY              = 0x00000040,
  41     GR_RIGHT_GCHATLISTEN        = 0x00000041,
  42     GR_RIGHT_GCHATSPEAK         = 0x00000042,
  43     GR_RIGHT_OFFCHATLISTEN      = 0x00000044,
  44     GR_RIGHT_OFFCHATSPEAK       = 0x00000048,
  45     GR_RIGHT_PROMOTE            = 0x000000C0,
  46     GR_RIGHT_DEMOTE             = 0x00000140,
  47     GR_RIGHT_INVITE             = 0x00000050,
  48     GR_RIGHT_REMOVE             = 0x00000060,
  49     GR_RIGHT_SETMOTD            = 0x00001040,
  50     GR_RIGHT_EPNOTE             = 0x00002040,
  51     GR_RIGHT_VIEWOFFNOTE        = 0x00004040,
  52     GR_RIGHT_EOFFNOTE           = 0x00008040,
  53     GR_RIGHT_MODIFY_GUILD_INFO  = 0x00010040,
  54     GR_RIGHT_WITHDRAW_GOLD_LOCK = 0x00020000,               // remove money withdraw capacity
  55     GR_RIGHT_WITHDRAW_REPAIR    = 0x00040000,               // withdraw for repair
  56     GR_RIGHT_WITHDRAW_GOLD      = 0x00080000,               // withdraw gold
  57     GR_RIGHT_CREATE_GUILD_EVENT = 0x00100000,               // wotlk
  58     GR_RIGHT_ALL                = 0x001DF1FF
  59 };
  60
  61 enum Typecommand
  62 {
  63     GUILD_CREATE_S  = 0x00,
  64     GUILD_INVITE_S  = 0x01,
  65     GUILD_QUIT_S    = 0x03,
  66     GUILD_FOUNDER_S = 0x0E,
  67     GUILD_UNK1      = 0x10,
  68     GUILD_BANK_S    = 0x15,
  69     GUILD_UNK3      = 0x16
  70 };
  71
  72 enum CommandErrors
  73 {
  74     GUILD_PLAYER_NO_MORE_IN_GUILD   = 0x00,
  75     GUILD_INTERNAL                  = 0x01,
  76     GUILD_ALREADY_IN_GUILD          = 0x02,
  77     ALREADY_IN_GUILD                = 0x03,
  78     INVITED_TO_GUILD                = 0x04,
  79     ALREADY_INVITED_TO_GUILD        = 0x05,
  80     GUILD_NAME_INVALID              = 0x06,
  81     GUILD_NAME_EXISTS               = 0x07,
  82     GUILD_LEADER_LEAVE              = 0x08,
  83     GUILD_PERMISSIONS               = 0x08,
  84     GUILD_PLAYER_NOT_IN_GUILD       = 0x09,
  85     GUILD_PLAYER_NOT_IN_GUILD_S     = 0x0A,
  86     GUILD_PLAYER_NOT_FOUND          = 0x0B,
  87     GUILD_NOT_ALLIED                = 0x0C,
  88     GUILD_RANK_TOO_HIGH_S           = 0x0D,
  89     GUILD_ALREADY_LOWEST_RANK_S     = 0x0E,
  90     GUILD_TEMP_ERROR                = 0x11,
  91     GUILD_RANK_IN_USE               = 0x12,
  92     GUILD_IGNORE                    = 0x13,
  93     GUILD_ERR_UNK1                  = 0x17,
  94     GUILD_WITHDRAW_TOO_MUCH         = 0x18,
  95     GUILD_BANK_NO_MONEY             = 0x19,
  96     GUILD_BANK_TAB_IS_FULL          = 0x1B,
  97     GUILD_BANK_ITEM_NOT_FOUND       = 0x1C
  98 };
  99
 100 enum GuildEvents
 101 {
 102     GE_PROMOTION        = 0x00,
 103     GE_DEMOTION         = 0x01,
 104     GE_MOTD             = 0x02,
 105     GE_JOINED           = 0x03,
 106     GE_LEFT             = 0x04,
 107     GE_REMOVED          = 0x05,
 108     GE_LEADER_IS        = 0x06,
 109     GE_LEADER_CHANGED   = 0x07,
 110     GE_DISBANDED        = 0x08,
 111     GE_TABARDCHANGE     = 0x09,
 112     GE_UNK1             = 0x0A,                             // string, string
 113     GE_UNK2             = 0x0B,
 114     GE_SIGNED_ON        = 0x0C,
 115     GE_SIGNED_OFF       = 0x0D,
 116     GE_UNK3             = 0x0E,
 117     GE_BANKTAB_PURCHASED= 0x0F,
 118     GE_UNK5             = 0x10,
 119     GE_UNK6             = 0x11,                             // string 0000000000002710 is 1 gold
 120     GE_UNK7             = 0x12
 121 };
 122
 123 enum PetitionTurns
 124 {
 125     PETITION_TURN_OK                    = 0,
 126     PETITION_TURN_ALREADY_IN_GUILD      = 2,
 127     PETITION_TURN_NEED_MORE_SIGNATURES  = 4,
 128 };
 129
 130 enum PetitionSigns
 131 {
 132     PETITION_SIGN_OK                = 0,
 133     PETITION_SIGN_ALREADY_SIGNED    = 1,
 134     PETITION_SIGN_ALREADY_IN_GUILD  = 2,
 135     PETITION_SIGN_CANT_SIGN_OWN     = 3,
 136     PETITION_SIGN_NOT_SERVER        = 4,
 137 };
 138
 139 enum GuildBankRights
 140 {
 141     GUILD_BANK_RIGHT_VIEW_TAB       = 0x01,
 142     GUILD_BANK_RIGHT_PUT_ITEM       = 0x02,
 143     GUILD_BANK_RIGHT_UPDATE_TEXT    = 0x04,
 144
 145     GUILD_BANK_RIGHT_DEPOSIT_ITEM   = GUILD_BANK_RIGHT_VIEW_TAB | GUILD_BANK_RIGHT_PUT_ITEM,
 146     GUILD_BANK_RIGHT_FULL           = 0xFF,
 147 };
 148
 149 enum GuildBankEventLogTypes
 150 {
 151     GUILD_BANK_LOG_DEPOSIT_ITEM     = 1,
 152     GUILD_BANK_LOG_WITHDRAW_ITEM    = 2,
 153     GUILD_BANK_LOG_MOVE_ITEM        = 3,
 154     GUILD_BANK_LOG_DEPOSIT_MONEY    = 4,
 155     GUILD_BANK_LOG_WITHDRAW_MONEY   = 5,
 156     GUILD_BANK_LOG_REPAIR_MONEY     = 6,
 157     GUILD_BANK_LOG_MOVE_ITEM2       = 7,
 158     GUILD_BANK_LOG_UNK1             = 8,
 159     GUILD_BANK_LOG_UNK2             = 9,
 160 };
 161
 162 enum GuildEventLogTypes
 163 {
 164     GUILD_EVENT_LOG_INVITE_PLAYER     = 1,
 165     GUILD_EVENT_LOG_JOIN_GUILD        = 2,
 166     GUILD_EVENT_LOG_PROMOTE_PLAYER    = 3,
 167     GUILD_EVENT_LOG_DEMOTE_PLAYER     = 4,
 168     GUILD_EVENT_LOG_UNINVITE_PLAYER   = 5,
 169     GUILD_EVENT_LOG_LEAVE_GUILD       = 6,
 170 };
 171
 172 enum GuildEmblem
 173 {
 174     ERR_GUILDEMBLEM_SUCCESS               = 0,
 175     ERR_GUILDEMBLEM_INVALID_TABARD_COLORS = 1,
 176     ERR_GUILDEMBLEM_NOGUILD               = 2,
 177     ERR_GUILDEMBLEM_NOTGUILDMASTER        = 3,
 178     ERR_GUILDEMBLEM_NOTENOUGHMONEY        = 4,
 179     ERR_GUILDEMBLEM_INVALIDVENDOR         = 5
 180 };
 181
 182 inline uint32 GetGuildBankTabPrice(uint8 Index)
 183 {
 184     switch(Index)
 185     {
 186         case 0: return 100;
 187         case 1: return 250;
 188         case 2: return 500;
 189         case 3: return 1000;
 190         case 4: return 2500;
 191         case 5: return 5000;
 192         default:
 193             return 0;
 194     }
 195     return 0;
 196 }
 197
 198 struct GuildEventLogEntry
 199 {
 200     uint8  EventType;
 201     uint32 PlayerGuid1;
 202     uint32 PlayerGuid2;
 203     uint8  NewRank;
 204     uint64 TimeStamp;
 205 };
 206
 207 struct GuildBankEventLogEntry
 208 {
 209     uint8  EventType;
 210     uint32 PlayerGuid;
 211     uint32 ItemOrMoney;
 212     uint8  ItemStackCount;
 213     uint8  DestTabId;
 214     uint64 TimeStamp;
 215
 216     bool isMoneyEvent() const
 217     {
 218         return EventType == GUILD_BANK_LOG_DEPOSIT_MONEY ||
 219             EventType == GUILD_BANK_LOG_WITHDRAW_MONEY ||
 220             EventType == GUILD_BANK_LOG_REPAIR_MONEY;
 221     }
 222 };
 223
 224 struct GuildBankTab
 225 {
 226     Item* Slots[GUILD_BANK_MAX_SLOTS];
 227     std::string Name;
 228     std::string Icon;
 229     std::string Text;
 230 };
 231
 232 struct GuildItemPosCount
 233 {
 234     GuildItemPosCount(uint8 _slot, uint32 _count) : slot(_slot), count(_count) {}
 235
 236     bool isContainedIn(std::vector<GuildItemPosCount> const& vec) const;
 237
 238     uint8 slot;
 239     uint32 count;
 240 };
 241 typedef std::vector<GuildItemPosCount> GuildItemPosCountVec;
 242
 243 struct MemberSlot
 244 {
 245     uint64 logout_time;
 246     std::string name;
 247     std::string Pnote;
 248     std::string OFFnote;
 249     uint32 RankId;
 250     uint32 zoneId;
 251     uint8 level;
 252     uint8 Class;
 253     uint32 BankResetTimeMoney;
 254     uint32 BankRemMoney;
 255     uint32 BankResetTimeTab[GUILD_BANK_MAX_TABS];
 256     uint32 BankRemSlotsTab[GUILD_BANK_MAX_TABS];
 257 };
 258
 259 struct RankInfo
 260 {
 261     RankInfo(const std::string& _name, uint32 _rights, uint32 _money) : name(_name), rights(_rights), BankMoneyPerDay(_money)
 262     {
 263         for(uint8 i = 0; i < GUILD_BANK_MAX_TABS; ++i)
 264         {
 265             TabRight[i] = 0;
 266             TabSlotPerDay[i] = 0;
 267         }
 268     }
 269
 270     std::string name;
 271     uint32 rights;
 272     uint32 BankMoneyPerDay;
 273     uint32 TabRight[GUILD_BANK_MAX_TABS];
 274     uint32 TabSlotPerDay[GUILD_BANK_MAX_TABS];
 275 };
 276
 277 class Guild
 278 {
 279     public:
 280         Guild();
 281         ~Guild();
 282
 283         bool Create(Player* leader, std::string gname);
 284         void Disband();
 285
 286         typedef std::map<uint32, MemberSlot> MemberList;
 287         typedef std::vector<RankInfo> RankList;
 288
 289         uint32 GetId(){ return m_Id; }
 290         const uint64& GetLeader(){ return m_LeaderGuid; }
 291         std::string GetName(){ return m_Name; }
 292         std::string GetMOTD(){ return MOTD; }
 293         std::string GetGINFO(){ return GINFO; }
 294
 295         uint32 GetCreatedYear(){ return m_CreatedYear; }
 296         uint32 GetCreatedMonth(){ return m_CreatedMonth; }
 297         uint32 GetCreatedDay(){ return m_CreatedDay; }
 298
 299         uint32 GetEmblemStyle(){ return m_EmblemStyle; }
 300         uint32 GetEmblemColor(){ return m_EmblemColor; }
 301         uint32 GetBorderStyle(){ return m_BorderStyle; }
 302         uint32 GetBorderColor(){ return m_BorderColor; }
 303         uint32 GetBackgroundColor(){ return m_BackgroundColor; }
 304
 305         void SetLeader(uint64 guid);
 306         bool AddMember(uint64 plGuid, uint32 plRank);
 307         void ChangeRank(uint64 guid, uint32 newRank);
 308         void DelMember(uint64 guid, bool isDisbanding=false);
 309         uint32 GetLowestRank() const { return GetNrRanks()-1; }
 310
 311         void SetMOTD(std::string motd);
 312         void SetGINFO(std::string ginfo);
 313         void SetPNOTE(uint64 guid, std::string pnote);
 314         void SetOFFNOTE(uint64 guid, std::string offnote);
 315         void SetEmblem(uint32 emblemStyle, uint32 emblemColor, uint32 borderStyle, uint32 borderColor, uint32 backgroundColor);
 316
 317         uint32 GetMemberSize() const { return members.size(); }
 318
 319         bool LoadGuildFromDB(uint32 GuildId);
 320         bool LoadRanksFromDB(uint32 GuildId);
 321         bool LoadMembersFromDB(uint32 GuildId);
 322
 323         bool FillPlayerData(uint64 guid, MemberSlot* memslot);
 324         void LoadPlayerStatsByGuid(uint64 guid);
 325
 326         void BroadcastToGuild(WorldSession *session, const std::string& msg, uint32 language = LANG_UNIVERSAL);
 327         void BroadcastToOfficers(WorldSession *session, const std::string& msg, uint32 language = LANG_UNIVERSAL);
 328         void BroadcastPacketToRank(WorldPacket *packet, uint32 rankId);
 329         void BroadcastPacket(WorldPacket *packet);
 330
 331         template<class Do>
 332         void BroadcastWorker(Do& _do, Player* except = NULL)
 333         {
 334             for(MemberList::iterator itr = members.begin(); itr != members.end(); ++itr)
 335                 if(Player *player = ObjectAccessor::FindPlayer(MAKE_NEW_GUID(itr->first, 0, HIGHGUID_PLAYER)))
 336                     if(player != except)
 337                         _do(player);
 338         }
 339
 340         void CreateRank(std::string name,uint32 rights);
 341         void DelRank();
 342         std::string GetRankName(uint32 rankId);
 343         uint32 GetRankRights(uint32 rankId);
 344         uint32 GetNrRanks() const { return m_Ranks.size(); }
 345
 346         void SetRankName(uint32 rankId, std::string name);
 347         void SetRankRights(uint32 rankId, uint32 rights);
 348         bool HasRankRight(uint32 rankId, uint32 right)
 349         {
 350             return ((GetRankRights(rankId) & right) != GR_RIGHT_EMPTY) ? true : false;
 351         }
 352         int32 GetRank(uint32 LowGuid);
 353         bool IsMember(uint32 LowGuid)
 354         {
 355             return (members.find(LowGuid) != members.end());
 356         }
 357         MemberSlot* GetMemberSlot(const std::string& name, uint64& guid)
 358         {
 359             for(MemberList::iterator itr = members.begin(); itr != members.end(); ++itr)
 360             {
 361                 if(itr->second.name == name)
 362                 {
 363                     guid = itr->first;
 364                     return &itr->second;
 365                 }
 366             }
 367             return NULL;
 368         }
 369
 370         void Roster(WorldSession *session);
 371         void Query(WorldSession *session);
 372
 373         void   UpdateLogoutTime(uint64 guid);
 374         // Guild EventLog
 375         void   LoadGuildEventLogFromDB();
 376         void   UnloadGuildEventLog();
 377         void   DisplayGuildEventLog(WorldSession *session);
 378         void   LogGuildEvent(uint8 EventType, uint32 PlayerGuid1, uint32 PlayerGuid2, uint8 NewRank);
 379
 380         // ** Guild bank **
 381         // Content & item deposit/withdraw
 382         void   DisplayGuildBankContent(WorldSession *session, uint8 TabId);
 383         void   DisplayGuildBankMoneyUpdate();
 384
 385         void   SwapItems( Player * pl, uint8 BankTab, uint8 BankTabSlot, uint8 BankTabDst, uint8 BankTabSlotDst, uint32 SplitedAmount);
 386         void   MoveFromBankToChar( Player * pl, uint8 BankTab, uint8 BankTabSlot, uint8 PlayerBag, uint8 PlayerSlot, uint32 SplitedAmount);
 387         void   MoveFromCharToBank( Player * pl, uint8 PlayerBag, uint8 PlayerSlot, uint8 BankTab, uint8 BankTabSlot, uint32 SplitedAmount);
 388
 389         // Tabs
 390         void   DisplayGuildBankTabsInfo(WorldSession *session);
 391         void   CreateNewBankTab();
 392         void   SetGuildBankTabText(uint8 TabId, std::string text);
 393         void   SendGuildBankTabText(WorldSession *session, uint8 TabId);
 394         void   SetGuildBankTabInfo(uint8 TabId, std::string name, std::string icon);
 395         void   CreateBankRightForTab(uint32 rankid, uint8 TabId);
 396         const  GuildBankTab *GetBankTab(uint8 index) { if(index >= m_TabListMap.size()) return NULL; return m_TabListMap[index]; }
 397         uint8  GetPurchasedTabs() const { return m_PurchasedTabs; }
 398         uint32 GetBankRights(uint32 rankId, uint8 TabId) const;
 399         bool   IsMemberHaveRights(uint32 LowGuid, uint8 TabId,uint32 rights) const;
 400         bool   CanMemberViewTab(uint32 LowGuid, uint8 TabId) const;
 401         // Load/unload
 402         void   LoadGuildBankFromDB();
 403         void   UnloadGuildBank();
 404         void   IncOnlineMemberCount() { ++m_OnlineMembers; }
 405         // Money deposit/withdraw
 406         void   SendMoneyInfo(WorldSession *session, uint32 LowGuid);
 407         bool   MemberMoneyWithdraw(uint32 amount, uint32 LowGuid);
 408         uint64 GetGuildBankMoney() { return m_GuildBankMoney; }
 409         void   SetBankMoney(int64 money);
 410         // per days
 411         bool   MemberItemWithdraw(uint8 TabId, uint32 LowGuid);
 412         uint32 GetMemberSlotWithdrawRem(uint32 LowGuid, uint8 TabId);
 413         uint32 GetMemberMoneyWithdrawRem(uint32 LowGuid);
 414         void   SetBankMoneyPerDay(uint32 rankId, uint32 money);
 415         void   SetBankRightsAndSlots(uint32 rankId, uint8 TabId, uint32 right, uint32 SlotPerDay, bool db);
 416         uint32 GetBankMoneyPerDay(uint32 rankId);
 417         uint32 GetBankSlotPerDay(uint32 rankId, uint8 TabId);
 418         // rights per day
 419         void   LoadBankRightsFromDB(uint32 GuildId);
 420         // Guild Bank Event Logs
 421         void   LoadGuildBankEventLogFromDB();
 422         void   UnloadGuildBankEventLog();
 423         void   DisplayGuildBankLogs(WorldSession *session, uint8 TabId);
 424         void   LogBankEvent(uint8 EventType, uint8 TabId, uint32 PlayerGuidLow, uint32 ItemOrMoney, uint8 ItemStackCount=0, uint8 DestTabId=0);
 425         bool   AddGBankItemToDB(uint32 GuildId, uint32 BankTab , uint32 BankTabSlot , uint32 GUIDLow, uint32 Entry );
 426
 427     protected:
 428         void AddRank(const std::string& name,uint32 rights,uint32 money);
 429
 430         uint32 m_Id;
 431         std::string m_Name;
 432         uint64 m_LeaderGuid;
 433         std::string MOTD;
 434         std::string GINFO;
 435         uint32 m_CreatedYear;
 436         uint32 m_CreatedMonth;
 437         uint32 m_CreatedDay;
 438
 439         uint32 m_EmblemStyle;
 440         uint32 m_EmblemColor;
 441         uint32 m_BorderStyle;
 442         uint32 m_BorderColor;
 443         uint32 m_BackgroundColor;
 444
 445         RankList m_Ranks;
 446
 447         MemberList members;
 448
 449         typedef std::vector<GuildBankTab*> TabListMap;
 450         TabListMap m_TabListMap;
 451
 452         /** These are actually ordered lists. The first element is the oldest entry.*/
 453         typedef std::list<GuildEventLogEntry> GuildEventLog;
 454         typedef std::list<GuildBankEventLogEntry> GuildBankEventLog;
 455         GuildEventLog m_GuildEventLog;
 456         GuildBankEventLog m_GuildBankEventLog_Money;
 457         GuildBankEventLog m_GuildBankEventLog_Item[GUILD_BANK_MAX_TABS];
 458
 459         uint32 m_GuildEventLogNextGuid;
 460         uint32 m_GuildBankEventLogNextGuid_Money;
 461         uint32 m_GuildBankEventLogNextGuid_Item[GUILD_BANK_MAX_TABS];
 462
 463         bool m_GuildBankLoaded;
 464         bool m_EventLogLoaded;
 465         uint32 m_OnlineMembers;
 466         uint64 m_GuildBankMoney;
 467         uint8 m_PurchasedTabs;
 468
 469     private:
 470         // used only from high level Swap/Move functions
 471         Item*  GetItem(uint8 TabId, uint8 SlotId);
 472         uint8  CanStoreItem( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32 count, Item *pItem, bool swap = false) const;
 473         Item*  StoreItem( uint8 tab, GuildItemPosCountVec const& pos, Item *pItem );
 474         void   RemoveItem(uint8 tab, uint8 slot );
 475         void   DisplayGuildBankContentUpdate(uint8 TabId, int32 slot1, int32 slot2 = -1);
 476         void   DisplayGuildBankContentUpdate(uint8 TabId, GuildItemPosCountVec const& slots);
 477
 478         // internal common parts for CanStore/StoreItem functions
 479         void AppendDisplayGuildBankSlot( WorldPacket& data, GuildBankTab const *tab, int32 slot );
 480         uint8 _CanStoreItem_InSpecificSlot( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32& count, bool swap, Item *pSrcItem ) const;
 481         uint8 _CanStoreItem_InTab( uint8 tab, GuildItemPosCountVec& dest, uint32& count, bool merge, Item *pSrcItem, uint8 skip_slot ) const;
 482         Item* _StoreItem( uint8 tab, uint8 slot, Item *pItem, uint32 count, bool clone );
 483 };
 484 #endif