Files
myrzx_bot/tools/build_api_inventory.py

284 lines
23 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""Build a source-linked inventory from the retained APK decompilation, offline."""
import csv
import json
from pathlib import Path
import re
ROOT = Path(__file__).resolve().parents[1]
NETWORK = ROOT / "analysis/as3/scripts/net/pixvi/myr/net"
PURPOSES = {
"hisAchiComplete": "领取成就奖励", "dailyCheck": "每日签到", "dailyGiftSign": "领取每日礼包/签到奖励",
"dailyGiftUpdate": "更新每日礼包状态", "dailyLoopReward": "领取每日循环奖励", "getReward": "领取 VIP 奖励",
"getWeekActivityReward": "领取周活动奖励", "queryWeekActivityInfo": "查询周活动状态",
"alchemyComplete": "领取炼金成品", "alchemyOpen": "开启炼金槽", "alchemySpeed": "加速炼金", "alchemyStart": "开始炼金",
"battleStart": "开始特殊战斗", "recordBattleResult": "记录特殊战斗结果",
"finishHuntBoss": "结算世界 BOSS 挑战", "getBossRewardByDamage": "领取 BOSS 伤害奖励",
"queryCurrentBoss": "查询当前世界 BOSS", "queryCurrentBossHp": "查询世界 BOSS 剩余生命", "startHuntBoss": "开始世界 BOSS 挑战",
"monsterEntangleLevelUp": "提升羁绊等级", "monsterMakeEntangle": "建立魔物羁绊", "monsterResetEntangleSkill": "重置羁绊技能",
"monsterSetEntangleSkill": "设置羁绊技能", "itemEquipUnfix": "卸下装备", "itemEquipUsed": "穿戴装备", "itemExchange": "兑换物品",
"addTeam": "增加探索队伍", "cancelExplore": "取消探索", "finish": "完成并领取探索奖励", "start": "派出探索队伍",
"gachaBuyTimeEgg": "购买时段扭蛋", "gachaGetEggs": "执行扭蛋抽取并返回蛋/附带奖励", "gachaTimeEgg": "执行时段扭蛋操作",
"useGiftCode": "兑换礼包码", "itemSell": "出售物品", "itemUse": "使用物品",
"mailBatchDel": "批量删除邮件", "mailGetReward": "领取邮件附件", "mailQuery": "查询邮件列表", "mailRead": "标记邮件已读",
"guideUpdate": "更新引导进度", "keepAlive": "会话心跳", "masterCheckTiAdd": "检查体力恢复",
"masterLevelUpdate": "更新角色等级状态", "masterNameUpdate": "修改角色名字", "masterQuery": "查询角色基础信息",
"masterQueryDetail": "查询角色主快照(牧场、背包、队伍、任务等)", "queryMasterSecondDetail": "查询角色补充信息",
"queryRoleAvatars": "查询可用头像", "updateMasterAvatar": "更换头像", "migrateIn": "执行角色迁入", "migrateOut": "执行角色迁出",
"createMaster": "创建区服角色", "getArchiveInfo": "读取小游戏存档", "saveInfo": "保存小游戏存档",
"gameOver": "结算小游戏", "gameStart": "开始小游戏", "getRecord": "查询小游戏记录",
"monsterExchange": "交换魔物成长属性", "monsterIntensify": "消耗素材魔物强化目标魔物", "monsterLock": "锁定/解锁魔物",
"monsterNameUpdate": "修改魔物名字", "monsterPotential": "处理魔物潜能", "monsterQualification": "重设/提升魔物资质",
"monsterSell": "派遣/出售魔物", "monsterSendGift": "给魔物赠礼", "monsterTranster2Room": "转移魔物到牧场(保留原拼写)",
"monsterUpStar": "提升魔物星级", "getPayGift": "领取充值积分礼包",
"monsterPotentialLevelUpgrade": "提升魔物潜能等级", "monsterPotentialUpgrade": "提升魔物潜能阶段",
"finishPVE": "结算 PVE 活动挑战", "getPVEWeekReward": "领取 PVE 周奖励", "queryPVEInfo": "查询 PVE 活动信息", "startPVE": "开始 PVE 活动挑战",
"finishFarmEvent": "完成牧场随机事件", "getFarmEvent": "查询牧场随机事件", "queryRank": "查询排行榜",
"roomCreateByKe": "用氪金建造牧场", "roomCreateByMoney": "用金币建造牧场", "roomUpgrade": "升级牧场",
"shopItemBuy": "购买商店物品", "shopQuery": "查询商店商品", "monsterSetSkin": "设置魔物皮肤",
"stackAddMonster": "向培育槽放入魔物蛋", "stackCheckProcess": "推进/检查培育成长阶段", "stackGrowthNumber": "增加培育槽属性加成次数",
"stackOpen": "开启培育槽", "stackSpeedUp": "加速培育", "stackTransferMonster": "从培育槽收取魔物到牧场",
"battleEnd": "提交普通关卡战斗数据并结算", "checkNextWeek": "检查循环关卡跨周更新", "getStageReward": "领取循环关卡阶段奖励",
"stageStart": "进入指定关卡和难度", "queryGameConfig": "查询游戏配置", "queryGameNotice": "查询公告",
"execute": "查询系统时间", "firstOpenGame": "上报首次启动",
"taskComplete": "完成任务并领取奖励", "taskCompleteStep": "推进任务当前步骤", "taskLoopFlush": "刷新每日循环委托",
"taskLoopReceive": "接取指定城市的循环委托", "taskReceive": "接取普通任务", "taskUpdate": "更新任务状态/解锁",
"monsterPlaceBattleTeam": "将魔物加入战斗队伍", "monsterWithdrawBattleTeam": "从战斗队伍移除魔物",
"userActive": "提交激活码", "userRegister": "客户端保留的游戏用户注册路径", "enterGame": "选择区服并进入游戏",
"loginUser": "用渠道会话登录中心并取得区服/角色列表;另有开发模式调用", "userCertification": "提交游戏侧实名信息",
"payApply": "申请支付交易号", "getPayReward": "查询/领取已支付订单奖励", "queryNoGetRewardPay": "查询未领取的支付订单",
"getChargeReward": "领取时段充值奖励", "getChargeRewardList": "查询时段充值奖励列表",
}
GROUPS = {"NetAchi": "成就", "NetActi": "签到与活动", "NetAlchemy": "炼金", "NetBattle": "特殊战斗",
"NetBoss": "世界 BOSS", "NetEntangle": "羁绊", "NetEquip": "装备", "NetExchange": "物品兑换", "NetExplore": "探索派遣",
"NetGacha": "扭蛋", "NetItem": "物品与礼包码", "NetMail": "邮件", "NetMaster": "角色、体力与迁移",
"NetMiniGame": "小游戏与存档", "NetMonster": "魔物管理", "NetPay": "支付订单", "NetPayPoint": "充值奖励",
"NetPotential": "潜能", "NetPve": "PVE 活动", "NetRandomEvent": "牧场事件", "NetRank": "排行榜",
"NetRoom": "牧场建造", "NetShop": "商店", "NetSkin": "皮肤", "NetStack": "培育室",
"NetStage": "冒险关卡与结算", "NetSystem": "配置、公告与时间", "NetTask": "任务与委托", "NetTeam": "战斗编队", "NetUser": "登录、区服与实名"}
def code_chars(text, start=0):
i = start
while i < len(text):
if text[i] in "\"'":
quote = text[i]
i += 1
while i < len(text) and text[i] != quote:
i += 2 if text[i] == "\\" else 1
elif text.startswith("//", i):
i = text.find("\n", i)
if i < 0:
return
continue
elif text.startswith("/*", i):
end = text.find("*/", i + 2)
i = len(text) if end < 0 else end + 2
continue
else:
yield i, text[i]
i += 1
def end_of(text, start):
opening, closing = text[start], {"(": ")", "{": "}", "[": "]"}[text[start]]
depth = 0
for i, char in code_chars(text, start):
if char == opening:
depth += 1
elif char == closing:
depth -= 1
if depth == 0:
return i
raise ValueError("Unbalanced source")
def split_top(text):
start, depth, result = 0, 0, []
for index, char in code_chars(text):
if char in "({[":
depth += 1
elif char in ")}]":
depth -= 1
elif char == "," and depth == 0:
result.append(text[start:index].strip())
start = index + 1
return result + [text[start:].strip()]
def functions(text, java=False):
pattern = r"public\s+void\s+(\w+)\s*\(" if java else r"\bfunction\s+(\w+)\s*\("
result = {}
for match in re.finditer(pattern, text):
end_args = end_of(text, match.end() - 1)
brace = text.index("{", end_args)
end = end_of(text, brace)
result[match[1]] = {"name": match[1], "signature": text[match.start():brace].strip(),
"body": text[brace + 1:end], "offset": brace + 1, "line": text.count("\n", 0, match.start()) + 1}
return result
def request_fields(body, name):
fields = {}
for match in re.finditer(r"\b" + re.escape(name) + r"(?:\s*:\s*\w+)?\s*=\s*\{", body):
start = match.end() - 1
for entry in split_top(body[start + 1:end_of(body, start)]):
item = re.match(r'\s*["\']?(\w+)["\']?\s*:\s*(.*)', entry, re.S)
if item:
fields.setdefault(item[1], []).append(re.sub(r"\s+", " ", item[2]).strip())
for match in re.finditer(r"\b" + re.escape(name) + r"\.(\w+)\s*=\s*([^;]+);", body):
fields.setdefault(match[1], []).append(re.sub(r"\s+", " ", match[2]).strip())
return {key: list(dict.fromkeys(values)) for key, values in fields.items()}
def game_inventory():
endpoints = {}
for path in sorted(NETWORK.glob("*.as")):
text = path.read_text(encoding="utf-8")
constants = {}
for declaration in re.finditer(r'\b(?:const|var)\s+(\w+)\s*:\s*String\s*=\s*"([A-Za-z][\w-]*/[\w/-]+)"', text):
endpoint = declaration[2]
constants[declaration[1]] = endpoint
row = endpoints.setdefault(endpoint, {"path": endpoint, "method": None, "purpose": PURPOSES[endpoint.rsplit("/", 1)[1]],
"evidence": "静态客户端路径;是否找到调用见 calls", "calls": [], "declarations": []})
row["declarations"].append({"source": path.relative_to(ROOT).as_posix(), "class": path.stem,
"constant": declaration[1], "line": text.count("\n", 0, declaration.start()) + 1})
methods = functions(text)
for function in methods.values():
body = function["body"]
for match in re.finditer(r'\.send\(', body):
start = body.index("(", match.start())
args = split_top(body[start + 1:end_of(body, start)])
endpoint = args[0][1:-1] if args[0].startswith('"') and args[0].endswith('"') else constants.get(args[0])
if not endpoint:
continue
callback = methods.get(args[2]) if len(args) > 2 else None
fields = request_fields(body[:match.start()], args[1]) if re.fullmatch(r"\w+", args[1]) else {}
mode = args[5] if len(args) > 5 else "NetCenter.SERVER_MODE_NORMAL"
mode = {"0": "NetCenter.SERVER_MODE_CENTER", "1": "NetCenter.SERVER_MODE_NORMAL", "2": "NetCenter.SERVER_MODE_PAY"}.get(mode, mode)
line = text.count("\n", 0, function["offset"] + match.start()) + 1
response_fields = sorted(set(re.findall(r"\bre\.(\w+)", callback["body"]))) if callback else []
call = {"source": path.relative_to(ROOT).as_posix(), "line": line, "class": path.stem,
"function": function["name"], "signature": function["signature"], "request_argument": args[1],
"request_fields": fields, "callback": args[2] if len(args) > 2 else None,
"callback_line": callback["line"] if callback else None, "callback_fields": response_fields,
"response_forwarded": bool(callback and re.search(r"\w+\(re\)", callback["body"])),
"server_mode": mode, "send_arguments": args}
row = endpoints.setdefault(endpoint, {"path": endpoint, "method": "POST", "purpose": PURPOSES[endpoint.rsplit("/", 1)[1]],
"evidence": "静态客户端调用;未进行官方实服调用验证", "calls": [], "declarations": []})
row["method"] = "POST"
row["evidence"] = "静态客户端 send 调用;未进行官方实服调用验证"
row["calls"].append(call)
return sorted(endpoints.values(), key=lambda row: row["path"])
def sdk_inventory():
path = ROOT / "analysis/sdk_login/com.diyidan.game.network.UserNetwork2.java"
text = path.read_text(encoding="utf-8")
purposes = {"loginByPhone": "账号密码登录", "registerByPhone": "手机号注册", "visitorUpgrade": "游客升级手机号账号",
"registerAsVisitor": "游客注册", "logout": "退出渠道会话", "loginByDydToken": "使用第一弹 Token 登录",
"loginByDydPermanentToken": "使用永久 Token 获取会话", "verifyToken": "验证 Token", "generateToken": "生成指定有效期 Token",
"forgetPassword": "短信验证后重设密码", "bindByDydToken": "通过 Token 绑定已有账号", "bindByPhone": "通过密码绑定已有账号",
"verifyId": "渠道侧实名验证"}
result = []
for function in functions(text, java=True).values():
for match in re.finditer(r"addRequestToQueue\(", function["body"]):
start = function["body"].index("(", match.start())
args = split_top(function["body"][start + 1:end_of(function["body"], start)])
fields = re.findall(r'map\.put\("([^"\n]+)"', function["body"])
result.append({"method": {"0": "GET", "1": "POST", "2": "PUT", "3": "DELETE"}.get(args[0], args[0]),
"url_expression": args[1], "function": function["name"], "purpose": purposes[function["name"]],
"request_fields": fields, "source": path.relative_to(ROOT).as_posix(),
"line": text.count("\n", 0, function["offset"] + match.start()) + 1,
"evidence": "静态 SDK 调用;返回结构需对应响应验证"})
return result
def source_link(call):
path = call["source"].removeprefix("analysis/")
return f"[{Path(path).name}:{call['line']}]({path}#L{call['line']})"
def main():
rows, sdk = game_inventory(), sdk_inventory()
baseline = {endpoint for entry in json.loads((ROOT / "analysis/endpoints.json").read_text(encoding="utf-8")) for endpoint in entry["endpoints"]}
assert baseline <= {row["path"] for row in rows}
inventory = {"artifact": "牧羊人之心_1.9.68.apk", "artifact_sha256": "01678ee3a8465d818d32cbbd94baa0d8253b04b4c57b70ebc5544ed341f1015d",
"date": "2026-11-07", "game_endpoint_count": len(rows), "sdk_call_variants": len(sdk),
"paths_with_calls": sum(bool(row["calls"]) for row in rows),
"scope": "31 个 Net*.as 文件中的路径常量、字符串 send 调用及本类常量 send 调用,以及已导出的 UserNetwork2 SDK 类;不包含未导出 SDK 类、动态拼接和热更新代码",
"runtime_observations": {"user_confirmed_success": ["SDK password login", "userServerService/loginUser", "userServerService/enterGame", "masterService/masterQueryDetail"],
"other_endpoints": "仅静态代码证据;未进行官方实服操作验证"},
"game": rows, "sdk": sdk}
target = ROOT / "analysis/API_INVENTORY.json"
target.write_text(json.dumps(inventory, ensure_ascii=False, indent=2), encoding="utf-8")
route_names = {"NetCenter.SERVER_MODE_CENTER": "登录中心", "NetCenter.SERVER_MODE_NORMAL": "选中游戏服", "NetCenter.SERVER_MODE_PAY": "区服支付服"}
header = ["# 牧羊人之心客户端接口清单", "", "生成日期:2026-11-07。来源:用户提供的 1.9.68 APK 留存反编译代码。", "",
f"发现 **{len(rows)} 个游戏侧路径**,其中 **{sum(bool(row['calls']) for row in rows)} 个找到实际 send 调用**;另列 **{len(sdk)} 种渠道 SDK 调用方式**。", "主体依据客户端静态证据,用途根据调用方法、参数和回调推定。账号验证、中心登录、进入区服和角色读取已由用户实测成功;其他接口未做官方实服验证。", "",
"## 阅读方式", "", "- 表内请求字段不含统一注入的 `token`、`reqid`、`reqsid`;空字段表示包装方法没有显式业务字段。",
"- 返回字段是该方法回调直接读取的字段,不是完整响应 Schema。`回调透传` 表示把整个响应交给上层。",
"- `JSON` 文件保留每个调用位置、方法签名、参数表达式、回调字段与路由;CSV 可直接用 Excel 打开。",
"- 普通游戏接口是 POST,JSON 经 AES-ECB + PKCS7 + Base64 后作为请求体;支付调用有单独的路由/编码开关。",
"- 登录中心来自 APK 配置;进入区服后的地址来自官方返回的 `gameServerAddress`;支付地址来自 `payServerAddress`。", "",
"## 登录顺序与当前排查", "", "1. `POST https://gameapi.diyidan.net/g0.3/users/reallogin`:发送渠道账号密码,取 SDK 用户会话。",
"2. `userServerService/loginUser`:发送 SDK 用户 ID/Token、渠道和平台,客户端读取 `playerInfo`、`servers`、`masterInfos`。",
"3. 用户选择返回的区服后,`userServerService/enterGame`:发送 `serverId`、设备信息和客户端计算的 `random`。",
"4. 对选中区服调用 `masterService/masterQueryDetail`,读取角色与牧场/背包/任务等状态。", "",
"签名日期必须跟随 `Paster.timestampFormat` 的实际实现:格式串 `yyMMdd` 中的 `yy` 被替换为四位 `Date.fullYear`,因此日期是八位 `yyyyMMdd`。",
"`channel` 与 `tjChannel` 不同:这份 APK 的渠道为 `DYD`,而 `assets/tjchannel.json` 中的追踪渠道为 `taptap`。",
"辅助已修正这两处进入参数,并在调试日志的“进入参数检查”中记录日期、规则和渠道,不记录签名原文或 Token。", "",
"旧版 `AccountCenter.as` 使用 `servers[].id`;内部 `ServerVo` 保存为 `serverId`;`masterInfos[].id` 是角色编号。",
"实际登录日志返回前两条完整区服(含 `id`),后两条是 `$.servers[0]` / `$.servers[1]` 的 `$ref` 引用。",
"辅助现已还原数组引用、按区服编号去重,并按 `masterInfos[].serverId` 关联角色名;本地整理不会再发请求。",
"调试窗口已记录进入解析器之前的解密响应,文件为 `local_state/ranch_helper/network_debug.jsonl`。", "",
"## 培育室和冒险的关键组合", "", "- 看培育槽/背包:`masterQueryDetail`;刷新成长:`stackCheckProcess`;放蛋:`stackAddMonster`。",
"- 收取到牧场:`stackTransferMonster`,`datas` 内具体结构需结合调用者;派遣:`monsterSell`。",
"- 派遣统一使用 `monsterIds` 数组:`MonsterCenter.sellAllStackMonsters` 的培育室路径也调用 `NetMonster.sellMonsters`。`NetStack.sellMonsters` 的单数 `monsterId` 是未找到调用点的旧包装;用户日志中它返回997,复数请求成功。",
"- 喂养升级:`monsterIntensify`,目标 `targetId`,素材数组 `foods`。",
"- 委托:`taskLoopFlush` → `taskLoopReceive` → `taskCompleteStep` → `taskComplete`。",
"- 普通冒险:`stageStart` → 客户端实际战斗 → `battleEnd`。后者提交 `battleData`,包含伤害、击杀、时间、阵容等。",
"- 客户端 `StageStartPanel.startSaodang/doSaodangBattle` 复用上述接口;普通关卡三个难度全部通关后开放。详见 `STAGES_DAILY.md`。服务端如何验证仍未知。", "", "## 游戏接口(按功能)", ""]
csv_rows = []
for cls, group in GROUPS.items():
selected = [(row, call) for row in rows for call in (row["calls"] or row["declarations"]) if call["class"] == cls]
if not selected:
continue
header += [f"### {group}({cls})", "", "| API | 用途 | 请求字段 | 回调读取字段 | 代码位置 |", "|---|---|---|---|---|"]
for row, call in selected:
if not row["calls"]:
header.append(f"| `{row['path']}` | {row['purpose']}(仅常量,未找到 send 调用) | 未确认 | 未确认 | {source_link(call)} |")
csv_rows.append([row["path"], row["purpose"] + "(仅常量,未找到 send 调用)", "未确认", "未确认", "未确认", call["constant"], f"{call['source']}:{call['line']}"])
continue
fields = ", ".join(call["request_fields"]) or ("无显式业务字段" if call["request_argument"] in ("para", "{}") else call["request_argument"])
returns = ", ".join(call["callback_fields"]) or ("回调透传" if call["response_forwarded"] else "此回调未显式读取字段")
purpose = row["purpose"]
if call["function"] == "login":
purpose = "客户端保留的开发模式登录(loginType=dev);辅助不使用此模式"
route = route_names.get(call["server_mode"], call["server_mode"])
header.append(f"| `{row['path']}` | {purpose} | `{fields}` | `{returns}` | {source_link(call)} |")
csv_rows.append([row["path"], purpose, route, fields, returns, call["function"], f"{call['source']}:{call['line']}"])
header.append("")
header += ["## 第一弹渠道 SDK(已导出的 UserNetwork2 类)", "", "SDK 方法号对应 Volley 的 GET/POST/PUT/DELETE。共享 URL 的不同方法/参数分别列出。", "绑定调用额外含混淆常量 `d.p` 对应的字段,未在本清单猜测其原名。", "",
"| 方法 | URL 表达式 | 用途 | 显式表单字段 | 代码位置 |", "|---|---|---|---|---|"]
for row in sdk:
header.append(f"| {row['method']} | `{row['url_expression']}` | {row['purpose']} | `{', '.join(row['request_fields']) or '无显式表单字段'}` | {source_link(row)} |")
header += ["", "账号密码接口的 SDK 查询参数含 `versionCode`、`buildNumber`、`appChannel`,请求头有应用身份签名与设备字段。",
"Token 校验类方法还涉及 SDK 自身的 Header/会话状态,不能把表内空表单理解为无需认证。", "",
"## 范围和待确认项", "", "- 本清单检查 31 个网络类的字符串及常量请求。此前 `endpoints.json` 的 111 路径未覆盖 `pay-server/...` 前缀,本次补入 5 条。",
"- `monsterService/monsterPotential` 只找到常量声明,未在此范围找到调用,不能视为已确认可用的 API。",
"- `NetMonster.addPotential` 实际向 `monsterTranster2Room` 发送潜能参数;清单保留该反编译事实,不改写成猜测的路径。",
"- 参数集合是静态分支的并集,不表示每次都必填。嵌套对象、服务端默认值、类型约束需要逐个联调。",
"- 同一个接口可能被多个包装方法调用;CSV/JSON 保留这些变体,因此行数可能大于唯一接口数。",
"- 未恢复服务端源代码、完整数据库结构、服务端验签/战斗校验规则。未对库存、支付等路径进行官方实服测试。",
"- 动态拼接、其他未导出渠道 SDK、热更新资源或其他版本新增 API 不在当前静态覆盖范围。", ""]
(ROOT / "analysis/API_INVENTORY.md").write_text("\n".join(header), encoding="utf-8")
with (ROOT / "analysis/API_INVENTORY.csv").open("w", encoding="utf-8-sig", newline="") as stream:
writer = csv.writer(stream)
writer.writerow(["API", "用途", "路由", "请求字段", "回调读取字段", "调用方法", "来源"])
writer.writerows(csv_rows)
print(f"Generated {len(rows)} game paths, {sum(len(row['calls']) for row in rows)} call sites, {len(sdk)} SDK variants")
if __name__ == "__main__":
main()