ClassicAPI/src/unit/Flags.cpp

// This file is part of ClassicAPI.
//
// ClassicAPI 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 3 of the License, or (at your option) any later version.
//
// ClassicAPI 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
// ClassicAPI. If not, see <https://www.gnu.org/licenses/>.

#include "Flags.h"

#include "Game.h"
#include "Offsets.h"

#include <cstdint>
#include <cstdio>
#include <cstring>

namespace Unit::Flags {

bool IsPlayerControlled(const uint8_t *unit) {
    if (unit == nullptr)
        return false;
    auto *fields = *reinterpret_cast<const uint8_t *const *>(
        unit + Offsets::OFF_UNIT_DESCRIPTOR);
    if (fields == nullptr)
        return false;
    const uint32_t unitFlags = *reinterpret_cast<const uint32_t *>(
        fields + Offsets::OFF_UNIT_FIELD_FLAGS);
    return (unitFlags & Offsets::UNIT_FLAG_PLAYER_CONTROLLED) != 0;
}

bool IsPlayerObject(const uint8_t *unit) {
    if (unit == nullptr)
        return false;
    return *reinterpret_cast<const int *>(unit + Offsets::OFF_CGOBJECT_TYPE_ID) ==
           Offsets::OBJECT_TYPE_PLAYER;
}

namespace {

using ResolveUnitToken_t = void *(__fastcall *)(const char *token);

// Reads a PLAYER_FLAGS bit for a player. Path:
//   - Resolve unit; gate on the object actually being a player
//     (`OBJECT_TYPE_PLAYER`) so we never read the +0xE68 CGPlayer
//     sub-struct on a non-player object. UNIT_FLAG_PLAYER_CONTROLLED is
//     insufficient — pets/totems/MC'd creatures set it but have no
//     sub-struct there.
//   - Read `[unit + 0xE68] + 0x08` — the unit's CGPlayer-side info
//     struct, where byte +0x08 is PLAYER_FLAGS. Same struct
//     `Script_IsResting` reads at +0x05 bit (RESTING = 0x20) for the
//     local player; same struct the nameplate AFK-rendering code at
//     `0x005EC9E0` reads at bit 1 (AFK = 0x02) for **any** unit being
//     rendered. PLAYER_FLAGS lives here for all players — local and
//     remote — even though it's not in the broadcast UpdateField data.
//
// The `[unit + 0xE68]` pointer is the same one the visible-items
// helper (`FUN_UNIT_GET_VISIBLE_ITEM`) walks at offset `+0x118 +
// slot*0x30`; it's a CGPlayer-specific sub-struct that's allocated
// for any player-controlled unit, with PLAYER_FLAGS at +0x08 and
// visible-items table at +0x118.
bool TestPlayerFlag(void *L, uint32_t flagMask) {
    if (!Game::Lua::IsString(L, 1))
        return false;
    const char *token = Game::Lua::ToString(L, 1);
    if (token == nullptr)
        return false;

    auto resolve = reinterpret_cast<ResolveUnitToken_t>(Offsets::FUN_RESOLVE_UNIT_TOKEN);
    auto *unit = static_cast<const uint8_t *>(resolve(token));
    // PLAYER_FLAGS lives in the CGPlayer sub-struct — gate on the object
    // actually being a player, not merely player-controlled (pets/totems
    // set that flag but have no sub-struct → garbage +0xE68 deref).
    if (!IsPlayerObject(unit))
        return false;

    auto *playerInfo = *reinterpret_cast<const uint8_t *const *>(
        unit + Offsets::OFF_CGPLAYER_INFO);
    if (playerInfo == nullptr)
        return false;
    const uint32_t flags = *reinterpret_cast<const uint32_t *>(
        playerInfo + Offsets::OFF_PLAYER_INFO_FLAGS);
    return (flags & flagMask) != 0;
}

// `UnitIsAFK(unit)` — returns true if the unit is currently AFK
// (toggled via `/afk` or auto-set after idle timeout). Works for any
// player-controlled unit (player, target, party*, raid*, etc.). NPCs
// always return false.
int __fastcall Script_UnitIsAFK(void *L) {
    Game::Lua::PushBool(L, TestPlayerFlag(L, Offsets::PLAYER_FLAG_AFK));
    return 1;
}

// `UnitIsDND(unit)` — returns true if the unit is currently DND
// ("Do Not Disturb", toggled via `/dnd`). Same unit-token coverage as
// `UnitIsAFK`.
int __fastcall Script_UnitIsDND(void *L) {
    Game::Lua::PushBool(L, TestPlayerFlag(L, Offsets::PLAYER_FLAG_DND));
    return 1;
}

// `UnitIsFeignDeath(unit)` — returns true if the unit is feigning
// death (Hunter's `Feign Death`). Reads `UNIT_FIELD_FLAGS` bit 29
// (`0x20000000`) directly off the unit's m_objectFields descriptor.
// Unlike AFK/DND, this works for any unit token because
// UNIT_FIELD_FLAGS is broadcast in object updates — anyone watching
// the hunter sees the flag set.
int __fastcall Script_UnitIsFeignDeath(void *L) {
    if (!Game::Lua::IsString(L, 1)) {
        Game::Lua::Error(L, "Usage: UnitIsFeignDeath(\"unit\")");
        return 0;
    }
    const char *token = Game::Lua::ToString(L, 1);
    if (token == nullptr) {
        Game::Lua::PushBool(L, 0);
        return 1;
    }

    auto resolve = reinterpret_cast<ResolveUnitToken_t>(Offsets::FUN_RESOLVE_UNIT_TOKEN);
    auto *unit = static_cast<const uint8_t *>(resolve(token));
    if (unit == nullptr) {
        Game::Lua::PushBoolean(L, 0);
        return 1;
    }
    auto *fields = *reinterpret_cast<const uint8_t *const *>(
        unit + Offsets::OFF_UNIT_DESCRIPTOR);
    if (fields == nullptr) {
        Game::Lua::PushBoolean(L, 0);
        return 1;
    }
    const uint32_t unitFlags = *reinterpret_cast<const uint32_t *>(
        fields + Offsets::OFF_UNIT_FIELD_FLAGS);
    Game::Lua::PushBoolean(L,
        (unitFlags & Offsets::UNIT_FLAG_FEIGN_DEATH) != 0);
    return 1;
}

// Reads `[unit + 0xE68 + 0x0C]` (the CGPlayer sub-struct's guild-key
// field) with all the safety gates needed for arbitrary unit tokens.
// Returns 0 if the unit isn't player-controlled, isn't a player, or
// hasn't had its guild data synced.
uint32_t ReadGuildKey(const uint8_t *unit) {
    // The guild key lives in the CGPlayer sub-struct at +0xE68, which
    // only exists on real player objects. A player-controlled *creature*
    // (pet, totem, MC'd mob) has UNIT_FLAG_PLAYER_CONTROLLED set but no
    // sub-struct, so gating on IsPlayerControlled here would deref garbage
    // and crash (issue: UnitIsInMyGuild on a nameplate pet/totem).
    if (!IsPlayerObject(unit))
        return 0;
    auto *info = *reinterpret_cast<const uint8_t *const *>(
        unit + Offsets::OFF_CGPLAYER_INFO);
    if (info == nullptr)
        return 0;
    return *reinterpret_cast<const uint32_t *>(
        info + Offsets::OFF_PLAYER_INFO_GUILD_KEY);
}

using TokenToGUID_t = uint64_t(__fastcall *)(const char *token);
using PlayerInfoLookup_t = const uint8_t *(__thiscall *)(
    void *cache, uint32_t guidLo, uint32_t guidHi, uint64_t *cookie,
    void *callback, void *userData, int retryFlag);

using ResolveObjectByGuid_t = void *(__fastcall *)(int typeMask,
                                                   const char *debugName,
                                                   uint32_t guidLo,
                                                   uint32_t guidHi,
                                                   int priority);

// Resolve a GUID to its live CGUnit / CGPlayer object, or nullptr if
// the object isn't currently loaded. Unlike a unit-*token* resolve
// (`FUN_RESOLVE_UNIT_TOKEN`), this takes the GUID directly, so it works
// for any GUID `FUN_TOKEN_TO_GUID` produced — including `focus` /
// `nameplateN` — and never raises. The type arg is a bitmask of
// `(1 << objectType)`; `FUN_OBJECT_RESOLVE_BY_GUID` keeps the object
// only if its type flags intersect the mask, so unit|player matches a
// player, a pet, or an MC'd creature in one call.
const uint8_t *ResolveUnitOrPlayerByGuid(uint64_t guid) {
    if (guid == 0)
        return nullptr;
    constexpr int kUnitOrPlayerMask =
        (1 << Offsets::OBJECT_TYPE_UNIT) | (1 << Offsets::OBJECT_TYPE_PLAYER);
    auto fn = reinterpret_cast<ResolveObjectByGuid_t>(
        Offsets::FUN_OBJECT_RESOLVE_BY_GUID);
    return static_cast<const uint8_t *>(
        fn(kUnitOrPlayerMask, "UnitIsInMyGuild",
           static_cast<uint32_t>(guid), static_cast<uint32_t>(guid >> 32), 0));
}

// Resolves a player GUID to its character name via
// `FUN_PLAYER_INFO_LOOKUP` with a NULL callback — a pure NameCache
// read that returns the entry block for any GUID the engine has seen a
// `SMSG_NAME_QUERY_RESPONSE` for (same path `GetPlayerInfoByGUID`
// uses). This is the OOR-safe fallback: it works for a raid member in
// another zone whose CGUnit isn't loaded.
//
// Returns `nameBuf` on success (copied out — the entry's name pointer
// isn't guaranteed stable across reentrant cache writes), or nullptr
// when the GUID isn't a player the engine has name-queried (NPC GUID,
// or not yet queried).
const char *NameFromGuid(uint64_t guid, char (&nameBuf)[64]) {
    if (guid == 0)
        return nullptr;

    auto lookup = reinterpret_cast<PlayerInfoLookup_t>(
        Offsets::FUN_PLAYER_INFO_LOOKUP);
    auto *cache = reinterpret_cast<void *>(
        static_cast<uintptr_t>(Offsets::VAR_PLAYER_NAME_CACHE));
    uint64_t cookie = 0;
    const uint8_t *entry = lookup(cache,
                                  static_cast<uint32_t>(guid),
                                  static_cast<uint32_t>(guid >> 32),
                                  &cookie, nullptr, nullptr, 0);
    if (entry == nullptr)
        return nullptr;

    std::snprintf(nameBuf, sizeof(nameBuf), "%s",
                  reinterpret_cast<const char *>(
                      entry + Offsets::OFF_PLAYER_INFO_NAME));
    return nameBuf;
}

// `UnitIsInMyGuild(unitOrName)` — returns `1` if the unit/character
// shares the player's guild, `nil` otherwise. Accepts either a unit
// token (e.g. `"player"`, `"target"`, `"party1"`) or a literal
// character name (e.g. `"Bob"`), matching 3.3.5's
// `Script_UnitIsInMyGuild` (`0x0060C4B0`).
//
// Resolution strategy, in order:
//
// 1. Get the local player's guild key. If 0, the player isn't in any
//    guild — short-circuit to nil.
//
// 2. Fast path: if the input resolves to a `CGUnit *` (visible/loaded
//    unit) and that unit has a synced guild-key field, compare
//    directly. Works without a populated roster — `GetGuildInfo`
//    reads the same field. Covers the most common cases (player,
//    target, party/raid members in range, etc.).
//
// 3. Slow path: resolve the input to a name and walk the engine's
//    guild roster array comparing names. For tokens, the name comes
//    from `FUN_TOKEN_TO_GUID` + the engine's player NameCache
//    (`FUN_PLAYER_INFO_LOOKUP`) — handles OOR raid members in
//    another zone. For literal names, the input is used directly.
//    Requires `GuildRoster()` to have been called.
//
// In 3.3.5 the engine resolves the input to a 64-bit GUID via
// `0x0060ABF0` (token-prefix dispatch with NameCache fallback) and
// then checks GUID membership via `0x00512A00`. 1.12's guild roster
// entries don't store GUIDs — they're name-keyed — so the slow path
// falls back to strcmp. Same end result in vanilla since character
// names are unique per-realm.
//
// Return convention matches 3.3.5: `1.0`/`nil`, not boolean —
// 3.3.5's `Script_UnitIsInMyGuild` pushes via `lua_pushnumber(1.0)`
// (`0x0060C530`) and `lua_pushnil` (`0x0060C515`), never
// `lua_pushboolean`.
//
// The slow path reads `VAR_GUILD_ROSTER_TOTAL_COUNT` (the same
// underlying global `GetNumGuildMembers(true)` returns), not the
// online-only count, so offline guildmates resolve too —
// the "show offline" UI toggle doesn't affect lookup.
int __fastcall Script_UnitIsInMyGuild(void *L) {
    if (!Game::Lua::IsString(L, 1)) {
        Game::Lua::Error(L, "Usage: UnitIsInMyGuild(\"unitOrName\")");
        return 0;
    }
    const char *input = Game::Lua::ToString(L, 1);
    if (input == nullptr || *input == '\0') {
        Game::Lua::PushNil(L);
        return 1;
    }

    auto resolve = reinterpret_cast<ResolveUnitToken_t>(Offsets::FUN_RESOLVE_UNIT_TOKEN);
    const uint32_t playerKey = ReadGuildKey(
        static_cast<const uint8_t *>(resolve("player")));
    if (playerKey == 0) {
        // Player isn't in a guild — nobody is.
        Game::Lua::PushNil(L);
        return 1;
    }

    // Resolve the input to a GUID via the non-throwing token resolver
    // (`FUN_TOKEN_TO_GUID`, which our `Unit::TokenExtensions` hook also
    // teaches `focus` / `nameplateN`). A recognized unit token yields
    // its GUID; a literal character name — or an empty token slot like
    // `"party6"` — yields 0, in which case the input is treated as a
    // name for the roster strcmp. This replaces a hand-rolled mirror of
    // the engine's token grammar: the engine already knows the grammar,
    // and unlike its throwing sibling `FUN_RESOLVE_UNIT_TOKEN` this one
    // just returns 0 on anything it doesn't recognize. (It's also what
    // 3.3.5's `Script_UnitIsInMyGuild` does — resolve to a GUID first.)
    auto toGuid = reinterpret_cast<TokenToGUID_t>(Offsets::FUN_TOKEN_TO_GUID);
    const uint64_t guid = toGuid(input);

    const char *nameToFind;
    char nameBuf[64];
    if (guid != 0) {
        // Fast path: GUID → live object → direct guild-key comparison.
        // Covers visible/loaded units without touching the roster.
        const uint8_t *unit = ResolveUnitOrPlayerByGuid(guid);
        if (unit != nullptr) {
            const uint32_t unitKey = ReadGuildKey(unit);
            if (unitKey == playerKey) {
                Game::Lua::PushNumber(L, 1.0);
                return 1;
            }
            if (unitKey != 0) {
                // Definitively a different guild.
                Game::Lua::PushNil(L);
                return 1;
            }
            // unitKey == 0: data not synced. Fall through to roster.
        }
        // Slow path: GUID → name via the player NameCache → roster
        // strcmp (handles OOR raid members in another zone).
        nameToFind = NameFromGuid(guid, nameBuf);
        if (nameToFind == nullptr) {
            // Empty slot, an NPC GUID, or a player not yet name-queried
            // — not a guildmate we can identify.
            Game::Lua::PushNil(L);
            return 1;
        }
    } else {
        // Not a recognized token — treat as a literal character name.
        nameToFind = input;
    }

    auto **roster = *reinterpret_cast<uint8_t ***>(
        Offsets::VAR_GUILD_ROSTER_PTR);
    const int total = *reinterpret_cast<const int *>(
        Offsets::VAR_GUILD_ROSTER_TOTAL_COUNT);
    if (roster == nullptr || total <= 0) {
        Game::Lua::PushNil(L);
        return 1;
    }
    for (int i = 0; i < total; ++i) {
        const uint8_t *entry = roster[i];
        if (entry == nullptr)
            continue;
        const char *name = reinterpret_cast<const char *>(
            entry + Offsets::OFF_GUILD_MEMBER_NAME);
        if (std::strcmp(name, nameToFind) == 0) {
            Game::Lua::PushNumber(L, 1.0);
            return 1;
        }
    }
    Game::Lua::PushNil(L);
    return 1;
}

// `UnitIsPossessed(unit)` — returns true if the unit is currently
// possessed (priest `Mind Control`, warlock `Subjugate Demon`). Reads
// `UNIT_FIELD_FLAGS` bit 24 (`UNIT_FLAG_POSSESSED = 0x01000000`)
// directly off the unit's m_objectFields descriptor. Same broadcast
// path as FEIGN_DEATH — works for any unit token.
int __fastcall Script_UnitIsPossessed(void *L) {
    if (!Game::Lua::IsString(L, 1)) {
        Game::Lua::Error(L, "Usage: UnitIsPossessed(\"unit\")");
        return 0;
    }
    const char *token = Game::Lua::ToString(L, 1);
    if (token == nullptr) {
        Game::Lua::PushBool(L, 0);
        return 1;
    }

    auto resolve = reinterpret_cast<ResolveUnitToken_t>(Offsets::FUN_RESOLVE_UNIT_TOKEN);
    auto *unit = static_cast<const uint8_t *>(resolve(token));
    if (unit == nullptr) {
        Game::Lua::PushBoolean(L, 0);
        return 1;
    }
    auto *fields = *reinterpret_cast<const uint8_t *const *>(
        unit + Offsets::OFF_UNIT_DESCRIPTOR);
    if (fields == nullptr) {
        Game::Lua::PushBoolean(L, 0);
        return 1;
    }
    const uint32_t unitFlags = *reinterpret_cast<const uint32_t *>(
        fields + Offsets::OFF_UNIT_FIELD_FLAGS);
    Game::Lua::PushBoolean(L,
        (unitFlags & Offsets::UNIT_FLAG_POSSESSED) != 0);
    return 1;
}

static void RegisterLuaFunctions() {
    Game::Lua::RegisterGlobalFunction("UnitIsAFK", &Script_UnitIsAFK);
    Game::Lua::RegisterGlobalFunction("UnitIsDND", &Script_UnitIsDND);
    Game::Lua::RegisterGlobalFunction("UnitIsFeignDeath", &Script_UnitIsFeignDeath);
    Game::Lua::RegisterGlobalFunction("UnitIsPossessed", &Script_UnitIsPossessed);
    Game::Lua::RegisterGlobalFunction("UnitIsInMyGuild", &Script_UnitIsInMyGuild);
}

} // namespace

static const Game::ModuleAutoRegister _autoreg{&RegisterLuaFunctions};

} // namespace Unit::Flags