GroupDb Namespace Reference

Typedefs
typedef std::map< int, GroupInfo * >	GroupInfos
typedef GroupInfos::iterator	GroupInfosIter

Functions
void	load ()
void	unload ()
void	loadXmlFile (const std::string &fileName, const SkipError skipError)
const std::string &	getName (const int id)
const std::string &	getLongName (const int id)
bool	getShowBadge (const int id)
bool	getHighlightName (const int id)
const std::string &	getBadge (const int id)
const GroupInfo *	getGroup (const int id)
bool	isAllowCommand (const ServerCommandTypeT command)

Typedef Documentation

GroupInfos

typedef std::map<int, GroupInfo*> GroupDb::GroupInfos

Definition at line 52 of file groupdb.h.

GroupInfosIter

typedef GroupInfos::iterator GroupDb::GroupInfosIter

Definition at line 53 of file groupdb.h.

Function Documentation

getBadge()

const std::string & GroupDb::getBadge

(

const int

id

)

Definition at line 388 of file groupdb.cpp.

{
    GroupInfos::const_iterator it = mGroups.find(id);
    if (it == mGroups.end())
    {
        reportAlways("Unknown group id requested: %d", id)
        return mEmptyGroup.badge;
    }
    return (*it).second->badge;
}

References GroupInfo::badge, anonymous_namespace{groupdb.cpp}::mEmptyGroup, anonymous_namespace{groupdb.cpp}::mGroups, and reportAlways.

Referenced by Being::showGmBadge().

getGroup()

const GroupInfo * GroupDb::getGroup

(

const int

id

)

Definition at line 399 of file groupdb.cpp.

{
    GroupInfos::const_iterator it = mGroups.find(id);
    if (it == mGroups.end())
    {
        reportAlways("Unknown group id requested: %d", id)
        return &mEmptyGroup;
    }
    return (*it).second;
}

References anonymous_namespace{groupdb.cpp}::mEmptyGroup, anonymous_namespace{groupdb.cpp}::mGroups, and reportAlways.

Referenced by PopupMenu::initPopup(), and isAllowCommand().

getHighlightName()

bool GroupDb::getHighlightName

(

const int

id

)

Definition at line 377 of file groupdb.cpp.

{
    GroupInfos::const_iterator it = mGroups.find(id);
    if (it == mGroups.end())
    {
        reportAlways("Unknown group id requested: %d", id)
        return mEmptyGroup.highlightName;
    }
    return (*it).second->highlightName;
}

References GroupInfo::highlightName, anonymous_namespace{groupdb.cpp}::mEmptyGroup, anonymous_namespace{groupdb.cpp}::mGroups, and reportAlways.

Referenced by Being::setGroupId(), and OnlinePlayer::setText().

getLongName()

const std::string & GroupDb::getLongName

(

const int

id

)

Definition at line 355 of file groupdb.cpp.

{
    GroupInfos::const_iterator it = mGroups.find(id);
    if (it == mGroups.end())
    {
        reportAlways("Unknown group id requested: %d", id)
        return mEmptyGroup.longName;
    }
    return (*it).second->longName;
}

References GroupInfo::longName, anonymous_namespace{groupdb.cpp}::mEmptyGroup, anonymous_namespace{groupdb.cpp}::mGroups, and reportAlways.

Referenced by BeingPopup::show().

getName()

const std::string & GroupDb::getName

(

const int

id

)

Definition at line 344 of file groupdb.cpp.

{
    GroupInfos::const_iterator it = mGroups.find(id);
    if (it == mGroups.end())
    {
        reportAlways("Unknown group id requested: %d", id)
        return mEmptyGroup.name;
    }
    return (*it).second->name;
}

References anonymous_namespace{groupdb.cpp}::mEmptyGroup, anonymous_namespace{groupdb.cpp}::mGroups, GroupInfo::name, and reportAlways.

Referenced by ItemDB::getNamesStr(), EAthena::HomunculusRecv::processHomunculusFood(), EAthena::PartyRecv::processPartyInfo(), TmwAthena::PartyRecv::processPartyInfo(), Graphics::setMainFlags(), OnlinePlayer::setText(), and StatusWindow::updateLevelLabel().

getShowBadge()

bool GroupDb::getShowBadge

(

const int

id

)

Definition at line 366 of file groupdb.cpp.

{
    GroupInfos::const_iterator it = mGroups.find(id);
    if (it == mGroups.end())
    {
        reportAlways("Unknown group id requested: %d", id)
        return mEmptyGroup.showBadge;
    }
    return (*it).second->showBadge;
}

References anonymous_namespace{groupdb.cpp}::mEmptyGroup, anonymous_namespace{groupdb.cpp}::mGroups, reportAlways, and GroupInfo::showBadge.

Referenced by OnlinePlayer::setText(), and Being::showGmBadge().

isAllowCommand()

bool GroupDb::isAllowCommand

