Compare commits

..

No commits in common. "master" and "hide-bot-accounts" have entirely different histories.

8 changed files with 14 additions and 49 deletions

View file

@ -10,7 +10,7 @@
"loadDbcs": true, "loadDbcs": true,
"hideGameMasters": true, "hideGameMasters": true,
"hideBotAccounts": true, "hideBotAccounts": true,
"botAccountPatterns": "RNDBOT%", "botAccountPattern": "RNDBOT%",
"transmogModule": false, "transmogModule": false,
"useZamCdn": false, "useZamCdn": false,
"realms": [ "realms": [

View file

@ -48,11 +48,8 @@ services:
# Playerbots are ordinary accounts, not game masters, so the GM # Playerbots are ordinary accounts, not game masters, so the GM
# filter does not touch them. Without this the armory lists ~1350 # filter does not touch them. Without this the armory lists ~1350
# bots against ~29 real characters. # bots against ~29 real characters.
# Comma-separated LIKE patterns. RNDBOT% covers the Playerbots
# accounts; ahouse is the auction-house bot, which owns 9 mule
# characters. Add further service accounts here as they appear.
ACORE_ARMORY_HIDE_BOT_ACCOUNTS: ${ARMORY_HIDE_BOTS:-1} ACORE_ARMORY_HIDE_BOT_ACCOUNTS: ${ARMORY_HIDE_BOTS:-1}
ACORE_ARMORY_BOT_ACCOUNT_PATTERNS: ${ARMORY_BOT_PATTERNS:-RNDBOT%,ahouse} ACORE_ARMORY_BOT_ACCOUNT_PATTERN: ${ARMORY_BOT_PATTERN:-RNDBOT%}
ACORE_ARMORY_TRANSMOG_MODULE: ${ARMORY_TRANSMOG:-0} ACORE_ARMORY_TRANSMOG_MODULE: ${ARMORY_TRANSMOG:-0}
# 0 = serve 3D model assets from the local data directory. # 0 = serve 3D model assets from the local data directory.

View file

@ -133,8 +133,6 @@ FLUSH PRIVILEGES;
this realm belong to real players — `Spinnaker` among them — so hiding them this realm belong to real players — `Spinnaker` among them — so hiding them
would hide people who should be listed. Set `ARMORY_HIDE_GMS=1` to restore would hide people who should be listed. Set `ARMORY_HIDE_GMS=1` to restore
upstream behaviour. upstream behaviour.
- **Service accounts are hidden** via `hideBotAccounts` / `botAccountPatterns`, - **Playerbots are hidden** via `hideBotAccounts` / `botAccountPattern`
a comma-separated list of LIKE patterns defaulting to `RNDBOT%,ahouse` — the (`RNDBOT%`). They are ordinary accounts rather than game masters, so the GM
Playerbots accounts and the auction-house bot, which owns 9 mule characters. filter never touched them. `ARMORY_HIDE_BOTS=0` shows them again.
None of them are game masters, so the GM filter never touched them. Add more
with `ARMORY_BOT_PATTERNS`, or set `ARMORY_HIDE_BOTS=0` to show them all.

View file

@ -32,7 +32,7 @@ export class Config {
public loadDbcs: boolean; public loadDbcs: boolean;
public hideGameMasters: boolean; public hideGameMasters: boolean;
public hideBotAccounts: boolean; public hideBotAccounts: boolean;
public botAccountPatterns: string; public botAccountPattern: string;
public transmogModule: boolean; public transmogModule: boolean;
public useZamCdn: boolean; public useZamCdn: boolean;
public realms: IRealmConfig[]; public realms: IRealmConfig[];

View file

@ -73,24 +73,4 @@ export class Utils {
public static quoteSqlString(value: string): string { public static quoteSqlString(value: string): string {
return `'${String(value).replace(/\\/g, "\\\\").replace(/'/g, "\\'")}'`; return `'${String(value).replace(/\\/g, "\\\\").replace(/'/g, "\\'")}'`;
} }
/**
* Build the LIKE test that identifies non-player accounts.
*
* `patterns` is a comma-separated list, so a realm can name several service
* accounts at once Playerbots plus an auction-house bot, say. Returns an
* empty string when nothing is configured, which callers treat as "do not
* filter" rather than emitting an always-false clause.
*/
public static botAccountFilter(column: string, patterns: string): string {
const list = String(patterns ?? "")
.split(",")
.map((p) => p.trim())
.filter((p) => p.length > 0);
if (list.length === 0) {
return "";
}
return `(${list.map((p) => `${column} LIKE ${Utils.quoteSqlString(p)}`).join(" OR ")})`;
}
} }

View file

@ -347,18 +347,14 @@ export class CharacterController {
// rows we do not want, then require the join to have missed. Keeping the // rows we do not want, then require the join to have missed. Keeping the
// pattern inline rather than bound avoids disturbing the positional // pattern inline rather than bound avoids disturbing the positional
// values below. // values below.
const botFilter = this.armory.config.hideBotAccounts const botJoin = this.armory.config.hideBotAccounts
? Utils.botAccountFilter("`bot_account`.`username`", this.armory.config.botAccountPatterns) ? `LEFT JOIN \`${realm.authDatabase}\`.\`account\` AS \`bot_account\` ON \`bot_account\`.\`id\` = \`characters\`.\`account\` AND \`bot_account\`.\`username\` LIKE ${Utils.quoteSqlString(this.armory.config.botAccountPattern)}`
: ""; : "";
const botJoin = const botWhere = this.armory.config.hideBotAccounts ? "AND `bot_account`.`id` IS NULL" : "";
botFilter === ""
? ""
: `LEFT JOIN \`${realm.authDatabase}\`.\`account\` AS \`bot_account\` ON \`bot_account\`.\`id\` = \`characters\`.\`account\` AND ${botFilter}`;
const botWhere = botFilter === "" ? "" : "AND `bot_account`.`id` IS NULL";
const [rows] = await this.armory.getCharactersDb(realm.name).query({ const [rows] = await this.armory.getCharactersDb(realm.name).query({
sql: ` sql: `
SELECT \`characters\`.\`guid\`, \`characters\`.\`name\`, \`characters\`.\`race\`, \`characters\`.\`class\`, \`characters\`.\`gender\`, \`characters\`.\`level\`, \`characters\`.\`skin\`, \`characters\`.\`face\`, \`characters\`.\`hairStyle\`, \`characters\`.\`hairColor\`, \`characters\`.\`facialStyle\`, \`characters\`.\`playerFlags\`, \`characters\`.\`online\`, \`guild\`.\`name\` AS \`guild\` SELECT \`characters\`.\`guid\`, \`characters\`.\`name\`, \`race\`, \`class\`, \`gender\`, \`level\`, \`skin\`, \`face\`, \`hairStyle\`, \`hairColor\`, \`facialStyle\`, \`playerFlags\`, \`online\`, \`guild\`.\`name\` AS \`guild\`
FROM \`characters\` FROM \`characters\`
LEFT JOIN \`guild_member\` ON \`guild_member\`.\`guid\` = \`characters\`.\`guid\` LEFT JOIN \`guild_member\` ON \`guild_member\`.\`guid\` = \`characters\`.\`guid\`
LEFT JOIN \`guild\` ON \`guild\`.\`guildid\` = \`guild_member\`.\`guildid\` LEFT JOIN \`guild\` ON \`guild\`.\`guildid\` = \`guild_member\`.\`guildid\`

View file

@ -93,10 +93,7 @@ export class GuildController {
ssp = ssp.where("`account_access`.`id` IS NULL"); ssp = ssp.where("`account_access`.`id` IS NULL");
} }
const botFilter = this.armory.config.hideBotAccounts if (this.armory.config.hideBotAccounts) {
? Utils.botAccountFilter(`\`${realm.authDatabase}\`.\`account\`.\`username\``, this.armory.config.botAccountPatterns)
: "";
if (botFilter !== "") {
ssp.joins.push({ ssp.joins.push({
table1: "characters", table1: "characters",
column1: "account", column1: "account",
@ -104,7 +101,7 @@ export class GuildController {
column2: "id", column2: "id",
database2: realm.authDatabase, database2: realm.authDatabase,
kind: "LEFT", kind: "LEFT",
where: `AND ${botFilter}`, where: `AND \`${realm.authDatabase}\`.\`account\`.\`username\` LIKE ${Utils.quoteSqlString(this.armory.config.botAccountPattern)}`,
}); });
ssp = ssp.where(`\`${realm.authDatabase}\`.\`account\`.\`id\` IS NULL`); ssp = ssp.where(`\`${realm.authDatabase}\`.\`account\`.\`id\` IS NULL`);
} }

View file

@ -55,10 +55,7 @@ export class IndexController {
ssp = ssp.where("`account_access`.`id` IS NULL"); ssp = ssp.where("`account_access`.`id` IS NULL");
} }
const botFilter = this.armory.config.hideBotAccounts if (this.armory.config.hideBotAccounts) {
? Utils.botAccountFilter(`\`${realm.authDatabase}\`.\`account\`.\`username\``, this.armory.config.botAccountPatterns)
: "";
if (botFilter !== "") {
ssp.joins.push({ ssp.joins.push({
table1: "characters", table1: "characters",
column1: "account", column1: "account",
@ -66,7 +63,7 @@ export class IndexController {
column2: "id", column2: "id",
database2: realm.authDatabase, database2: realm.authDatabase,
kind: "LEFT", kind: "LEFT",
where: `AND ${botFilter}`, where: `AND \`${realm.authDatabase}\`.\`account\`.\`username\` LIKE ${Utils.quoteSqlString(this.armory.config.botAccountPattern)}`,
}); });
ssp = ssp.where(`\`${realm.authDatabase}\`.\`account\`.\`id\` IS NULL`); ssp = ssp.where(`\`${realm.authDatabase}\`.\`account\`.\`id\` IS NULL`);
} }