ClientBuildInfo.cpp

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "ClientBuildInfo.h"
#include "DatabaseEnv.h"
#include "Log.h"
#include "Util.h"
#include <algorithm>
#include <cctype>
 
namespace
{
std::vector<ClientBuild::Info> Builds;
}
 
namespace ClientBuild
{
std::array<char, 5> ToCharArray(uint32 value)
{
    auto normalize = [](uint8 c) -> char
    {
        if (!c || std::isprint(c))
            return char(c);
        return ' ';
    };
 
    std::array<char, 5> chars = { char((value >> 24) & 0xFF), char((value >> 16) & 0xFF), char((value >> 8) & 0xFF), char(value & 0xFF), '\0' };
 
    auto firstNonZero = std::ranges::find_if(chars, [](char c) { return c != '\0'; });
    if (firstNonZero != chars.end())
    {
        // move leading zeros to end
        std::rotate(chars.begin(), firstNonZero, chars.end());
 
        // ensure we only have printable characters remaining
        std::ranges::transform(chars, chars.begin(), normalize);
    }
 
    return chars;
}
 
bool Platform::IsValid(std::string_view platform)
{
    if (platform.length() > sizeof(uint32))
        return false;
 
    switch (ToFourCC(platform))
    {
        case Win_x86:
        case Win_x64:
        case Win_arm64:
        case Mac_x86:
        case Mac_x64:
        case Mac_arm64:
            return true;
        default:
            break;
    }
 
    return false;
}
 
bool PlatformType::IsValid(std::string_view platformType)
{
    if (platformType.length() > sizeof(uint32))
        return false;
 
    switch (ToFourCC(platformType))
    {
        case Windows:
        case macOS:
            return true;
        default:
            break;
    }
 
    return false;
}
 
bool Arch::IsValid(std::string_view arch)
{
    if (arch.length() > sizeof(uint32))
        return false;
 
    switch (ToFourCC(arch))
    {
        case x86:
        case x64:
        case Arm32:
        case Arm64:
        case WA32:
            return true;
        default:
            break;
    }
 
    return false;
}
 
bool Type::IsValid(std::string_view type)
{
    if (type.length() > sizeof(uint32))
        return false;
 
    switch (ToFourCC(type))
    {
        case Retail:
        case RetailChina:
        case Beta:
        case BetaRelease:
        case Ptr:
        case PtrRelease:
            return true;
        default:
            break;
    }
 
    return false;
}
 
void LoadBuildInfo()
{
    Builds.clear();
 
    //                                                              0             1              2              3      4
    if (QueryResult result = LoginDatabase.Query("SELECT majorVersion, minorVersion, bugfixVersion, hotfixVersion, build FROM build_info ORDER BY build ASC"))
    {
        do
        {
            Field* fields = result->Fetch();
            Info& build = Builds.emplace_back();
            build.MajorVersion = fields[0].GetUInt32();
            build.MinorVersion = fields[1].GetUInt32();
            build.BugfixVersion = fields[2].GetUInt32();
            std::string_view hotfixVersion = fields[3].GetStringView();
            if (hotfixVersion.length() < build.HotfixVersion.size())
                std::ranges::copy(hotfixVersion, build.HotfixVersion.begin());
            else
                build.HotfixVersion = { };
 
            build.Build = fields[4].GetUInt32();
 
        } while (result->NextRow());
    }
 
    //                                                        0           1       2       3      4
    if (QueryResult result = LoginDatabase.Query("SELECT `build`, `platform`, `arch`, `type`, `key` FROM `build_auth_key`"))
    {
        do
        {
            Field* fields = result->Fetch();
 
            uint32 build = fields[0].GetInt32();
            auto buildInfo = std::ranges::find(Builds, build, &Info::Build);
            if (buildInfo == Builds.end())
            {
                TC_LOG_ERROR("sql.sql", "ClientBuild::LoadBuildInfo: Unknown `build` {} in `build_auth_key` - missing from `build_info`, skipped.", build);
                continue;
            }
 
            std::string_view platformType = fields[1].GetStringView();
            if (!PlatformType::IsValid(platformType))
            {
                TC_LOG_ERROR("sql.sql", "ClientBuild::LoadBuildInfo: Invalid platform {} for `build` {} in `build_auth_key`, skipped.", platformType, build);
                continue;
            }
 
            std::string_view arch = fields[2].GetStringView();
            if (!Arch::IsValid(arch))
            {
                TC_LOG_ERROR("sql.sql", "ClientBuild::LoadBuildInfo: Invalid `arch` {} for `build` {} in `build_auth_key`, skipped.", arch, build);
                continue;
            }
 
            std::string_view type = fields[3].GetStringView();
            if (!Type::IsValid(type))
            {
                TC_LOG_ERROR("sql.sql", "ClientBuild::LoadBuildInfo: Invalid `type` {} for `build` {} in `build_auth_key`, skipped.", type, build);
                continue;
            }
 
            AuthKey& buildKey = buildInfo->AuthKeys.emplace_back();
            buildKey.Variant = { .Platform = ToFourCC(platformType), .Arch = ToFourCC(arch), .Type = ToFourCC(type) };
            buildKey.Key = fields[4].GetBinary<AuthKey::Size>();
 
        } while (result->NextRow());
    }
}
 
Info const* GetBuildInfo(uint32 build)
{
    auto buildInfo = std::ranges::find(Builds, build, &Info::Build);
    return buildInfo != Builds.end() ? &*buildInfo : nullptr;
}
 
uint32 GetMinorMajorBugfixVersionForBuild(uint32 build)
{
    auto buildInfo = std::ranges::lower_bound(Builds, build, {}, &Info::Build);
    return buildInfo != Builds.end() ? (buildInfo->MajorVersion * 10000 + buildInfo->MinorVersion * 100 + buildInfo->BugfixVersion) : 0;
}
}