(

const ServerCommandTypeT

command

)

Definition at line 410 of file groupdb.cpp.

{
    if (localPlayer == nullptr)
        return false;
    const int groupId = localPlayer->getGroupId();
    const GroupInfo *const group = GroupDb::getGroup(groupId);
 
#ifdef TMWA_SUPPORT
    // allow any commands for legacy if group > 0
    if (Net::getNetworkType() == ServerType::TMWATHENA &&
        localPlayer->isGM())
    {
        return true;
    }
#endif
    if (group->mPermissions[CAST_SIZE(ServerPermissionType::all_commands)] ==
        Enable_true)
    {
        return true;
    }
    const ServerCommandEnable::Type enabled =
        group->mCommands[CAST_SIZE(command)];
    return (enabled & ServerCommandEnable::Self) != 0;
}

References CAST_SIZE, Enable_true, getGroup(), Being::getGroupId(), Net::getNetworkType(), Being::isGM(), localPlayer, GroupInfo::mCommands, GroupInfo::mPermissions, ServerCommandEnable::Self, and ServerType::TMWATHENA.

Referenced by DialogsManager::playerDeath().

load()

void GroupDb::load

(

)

Definition at line 46 of file groupdb.cpp.

{
    if (mLoaded)
        unload();
 
    logger->log1("Initializing group database...");
 
    loadXmlFile(paths.getStringValue("groupsFile"), SkipError_false);
    loadXmlFile(paths.getStringValue("groupsPatchFile"), SkipError_true);
    loadXmlDir("groupsPatchDir", loadXmlFile)
    mLoaded = true;
}

References Configuration::getStringValue(), loadXmlDir, loadXmlFile(), Logger::log1(), logger, anonymous_namespace{groupdb.cpp}::mLoaded, paths, SkipError_false, SkipError_true, and Net::unload().

Referenced by DbManager::loadDb().

loadXmlFile()

void GroupDb::loadXmlFile	(	const std::string &	fileName,
		const SkipError	skipError
	)

Definition at line 256 of file groupdb.cpp.

{
    XML::Document doc(fileName,
        UseVirtFs_true,
        skipError);
    XmlNodeConstPtrConst rootNode = doc.rootNode();
 
    if (rootNode == nullptr ||
        !xmlNameEqual(rootNode, "groups"))
    {
        if (skipError == SkipError_true)
        {
            logger->log("GroupsDb: Error while loading %s!",
                fileName.c_str());
        }
        else
        {
            reportAlways("GroupsDb: Error while loading %s!",
                fileName.c_str())
        }
        return;
    }
 
    for_each_xml_child_node(node, rootNode)
    {
        if (xmlNameEqual(node, "include"))
        {
            const std::string name = XML::getProperty(node, "name", "");
            if (!name.empty())
                loadXmlFile(name, skipError);
            continue;
        }
        if (xmlNameEqual(node, "group"))
        {
            const int id = XML::getProperty(node,
                "id",
                -1);
            if (id < 0)
            {
                reportAlways("Empty id field in GroupDb")
                continue;
            }
            GroupInfosIter it = mGroups.find(id);
            GroupInfo *group = nullptr;
            if (it != mGroups.end())
            {
                reportAlways("GroupDb: group with id %d already added",
                    id)
                group = (*it).second;
            }
            else
            {
                group = new GroupInfo;
                mGroups[id] = group;
            }
            group->name = XML::langProperty(node,
                "name",
                "");
            group->longName = XML::langProperty(node,
                "longName",
                "");
            group->badge = XML::langProperty(node,
                "badge",
                paths.getStringValue("gmbadge"));
            group->showBadge = XML::getBoolProperty(node,
                "showBadge",
                false);
            group->highlightName = XML::getBoolProperty(node,
                "highlightName",
                false);
            loadSubNodes(node, id, group);
            parseInherit(node, id, group);
        }
    }
}

References GroupInfo::badge, fileName, for_each_xml_child_node, XML::getBoolProperty(), XML::getProperty(), Configuration::getStringValue(), GroupInfo::highlightName, XML::langProperty(), loadSubNodes(), loadXmlFile(), Logger::log(), logger, GroupInfo::longName, anonymous_namespace{groupdb.cpp}::mGroups, GroupInfo::name, parseInherit(), paths, reportAlways, XML::Document::rootNode(), GroupInfo::showBadge, SkipError_true, and UseVirtFs_true.

unload()

void GroupDb::unload

(

)

Definition at line 333 of file groupdb.cpp.

{
    logger->log1("Unloading group database...");
    FOR_EACH (GroupInfosIter, it, mGroups)
    {
        delete (*it).second;
    }
    mGroups.clear();
    mLoaded = false;
}

References FOR_EACH, Logger::log1(), logger, anonymous_namespace{groupdb.cpp}::mGroups, and anonymous_namespace{groupdb.cpp}::mLoaded.

Referenced by DbManager::unloadDb().