MailMgr Class Reference

Owns the mail lifecycle bookkeeping that lives outside a single player session: the per-character mail count mirrored in CharacterCache and the cleanup of expired mail. More...

#include "MailMgr.h"

Public Member Functions
void	OnMailSent (ObjectGuid::LowType receiverLow)
	Reports a mail row inserted for a character.
void	OnMailDeleted (ObjectGuid::LowType receiverLow)
	Reports a mail row deleted from a character's mailbox.
void	OnMailReturned (ObjectGuid::LowType oldReceiverLow, ObjectGuid::LowType newReceiverLow)
	Reports a mail row handed to a new receiver (return to sender).
void	LoadMailCounts ()
	Recounts the mail of all characters from the database. Called once at startup after the character cache is filled.
void	RecountMailCount (ObjectGuid::LowType receiverLow)
	Recounts one character's mail from the database, overwriting the cached value.
void	DeleteEmptyExpiredMail (uint32 mailId, ObjectGuid::LowType receiverLow)
	Deletes an expired mail row that has no items, money or COD attached. Used at login for mail that would otherwise stay invisible in the DB until ReturnOrDeleteOldMails catches the receiver offline.
void	ReturnOrDeleteOldMails (bool serverUp)
	Returns expired mail with items to the sender and deletes the rest.

Static Public Member Functions
static MailMgr *	instance ()

Detailed Description

Owns the mail lifecycle bookkeeping that lives outside a single player session: the per-character mail count mirrored in CharacterCache and the cleanup of expired mail.

Every code path that inserts or deletes a row in the characters mail table must report it here, otherwise the cached count drifts until the next recount.

Member Function Documentation

DeleteEmptyExpiredMail()

void MailMgr::DeleteEmptyExpiredMail	(	uint32	mailId,
		ObjectGuid::LowType	receiverLow
	)

Deletes an expired mail row that has no items, money or COD attached. Used at login for mail that would otherwise stay invisible in the DB until ReturnOrDeleteOldMails catches the receiver offline.

Parameters

mailId	Id of the mail row to delete
receiverLow	Low GUID of the mail receiver

{
    CharacterDatabasePreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_DEL_MAIL_BY_ID);
    stmt->SetData(0, mailId);
    CharacterDatabase.Execute(stmt);
 
    OnMailDeleted(receiverLow);
}

References CHAR_DEL_MAIL_BY_ID, CharacterDatabase, OnMailDeleted(), and PreparedStatementBase::SetData().

instance()

MailMgr * MailMgr::instance ( )

static

{
    static MailMgr instance;
    return &instance;
}

References instance().

Referenced by instance().

LoadMailCounts()

void MailMgr::LoadMailCounts

(

)

Recounts the mail of all characters from the database. Called once at startup after the character cache is filled.

{
    QueryResult result = CharacterDatabase.Query("SELECT receiver, COUNT(receiver) FROM mail GROUP BY receiver");
    if (!result)
        return;
 
    do
    {
        Field* fields = result->Fetch();
        sCharacterCache->UpdateCharacterMailCount(ObjectGuid(HighGuid::Player, fields[0].Get<uint32>()), static_cast<int32>(fields[1].Get<uint64>()), true);
    } while (result->NextRow());
}

References CharacterDatabase, Player, and sCharacterCache.

OnMailDeleted()

void MailMgr::OnMailDeleted

(

ObjectGuid::LowType

receiverLow

)

Reports a mail row deleted from a character's mailbox.

Parameters

receiverLow

Low GUID of the mail receiver

{
    sCharacterCache->DecreaseCharacterMailCount(ObjectGuid(HighGuid::Player, receiverLow));
}

References Player, and sCharacterCache.

Referenced by DeleteEmptyExpiredMail(), and ReturnOrDeleteOldMails().

OnMailReturned()

void MailMgr::OnMailReturned	(	ObjectGuid::LowType	oldReceiverLow,
		ObjectGuid::LowType	newReceiverLow
	)

Reports a mail row handed to a new receiver (return to sender).

Parameters

