destiny-2-Sunrise/Sunrise/src/client/content/items/packages/package_season_pass_build.cpp

#include <algorithm>
#include <limits>

#include "../../../../core/logging/log.h"
#include "../../../../middleware/content/packages/tables/field_reader.h"
#include "../../../../state/build_data/season_pass/season_pass_catalog.h"
#include "../../../../state/progression/season_pass_reward_catalog.h"
#include "internal.h"
#include "package_reward_build.h"

namespace sunrise::client::content::items::packages {
namespace {

namespace domain = state::build_data::season_pass;

/**
 * Reads one pass row: item, rank, quantity and claim flag, then its sockets and conditions.
 * @return False when any field is unreadable or out of range.
 */
bool read_season_reward(Storage& storage,
                        std::span<const std::byte> progressionTable,
                        const tables::Array& itemRows,
                        std::size_t at,
                        domain::Reward& reward) noexcept {
    std::uint32_t rank = 0;
    std::uint32_t itemIndex = 0;
    std::uint32_t claimSlot = 0;
    if (!tables::read(progressionTable, at + tables::kProgressionRewardRankOffset, rank)
        || !tables::read(
            progressionTable, at + tables::kProgressionRewardItemIndexOffset, itemIndex)
        || !tables::read(
            progressionTable, at + tables::kProgressionRewardQuantityOffset, reward.quantity)
        || !tables::read(
            progressionTable, at + tables::kProgressionRewardClaimSlotOffset, claimSlot)) {
        return false;
    }

    // Native fields are 32-bit, the stored row keeps the narrower native index widths.
    tables::IndexRow entry{};
    if (rank > (std::numeric_limits<std::uint8_t>::max)()
        || itemIndex > (std::numeric_limits<std::uint16_t>::max)()
        || claimSlot > (std::numeric_limits<std::uint16_t>::max)()
        || !tables::index_row(storage.itemIndexTable, itemRows, itemIndex, entry)) {
        return false;
    }
    reward.itemHash = entry.definitionHash;
    reward.itemIndex = static_cast<std::uint16_t>(itemIndex);
    reward.requiredRank = static_cast<std::uint8_t>(rank);

    // A reward with no claim flag carries slot 0, any other slot must map to the account bank.
    if (claimSlot != 0) {
        reward.claimFlagIndex =
            bank_index(storage.slotMaps.accountFlag, static_cast<std::int32_t>(claimSlot));
        if (reward.claimFlagIndex == domain::kUnavailableFlagIndex) {
            return false;
        }
    }

    std::size_t socketCount = 0;
    std::size_t conditionCount = 0;
    if (!read_reward_sockets(progressionTable,
                             at + tables::kProgressionRewardSocketsOffset,
                             reward.sockets,
                             socketCount)
        || !storage.rewardBuild.conditions.read_list(
            progressionTable,
            at + tables::kProgressionRewardConditionsOffset,
            reward.condition,
            conditionCount)) {
        return false;
    }
    reward.socketCount = static_cast<std::uint8_t>(socketCount);
    reward.conditionCount = static_cast<std::uint8_t>(conditionCount);
    return domain::valid(std::span(&reward, 1))
           && std::all_of(reward.sockets.begin(),
                          reward.sockets.begin() + reward.socketCount,
                          [&itemRows](const state::build_data::rewards::SocketOverride& socket) {
                              return state::build_data::rewards::valid_socket(socket,
                                                                              itemRows.count);
                          });
}

} // namespace

/**
 * Reads the season pass reward list in native order, which the opcode-2400 claim indexes.
 * A row that fails to read is kept as an unavailable row so later claim indices stay aligned.
 * @param source Installed package source.
 * @param storage Pass storage receiving the reward rows.
 * @param root Investment root bytes.
 * @return True when the reward list read and produced at least one row.
 */
bool build_season_pass(const reader::Source& source,
                       Storage& storage,
                       std::span<const std::byte> root) noexcept {
    storage.seasonPassRewardCount = 0;

    std::uint32_t itemTableTag = 0;
    tables::Array itemRows{};
    if (!tables::slot_tag(root, tables::kItemTableSlot, itemTableTag) || itemTableTag == 0
        || !reader::read_tag(source, storage.scratch, itemTableTag, storage.itemIndexTable)
        || !tables::find_array_at(std::span<const std::byte>{storage.itemIndexTable},
                                  tables::kTableArrayDescriptor,
                                  itemRows)
        || itemRows.elementClass != tables::kItemIndexTableClass) {
        return false;
    }

    std::uint32_t tableTag = 0;
    tables::Array progressions{};
    if (!tables::slot_tag(root, tables::kProgressionTableSlot, tableTag) || tableTag == 0
        || !reader::read_tag(source, storage.scratch, tableTag, storage.progressionTable)
        || !tables::find_array_at(std::span<const std::byte>{storage.progressionTable},
                                  tables::kTableArrayDescriptor,
                                  progressions)
        || progressions.elementClass != tables::kProgressionTableClass
        || progressions.count <= state::progression::season_pass::kProgressionDefinitionIndex) {
        return false;
    }
    const std::span<const std::byte> progressionTable{storage.progressionTable};
    const std::size_t passAt = progressions.dataOffset
                               + state::progression::season_pass::kProgressionDefinitionIndex
                                     * tables::kProgressionRowStride;
    tables::Array rewards{};
    if (!tables::read_array(progressionTable,
                            passAt + tables::kProgressionRewardField,
                            tables::kProgressionRewardRowClass,
                            tables::kProgressionRewardStride,
                            rewards)
        || rewards.count == 0 || rewards.count > domain::kRewardCapacity) {
        return false;
    }

    std::size_t skipped = 0;
    for (std::uint64_t row = 0; row < rewards.count; ++row) {
        const std::size_t at =
            rewards.dataOffset + static_cast<std::size_t>(row) * tables::kProgressionRewardStride;
        auto& reward = storage.seasonPassRewards[row];
        reward = {};
        if (!read_season_reward(storage, progressionTable, itemRows, at, reward)) {
            reward = {};
            ++skipped;
        }
    }
    if (skipped != 0) {
        core::log::writef(core::log::Channel::client,
                          core::log::Level::warn,
                          "ev=pkg stage=season_pass skipped=%zu",
                          skipped);
    }
    storage.seasonPassRewardCount = static_cast<std::size_t>(rewards.count);
    return storage.seasonPassRewardCount != 0;
}

} // namespace sunrise::client::content::items::packages