src/game/Guild.h

   1 /*
   2  * Copyright (C) 2005-2008 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_REPAIR_FROM_GUILD  = 0x00020000,               // unused in 2.4.x?, 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                = 0x001FF1FF
  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 GuildBankLogEntries
 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 GuildEventLogEntryTypes
 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 struct GuildEventlogEntry
 173 {
 174     uint32 LogGuid;
 175     uint8  EventType;
 176     uint32 PlayerGuid1;
 177     uint32 PlayerGuid2;
 178     uint8  NewRank;
 179     uint64 TimeStamp;
 180 };
 181
 182 enum GuildEmblem
 183 {
 184     ERR_GUILDEMBLEM_SUCCESS               = 0,
 185     ERR_GUILDEMBLEM_INVALID_TABARD_COLORS = 1,
 186     ERR_GUILDEMBLEM_NOGUILD               = 2,
 187     ERR_GUILDEMBLEM_NOTGUILDMASTER        = 3,
 188     ERR_GUILDEMBLEM_NOTENOUGHMONEY        = 4,
 189     ERR_GUILDEMBLEM_INVALIDVENDOR         = 5
 190 };
 191
 192 struct GuildBankEvent
 193 {
 194     uint32 LogGuid;
 195     uint8  LogEntry;
 196     uint8  TabId;
 197     uint32 PlayerGuid;
 198     uint32 ItemOrMoney;
 199     uint8  ItemStackCount;
 200     uint8  DestTabId;
 201     uint64 TimeStamp;
 202
 203     bool isMoneyEvent() const
 204     {
 205         return LogEntry == GUILD_BANK_LOG_DEPOSIT_MONEY ||
 206             LogEntry == GUILD_BANK_LOG_WITHDRAW_MONEY ||
 207             LogEntry == GUILD_BANK_LOG_REPAIR_MONEY;
 208     }
 209 };
 210
 211 struct GuildBankTab
 212 {
 213     Item* Slots[GUILD_BANK_MAX_SLOTS];
 214     std::string Name;
 215     std::string Icon;
 216     std::string Text;
 217 };
 218
 219 struct GuildItemPosCount
 220 {
 221     GuildItemPosCount(uint8 _slot, uint8 _count) : slot(_slot), count(_count) {}
 222
 223     bool isContainedIn(std::vector<GuildItemPosCount> const& vec) const;
 224
 225     uint8 slot;
 226     uint8 count;
 227 };
 228 typedef std::vector<GuildItemPosCount> GuildItemPosCountVec;
 229
 230 struct MemberSlot
 231 {
 232     uint64 logout_time;
 233     std::string name;
 234     std::string Pnote;
 235     std::string OFFnote;
 236     uint32 RankId;
 237     uint32 zoneId;
 238     uint8 level;
 239     uint8 Class;
 240     uint32 BankResetTimeMoney;
 241     uint32 BankRemMoney;
 242     uint32 BankResetTimeTab[GUILD_BANK_MAX_TABS];
 243     uint32 BankRemSlotsTab[GUILD_BANK_MAX_TABS];
 244 };
 245
 246 struct RankInfo
 247 {
 248     RankInfo(const std::string& _name, uint32 _rights, uint32 _money) : name(_name), rights(_rights), BankMoneyPerDay(_money)
 249     {
 250         for(uint8 i = 0; i < GUILD_BANK_MAX_TABS; ++i)
 251         {
 252             TabRight[i] = 0;
 253             TabSlotPerDay[i] = 0;
 254         }
 255     }
 256
 257     std::string name;
 258     uint32 rights;
 259     uint32 BankMoneyPerDay;
 260     uint32 TabRight[GUILD_BANK_MAX_TABS];
 261     uint32 TabSlotPerDay[GUILD_BANK_MAX_TABS];
 262 };
 263
 264 class Guild
 265 {
 266     public:
 267         Guild();
 268         ~Guild();
 269
 270         bool create(uint64 lGuid, std::string gname);
 271         void Disband();
 272
 273         typedef std::map<uint32, MemberSlot> MemberList;
 274         typedef std::vector<RankInfo> RankList;
 275
 276         uint32 GetId(){ return Id; }
 277         const uint64& GetLeader(){ return leaderGuid; }
 278         std::string GetName(){ return name; }
 279         std::string GetMOTD(){ return MOTD; }
 280         std::string GetGINFO(){ return GINFO; }
 281
 282         uint32 GetCreatedYear(){ return CreatedYear; }
 283         uint32 GetCreatedMonth(){ return CreatedMonth; }
 284         uint32 GetCreatedDay(){ return CreatedDay; }
 285
 286         uint32 GetEmblemStyle(){ return EmblemStyle; }
 287         uint32 GetEmblemColor(){ return EmblemColor; }
 288         uint32 GetBorderStyle(){ return BorderStyle; }
 289         uint32 GetBorderColor(){ return BorderColor; }
 290         uint32 GetBackgroundColor(){ return BackgroundColor; }
 291
 292         void SetLeader(uint64 guid);
 293         bool AddMember(uint64 plGuid, uint32 plRank);
 294         void ChangeRank(uint64 guid, uint32 newRank);
 295         void DelMember(uint64 guid, bool isDisbanding=false);
 296         uint32 GetLowestRank() const { return GetNrRanks()-1; }
 297
 298         void SetMOTD(std::string motd);
 299         void SetGINFO(std::string ginfo);
 300         void SetPNOTE(uint64 guid,std::string pnote);
 301         void SetOFFNOTE(uint64 guid,std::string offnote);
 302         void SetEmblem(uint32 emblemStyle, uint32 emblemColor, uint32 borderStyle, uint32 borderColor, uint32 backgroundColor);
 303
 304         uint32 GetMemberSize() const { return members.size(); }
 305
 306         bool LoadGuildFromDB(uint32 GuildId);
 307         bool LoadRanksFromDB(uint32 GuildId);
 308         bool LoadMembersFromDB(uint32 GuildId);
 309
 310         bool FillPlayerData(uint64 guid, MemberSlot* memslot);
 311         void LoadPlayerStatsByGuid(uint64 guid);
 312
 313         void BroadcastToGuild(WorldSession *session, const std::string& msg, uint32 language = LANG_UNIVERSAL);
 314         void BroadcastToOfficers(WorldSession *session, const std::string& msg, uint32 language = LANG_UNIVERSAL);
 315         void BroadcastPacketToRank(WorldPacket *packet, uint32 rankId);
 316         void BroadcastPacket(WorldPacket *packet);
 317
 318         void CreateRank(std::string name,uint32 rights);
 319         void DelRank();
 320         std::string GetRankName(uint32 rankId);
 321         uint32 GetRankRights(uint32 rankId);
 322         uint32 GetNrRanks() const { return m_ranks.size(); }
 323
 324         void SetRankName(uint32 rankId, std::string name);
 325         void SetRankRights(uint32 rankId, uint32 rights);
 326         bool HasRankRight(uint32 rankId, uint32 right)
 327         {
 328             return ((GetRankRights(rankId) & right) != GR_RIGHT_EMPTY) ? true : false;
 329         }
 330         int32 GetRank(uint32 LowGuid);
 331         bool IsMember(uint32 LowGuid)
 332         {
 333             return (members.find(LowGuid) != members.end());
 334         }
 335         MemberSlot* GetMemberSlot(const std::string& name, uint64& guid)
 336         {
 337             for(MemberList::iterator itr = members.begin(); itr != members.end(); ++itr)
 338             {
 339                 if(itr->second.name == name)
 340                 {
 341                     guid = itr->first;
 342                     return &itr->second;
 343                 }
 344             }
 345             return NULL;
 346         }
 347
 348         void Roster(WorldSession *session);
 349         void Query(WorldSession *session);
 350
 351         void UpdateLogoutTime(uint64 guid);
 352         // Guild eventlog
 353         void   LoadGuildEventLogFromDB();
 354         void   UnloadGuildEventlog();
 355         void   DisplayGuildEventlog(WorldSession *session);
 356         void   LogGuildEvent(uint8 EventType, uint32 PlayerGuid1, uint32 PlayerGuid2, uint8 NewRank);
 357         void   RenumGuildEventlog();
 358
 359         // ** Guild bank **
 360         // Content & item deposit/withdraw
 361         void   DisplayGuildBankContent(WorldSession *session, uint8 TabId);
 362         void   DisplayGuildBankContentUpdate(uint8 TabId, int32 slot1, int32 slot2 = -1);
 363         void   DisplayGuildBankContentUpdate(uint8 TabId, GuildItemPosCountVec const& slots);
 364         void   DisplayGuildBankMoneyUpdate();
 365
 366         Item*  GetItem(uint8 TabId, uint8 SlotId);
 367         uint8  CanStoreItem( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32 count, Item *pItem, bool swap = false) const;
 368         Item*  StoreItem( uint8 tab, GuildItemPosCountVec const& pos, Item *pItem );
 369         void   RemoveItem(uint8 tab, uint8 slot );
 370
 371         // Tabs
 372         void   DisplayGuildBankTabsInfo(WorldSession *session);
 373         void   CreateNewBankTab();
 374         void   SetGuildBankTabText(uint8 TabId, std::string text);
 375         void   SendGuildBankTabText(WorldSession *session, uint8 TabId);
 376         void   SetGuildBankTabInfo(uint8 TabId, std::string name, std::string icon);
 377         void   CreateBankRightForTab(uint32 rankid, uint8 TabId);
 378         const  GuildBankTab *GetBankTab(uint8 index) { if(index >= m_TabListMap.size()) return NULL; return m_TabListMap[index]; }
 379         uint8 GetPurchasedTabs() const { return purchased_tabs; }
 380         uint32 GetBankRights(uint32 rankId, uint8 TabId) const;
 381         bool   IsMemberHaveRights(uint32 LowGuid, uint8 TabId,uint32 rights) const;
 382         bool   CanMemberViewTab(uint32 LowGuid, uint8 TabId) const;
 383         // Load/unload
 384         void   LoadGuildBankFromDB();
 385         void   UnloadGuildBank();
 386         void   IncOnlineMemberCount() { ++m_onlinemembers; }
 387         // Money deposit/withdraw
 388         void   SendMoneyInfo(WorldSession *session, uint32 LowGuid);
 389         bool   MemberMoneyWithdraw(uint32 amount, uint32 LowGuid);
 390         uint64 GetGuildBankMoney() { return guildbank_money; }
 391         void   SetBankMoney(int64 money);
 392         // per days
 393         bool   MemberItemWithdraw(uint8 TabId, uint32 LowGuid);
 394         uint32 GetMemberSlotWithdrawRem(uint32 LowGuid, uint8 TabId);
 395         uint32 GetMemberMoneyWithdrawRem(uint32 LowGuid);
 396         void   SetBankMoneyPerDay(uint32 rankId, uint32 money);
 397         void   SetBankRightsAndSlots(uint32 rankId, uint8 TabId, uint32 right, uint32 SlotPerDay, bool db);
 398         uint32 GetBankMoneyPerDay(uint32 rankId);
 399         uint32 GetBankSlotPerDay(uint32 rankId, uint8 TabId);
 400         // rights per day
 401         void   LoadBankRightsFromDB(uint32 GuildId);
 402         // logs
 403         void   LoadGuildBankEventLogFromDB();
 404         void   UnloadGuildBankEventLog();
 405         void   DisplayGuildBankLogs(WorldSession *session, uint8 TabId);
 406         void   LogBankEvent(uint8 LogEntry, uint8 TabId, uint32 PlayerGuidLow, uint32 ItemOrMoney, uint8 ItemStackCount=0, uint8 DestTabId=0);
 407         void   RenumBankLogs();
 408         bool   AddGBankItemToDB(uint32 GuildId, uint32 BankTab , uint32 BankTabSlot , uint32 GUIDLow, uint32 Entry );
 409
 410     protected:
 411         void AddRank(const std::string& name,uint32 rights,uint32 money);
 412
 413         uint32 Id;
 414         std::string name;
 415         uint64 leaderGuid;
 416         std::string MOTD;
 417         std::string GINFO;
 418         uint32 CreatedYear;
 419         uint32 CreatedMonth;
 420         uint32 CreatedDay;
 421
 422         uint32 EmblemStyle;
 423         uint32 EmblemColor;
 424         uint32 BorderStyle;
 425         uint32 BorderColor;
 426         uint32 BackgroundColor;
 427
 428         RankList m_ranks;
 429
 430         MemberList members;
 431
 432         typedef std::vector<GuildBankTab*> TabListMap;
 433         TabListMap m_TabListMap;
 434
 435         /** These are actually ordered lists. The first element is the oldest entry.*/
 436         typedef std::list<GuildEventlogEntry*> GuildEventlog;
 437         typedef std::list<GuildBankEvent*> GuildBankEventLog;
 438         GuildEventlog m_GuildEventlog;
 439         GuildBankEventLog m_GuildBankEventLog_Money;
 440         GuildBankEventLog m_GuildBankEventLog_Item[GUILD_BANK_MAX_TABS];
 441
 442         bool m_bankloaded;
 443         bool m_eventlogloaded;
 444         uint32 m_onlinemembers;
 445         uint64 guildbank_money;
 446         uint8 purchased_tabs;
 447
 448         uint32 LogMaxGuid;
 449         uint32 GuildEventlogMaxGuid;
 450     private:
 451         // internal common parts for CanStore/StoreItem functions
 452         void AppendDisplayGuildBankSlot( WorldPacket& data, GuildBankTab const *tab, int32 slot );
 453         uint8 _CanStoreItem_InSpecificSlot( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32& count, bool swap, Item *pSrcItem ) const;
 454         uint8 _CanStoreItem_InTab( uint8 tab, GuildItemPosCountVec& dest, uint32& count, bool merge, Item *pSrcItem, uint8 skip_slot ) const;
 455         Item* _StoreItem( uint8 tab, uint8 slot, Item *pItem, uint32 count, bool clone );
 456 };
 457 #endif