oldReceiverLow	Low GUID of the previous receiver
newReceiverLow	Low GUID of the new receiver

{
    sCharacterCache->DecreaseCharacterMailCount(ObjectGuid(HighGuid::Player, oldReceiverLow));
    sCharacterCache->IncreaseCharacterMailCount(ObjectGuid(HighGuid::Player, newReceiverLow));
}

References Player, and sCharacterCache.

Referenced by ReturnOrDeleteOldMails().

OnMailSent()

void MailMgr::OnMailSent

(

ObjectGuid::LowType

receiverLow

)

Reports a mail row inserted for a character.

Parameters

receiverLow

Low GUID of the mail receiver

{
    sCharacterCache->IncreaseCharacterMailCount(ObjectGuid(HighGuid::Player, receiverLow));
}

References Player, and sCharacterCache.

RecountMailCount()

void MailMgr::RecountMailCount

(

ObjectGuid::LowType

receiverLow

)

Recounts one character's mail from the database, overwriting the cached value.

Parameters

receiverLow

Low GUID of the character to recount

{
    int32 count = 0;
    if (QueryResult result = CharacterDatabase.Query("SELECT COUNT(*) FROM mail WHERE receiver = {}", receiverLow))
        count = static_cast<int32>((*result)[0].Get<uint64>());
 
    sCharacterCache->UpdateCharacterMailCount(ObjectGuid(HighGuid::Player, receiverLow), count, true);
}

References CharacterDatabase, Player, and sCharacterCache.

ReturnOrDeleteOldMails()

void MailMgr::ReturnOrDeleteOldMails

(

bool

serverUp

)

Returns expired mail with items to the sender and deletes the rest.

Parameters

serverUp

When true, receivers that are currently online are skipped.

