src/game/Mail.h

   1 /*
   2  * Copyright (C) 2005-2010 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 /**
  20  * @addtogroup mailing The mail system
  21  * The mailing system in MaNGOS consists of mostly two files:
  22  * - Mail.h
  23  * - Mail.cpp
  24  *
  25  * @{
  26  *
  27  * @file Mail.h
  28  * This file contains the the headers needed for MaNGOS to handle mails.
  29  *
  30  */
  31
  32 #ifndef MANGOS_MAIL_H
  33 #define MANGOS_MAIL_H
  34
  35 #include "Common.h"
  36 #include <map>
  37
  38 struct AuctionEntry;
  39 class Item;
  40 class Object;
  41 class Player;
  42
  43 #define MAIL_BODY_ITEM_TEMPLATE 8383                        ///< - plain letter, A Dusty Unsent Letter: 889
  44 /// The maximal amount of items a mail can contain.
  45 #define MAX_MAIL_ITEMS 12
  46 /**
  47  * The type of the mail.
  48  * A mail can have 5 Different Types.
  49  */
  50 enum MailMessageType
  51 {
  52     MAIL_NORMAL         = 0,
  53     MAIL_AUCTION        = 2,
  54     MAIL_CREATURE       = 3,                                /// client send CMSG_CREATURE_QUERY on this mailmessagetype
  55     MAIL_GAMEOBJECT     = 4,                                /// client send CMSG_GAMEOBJECT_QUERY on this mailmessagetype
  56     MAIL_ITEM           = 5,                                /// client send CMSG_ITEM_QUERY on this mailmessagetype
  57 };
  58 /**
  59  * A Mask representing the status of the mail.
  60  */
  61 enum MailCheckMask
  62 {
  63     MAIL_CHECK_MASK_NONE        = 0x00,
  64     MAIL_CHECK_MASK_READ        = 0x01,                     /// This mail was read.
  65     MAIL_CHECK_MASK_AUCTION     = 0x04,                     /// This mail was from an auction.
  66     MAIL_CHECK_MASK_COD_PAYMENT = 0x08,                     /// This mail is payable on delivery.
  67     MAIL_CHECK_MASK_RETURNED    = 0x10                      /// This mail has been returned.
  68 };
  69
  70 /**
  71  * The different types of Stationaries that exist for mails.
  72  * They have been gathered from Stationery.dbc
  73  */
  74 enum MailStationery
  75 {
  76     MAIL_STATIONERY_UNKNOWN =  1,
  77     MAIL_STATIONERY_NORMAL  = 41,
  78     MAIL_STATIONERY_GM      = 61,
  79     MAIL_STATIONERY_AUCTION = 62,
  80     MAIL_STATIONERY_VAL     = 64,
  81     MAIL_STATIONERY_CHR     = 65,
  82     MAIL_STATIONERY_ORP     = 67,                           // new in 3.2.2
  83 };
  84 /**
  85  * Representation of the State of a mail.
  86  */
  87 enum MailState
  88 {
  89     MAIL_STATE_UNCHANGED = 1,
  90     MAIL_STATE_CHANGED   = 2,
  91     MAIL_STATE_DELETED   = 3
  92 };
  93 /**
  94  * Answers contained in mails from auctionhouses.
  95  */
  96 enum MailAuctionAnswers
  97 {
  98     AUCTION_OUTBIDDED           = 0,
  99     AUCTION_WON                 = 1,
 100     AUCTION_SUCCESSFUL          = 2,
 101     AUCTION_EXPIRED             = 3,
 102     AUCTION_CANCELLED_TO_BIDDER = 4,
 103     AUCTION_CANCELED            = 5,
 104     AUCTION_SALE_PENDING        = 6
 105 };
 106 /**
 107  * A class to represent the sender of a mail.
 108  */
 109 class MailSender
 110 {
 111     public:                                                 // Constructors
 112                /**
 113                 * Creates a new MailSender object.
 114                 *
 115                 * @param messageType the type of the mail.
 116                 * @param sender_guidlow_or_entry The lower part of the GUID of the player sending
 117                 *                                                                this mail, or the Entry of the non-player object.
 118                 * @param stationery The stationary associated with this MailSender.
 119                 *
 120                 */
 121         MailSender(MailMessageType messageType, uint32 sender_guidlow_or_entry, MailStationery stationery = MAIL_STATIONERY_NORMAL)
 122             : m_messageType(messageType), m_senderId(sender_guidlow_or_entry), m_stationery(stationery)
 123         {
 124         }
 125         MailSender(Object* sender, MailStationery stationery = MAIL_STATIONERY_NORMAL);
 126         MailSender(AuctionEntry* sender);
 127     public:                                                 // Accessors
 128         /// The Messagetype of this MailSender.
 129         MailMessageType GetMailMessageType() const { return m_messageType; }
 130         /// The GUID of the player represented by this MailSender, or the Entry of the non-player object.
 131         uint32 GetSenderId() const { return m_senderId; }
 132         /// The stationary associated with this MailSender
 133         MailStationery GetStationery() const { return m_stationery; }
 134     private:
 135         MailMessageType m_messageType;
 136         uint32 m_senderId;                                  // player low guid or other object entry
 137         MailStationery m_stationery;
 138 };
 139 /**
 140  * A class to represent the receiver of a mail.
 141  */
 142 class MailReceiver
 143 {
 144     public:                                                 // Constructors
 145         explicit MailReceiver(uint32 receiver_lowguid) : m_receiver(NULL), m_receiver_lowguid(receiver_lowguid) {}
 146         MailReceiver(Player* receiver);
 147         MailReceiver(Player* receiver,uint32 receiver_lowguid);
 148     public:                                                 // Accessors
 149         /**
 150          * Gets the player associated with this MailReciever
 151          *
 152          * @see Player
 153          *
 154          * @returns a pointer to the Player this mail is for.
 155          *
 156          */
 157         Player* GetPlayer() const { return m_receiver; }
 158         /**
 159          * Gets the low part of the recievers GUID.
 160          *
 161          * @returns the low part of the GUID of the player associated with this MailReciever
 162          */
 163         uint32  GetPlayerGUIDLow() const { return m_receiver_lowguid; }
 164     private:
 165         Player* m_receiver;
 166         uint32  m_receiver_lowguid;
 167 };
 168 /**
 169  * The class to represent the draft of a mail.
 170  */
 171 class MailDraft
 172 {
 173     /**
 174      * Holds a Map of GUIDs of items and pointers to the items.
 175      */
 176        typedef std::map<uint32, Item*> MailItemMap;
 177
 178     public:                                                 // Constructors
 179                /**
 180                 * Creates a new MailDraft object.
 181                 *
 182                 * @param mailTemplateId The ID of the Template to be used.
 183                 * @param a boolean specifying whether the mail needs items or not.
 184                 *
 185                 */
 186         explicit MailDraft(uint16 mailTemplateId, bool need_items = true)
 187             : m_mailTemplateId(mailTemplateId), m_mailTemplateItemsNeed(need_items), m_bodyId(0), m_money(0), m_COD(0)
 188         {}
 189         /**
 190          * Creates a new MailDraft object.
 191          *
 192          * @param subject The subject of the mail.
 193          * @param itemTextId The id of the body of the mail.
 194          */
 195         MailDraft(std::string subject, uint32 itemTextId = 0)
 196             : m_mailTemplateId(0), m_mailTemplateItemsNeed(false), m_subject(subject), m_bodyId(itemTextId), m_money(0), m_COD(0) {}
 197     public:                                                 // Accessors
 198         /// Returns the template ID used for this MailDraft.
 199         uint16 GetMailTemplateId() const { return m_mailTemplateId; }
 200         /// Returns the subject of this MailDraft.
 201         std::string const& GetSubject() const { return m_subject; }
 202         /// Returns the ID of the text of this MailDraft.
 203         uint32 GetBodyId() const { return m_bodyId; }
 204         /// Returns the ammount of money in this MailDraft.
 205         uint32 GetMoney() const { return m_money; }
 206         /// Returns the Cost of delivery of this MailDraft.
 207         uint32 GetCOD() const { return m_COD; }
 208     public:                                                 // modifiers
 209         MailDraft& AddItem(Item* item);
 210         /**
 211          * Modifies the amount of money in a MailDraft.
 212          *
 213          * @param money The amount of money included in this MailDraft.
 214          */
 215         MailDraft& AddMoney(uint32 money) { m_money = money; return *this; }
 216         /**
 217          * Modifies the cost of delivery of the MailDraft.
 218          *
 219          * @param COD the amount to which the cod should be set.
 220          */
 221         MailDraft& AddCOD(uint32 COD) { m_COD = COD; return *this; }
 222     public:                                                 // finishers
 223         void SendReturnToSender(uint32 sender_acc, uint32 sender_guid, uint32 receiver_guid);
 224         void SendMailTo(MailReceiver const& receiver, MailSender const& sender, MailCheckMask checked = MAIL_CHECK_MASK_NONE, uint32 deliver_delay = 0);
 225     private:
 226         void deleteIncludedItems(bool inDB = false);
 227         void prepareItems(Player* receiver);                ///< called from SendMailTo for generate mailTemplateBase items
 228
 229         /// The ID of the template associated with this MailDraft.
 230         uint16      m_mailTemplateId;
 231         /// Boolean specifying whether items are required or not.
 232         bool        m_mailTemplateItemsNeed;
 233         /// The subject of the MailDraft.
 234         std::string m_subject;
 235         /// The ID of the body of the MailDraft.
 236         uint32      m_bodyId;
 237         /// A map of items in this MailDraft.
 238         MailItemMap m_items;                                ///< Keep the items in a map to avoid duplicate guids (which can happen), store only low part of guid
 239
 240         /// The amount of money in this MailDraft.
 241         uint32 m_money;
 242         /// The cod amount of this MailDraft.
 243         uint32 m_COD;
 244 };
 245 /**
 246  * Structure holding information about an item in the mail.
 247  */
 248 struct MailItemInfo
 249 {
 250     uint32 item_guid;                                       ///< the GUID of the item.
 251     uint32 item_template;                                   ///< the ID of the template of the item.
 252 };
 253 /**
 254  * Structure that holds an actual mail.
 255  */
 256 struct Mail
 257 {
 258     /// the ID of the message contained in the mail.
 259        uint32 messageID;
 260        /// the type of the message
 261     uint8 messageType;
 262     /// the stationary used in this mail.
 263     uint8 stationery;
 264     /// the ID of the template this mail is based on.
 265     uint16 mailTemplateId;
 266     /// the GUID of the player that sent this mail.
 267     uint32 sender;
 268     /// the GUID of the player that this mail is sent to.
 269     uint32 receiver;
 270     /// the subject of the mail
 271     std::string subject;
 272     /// The ID of the itemtext.
 273     uint32 itemTextId;
 274     /// A vector containing Information about the items in this mail.
 275     std::vector<MailItemInfo> items;
 276     /// A vector containing Information about the items that where already take from this mail.
 277     std::vector<uint32> removedItems;
 278     /// The time at which this mail will expire
 279     time_t expire_time;
 280     /// The time at which this mail (was/will be) delivered
 281     time_t deliver_time;
 282     /// The amount of money contained in this mail.
 283     uint32 money;
 284     /// The amount of money the receiver has to pay to get this mail.
 285     uint32 COD;
 286     /// The time at which this mail was read.
 287     uint32 checked;
 288     /// The state of this mail.
 289     MailState state;
 290
 291     /**
 292      * Adds an item to the mail.
 293      * This method adds an item to mail represented by this structure.
 294      * There is no checking done whether this is a legal action or not; it is up
 295      * to the caller to make sure there is still room for more items in the mail.
 296      *
 297      * @param itemGuidLow      the GUID(low) of the item added to the mail.
 298      * @param item_template the ID of the template of the item.
 299      *
 300      */
 301     void AddItem(uint32 itemGuidLow, uint32 item_template)
 302     {
 303         MailItemInfo mii;
 304         mii.item_guid = itemGuidLow;
 305         mii.item_template = item_template;
 306         items.push_back(mii);
 307     }
 308
 309     /**
 310      * Removes an item from the mail.
 311      * This method removes an item from the mail.
 312      *
 313      * @see MailItemInfo
 314      *
 315      * @param item_guid        The GUID of the item to be removed.
 316      * @returns true if the item was removed, or false if no item with that GUID was found.
 317      *
 318      */
 319     bool RemoveItem(uint32 item_guid)
 320     {
 321         for(std::vector<MailItemInfo>::iterator itr = items.begin(); itr != items.end(); ++itr)
 322         {
 323             if(itr->item_guid == item_guid)
 324             {
 325                 items.erase(itr);
 326                 return true;
 327             }
 328         }
 329         return false;
 330     }
 331
 332     /*
 333      * Checks whether a mail contains items or not.
 334      * HasItems() checks wether the mail contains items or not.
 335      *
 336      * @returns true if the mail contains items, false otherwise.
 337      *
 338      */
 339     bool HasItems() const { return !items.empty(); }
 340 };
 341
 342 #endif
 343 /*! @} */