{
    uint32 oldMSTime = getMSTime();
 
    time_t curTime = GameTime::GetGameTime().count();
 
    CharacterDatabasePreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_SEL_EXPIRED_MAIL);
    stmt->SetData(0, uint32(curTime));
    PreparedQueryResult result = CharacterDatabase.Query(stmt);
    if (!result)
        return;
 
    std::map<uint32 /*messageId*/, MailItemInfoVec> itemsCache;
    stmt = CharacterDatabase.GetPreparedStatement(CHAR_SEL_EXPIRED_MAIL_ITEMS);
    stmt->SetData(0, uint32(curTime));
    if (PreparedQueryResult items = CharacterDatabase.Query(stmt))
    {
        MailItemInfo item;
        do
        {
            Field* fields = items->Fetch();
            item.item_guid = fields[0].Get<uint32>();
            item.item_template = fields[1].Get<uint32>();
            uint32 mailId = fields[2].Get<uint32>();
            itemsCache[mailId].push_back(item);
        } while (items->NextRow());
    }
 
    uint32 deletedCount = 0;
    uint32 returnedCount = 0;
    do
    {
        Field* fields = result->Fetch();
        Mail* m = new Mail;
        m->messageID      = fields[0].Get<uint32>();
        m->messageType    = fields[1].Get<uint8>();
        m->sender         = fields[2].Get<uint32>();
        m->receiver       = fields[3].Get<uint32>();
        bool has_items    = fields[4].Get<bool>();
        m->expire_time    = time_t(fields[5].Get<uint32>());
        m->deliver_time   = time_t(0);
        m->stationery     = fields[6].Get<uint8>();
        m->checked        = fields[7].Get<uint8>();
        m->mailTemplateId = fields[8].Get<int16>();
 
        Player* player = nullptr;
        if (serverUp)
            player = ObjectAccessor::FindPlayerByLowGUID(m->receiver);
 
        if (player) // don't modify mails of a logged in player
        {
            delete m;
            continue;
        }
 
        // Keep each mail's correlated writes atomic
        CharacterDatabaseTransaction trans = CharacterDatabase.BeginTransaction();
 
        // Delete or return mail
        if (has_items)
        {
            // read items from cache
            m->items.swap(itemsCache[m->messageID]);
 
            // If it is mail from non-player, or if it's already return mail, it shouldn't be returned, but deleted
            if (!m->IsSentByPlayer() || m->IsSentByGM() || (m->IsCODPayment() || m->IsReturnedMail()))
            {
                for (auto const& mailedItem : m->items)
                {
                    stmt = CharacterDatabase.GetPreparedStatement(CHAR_DEL_ITEM_INSTANCE);
                    stmt->SetData(0, mailedItem.item_guid);
                    trans->Append(stmt);
                }
 
                stmt = CharacterDatabase.GetPreparedStatement(CHAR_DEL_MAIL_ITEM_BY_ID);
                stmt->SetData(0, m->messageID);
                trans->Append(stmt);
            }
            else
            {
                // Mail will be returned
                stmt = CharacterDatabase.GetPreparedStatement(CHAR_UPD_MAIL_RETURNED);
                stmt->SetData(0, m->receiver);
                stmt->SetData(1, m->sender);
                stmt->SetData(2, uint32(curTime + 30 * DAY));
                stmt->SetData(3, uint32(curTime));
                stmt->SetData(4, uint8(MAIL_CHECK_MASK_RETURNED));
                stmt->SetData(5, m->messageID);
                trans->Append(stmt);
                for (auto const& mailedItem : m->items)
                {
                    // Update receiver in mail items for its proper delivery, and in instance_item for avoid lost item at sender delete
                    stmt = CharacterDatabase.GetPreparedStatement(CHAR_UPD_MAIL_ITEM_RECEIVER);
                    stmt->SetData(0, m->sender);
                    stmt->SetData(1, mailedItem.item_guid);
                    trans->Append(stmt);
 
                    stmt = CharacterDatabase.GetPreparedStatement(CHAR_UPD_ITEM_OWNER);
                    stmt->SetData(0, m->sender);
                    stmt->SetData(1, mailedItem.item_guid);
                    trans->Append(stmt);
                }
 
                CharacterDatabase.CommitTransaction(trans);
 
                OnMailReturned(m->receiver, m->sender);
 
                delete m;
                ++returnedCount;
                continue;
            }
        }
 
        stmt = CharacterDatabase.GetPreparedStatement(CHAR_DEL_MAIL_BY_ID);
        stmt->SetData(0, m->messageID);
        trans->Append(stmt);
 
        CharacterDatabase.CommitTransaction(trans);
 
        OnMailDeleted(m->receiver);
 
        delete m;
        ++deletedCount;
    } while (result->NextRow());
 
    LOG_INFO("server.loading", ">> Processed {} expired mails: {} deleted and {} returned in {} ms", deletedCount + returnedCount, deletedCount, returnedCount, GetMSTimeDiffToNow(oldMSTime));
    LOG_INFO("server.loading", " ");
}

References CHAR_DEL_ITEM_INSTANCE, CHAR_DEL_MAIL_BY_ID, CHAR_DEL_MAIL_ITEM_BY_ID, CHAR_SEL_EXPIRED_MAIL, CHAR_SEL_EXPIRED_MAIL_ITEMS, CHAR_UPD_ITEM_OWNER, CHAR_UPD_MAIL_ITEM_RECEIVER, CHAR_UPD_MAIL_RETURNED, CharacterDatabase, Mail::checked, DAY, Mail::deliver_time, Mail::expire_time, ObjectAccessor::FindPlayerByLowGUID(), Field::Get(), GameTime::GetGameTime(), getMSTime(), GetMSTimeDiffToNow(), Mail::IsCODPayment(), Mail::IsReturnedMail(), Mail::IsSentByGM(), Mail::IsSentByPlayer(), MailItemInfo::item_guid, MailItemInfo::item_template, Mail::items, LOG_INFO, MAIL_CHECK_MASK_RETURNED, Mail::mailTemplateId, Mail::messageID, Mail::messageType, OnMailDeleted(), OnMailReturned(), Mail::receiver, Mail::sender, PreparedStatementBase::SetData(), and Mail::stationery.

---

The documentation for this class was generated from the following files:

• azerothcore-wotlk/src/server/game/Mails/MailMgr.h
• azerothcore-wotlk/src/server/game/Mails/MailMgr.cpp