usbharu
/
misskey
mirror of https://github.com/misskey-dev/misskey.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge 5b6ace0b8a into d522d1bf26

This commit is contained in:
おさむのひと 2025-05-04 12:57:52 +00:00 committed by GitHub
parent d522d1bf26 5b6ace0b8a
commit a67795a195
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 556 additions and 300 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
locales/index.d.ts vendored
View File

@ -1706,6 +1706,14 @@ export interface Locale extends ILocale {
* Botアカウントを除外
*/
"antennaExcludeBots": string;
/**
* 正規表現を使用する
*/
"antennaUseRegex": string;
/**
* {src}の{line}行目にエラーがあります。
*/
"antennaUseRegexError": ParameterizedString<"src" | "line">;
/**
* スペースで区切るとAND指定になり、改行で区切るとOR指定になります
*/

2
locales/ja-JP.yml
View File

@ -422,6 +422,8 @@ antennaSource: "受信ソース"
antennaKeywords: "受信キーワード"
antennaExcludeKeywords: "除外キーワード"
antennaExcludeBots: "Botアカウントを除外"
antennaUseRegex: "正規表現を使用する"
antennaUseRegexError: "{src}の{line}行目にエラーがあります。"
antennaKeywordsDescription: "スペースで区切るとAND指定になり、改行で区切るとOR指定になります"
notifyAntenna: "新しいノートを通知する"
withFileAntenna: "ファイルが添付されたノートのみ"

16
packages/backend/migration/1740781670204-antennaRegexSupport.js Normal file
View File

@ -0,0 +1,16 @@
/*
* SPDX-FileCopyrightText: syuilo and misskey-project
* SPDX-License-Identifier: AGPL-3.0-only
*/
export class AntennaRegexSupport1740781670204 {
name = 'AntennaRegexSupport1740781670204'
async up(queryRunner) {
await queryRunner.query(`ALTER TABLE "antenna" ADD "useRegex" boolean NOT NULL DEFAULT false`);
}
async down(queryRunner) {
await queryRunner.query(`ALTER TABLE "antenna" DROP COLUMN "useRegex"`);
}
}

474
packages/backend/src/core/AntennaService.ts
View File

@ -5,26 +5,161 @@
import { Inject, Injectable } from '@nestjs/common';
import * as Redis from 'ioredis';
import RE2 from 're2';
import { In } from 'typeorm';
import { FanoutTimelineService } from '@/core/FanoutTimelineService.js';
import type { GlobalEvents } from '@/core/GlobalEventService.js';
import { GlobalEventService } from '@/core/GlobalEventService.js';
import { IdService } from '@/core/IdService.js';
import { UtilityService } from '@/core/UtilityService.js';
import { bindThis } from '@/decorators.js';
import { DI } from '@/di-symbols.js';
import * as Acct from '@/misc/acct.js';
import type { Packed } from '@/misc/json-schema.js';
import type { AntennasRepository, UserListMembershipsRepository } from '@/models/_.js';
import type { MiAntenna } from '@/models/Antenna.js';
import type { AntennasRepository } from '@/models/_.js';
import { AntennaSource, MiAntenna } from '@/models/Antenna.js';
import type { MiNote } from '@/models/Note.js';
import type { MiUser } from '@/models/User.js';
import { CacheService } from './CacheService.js';
import { RoleService } from './RoleService.js';
import type { OnApplicationShutdown } from '@nestjs/common';
type AntennaFilter = {
antennaId: string;
src: MiAntenna;
testKeywords(target: string): boolean;
};
function matchAntennaKeywords(target: string, keywords: string[][]): boolean {
return keywords.some(and => and.every(keyword => target.includes(keyword)));
}
function matchAntennaKeywordsCaseInsensitive(target: string, keywords: string[][]): boolean {
const _target = target.toLowerCase();
return keywords.some(and => and.every(keyword => _target.includes(keyword)));
}
function matchAntennaKeywordsRegex(target: string, patterns: RE2[]): boolean {
return patterns.every(re => re.test(target));
}
export const antennaFilters = {
regex: {
includeAndExclude: (target: string, keywords: RE2[], excludeKeywords: RE2[]): boolean => {
return matchAntennaKeywordsRegex(target, keywords) && !matchAntennaKeywordsRegex(target, excludeKeywords);
},
includeOnly: (target: string, keywords: RE2[]): boolean => {
return matchAntennaKeywordsRegex(target, keywords);
},
excludeOnly: (target: string, excludeKeywords: RE2[]): boolean => {
return !matchAntennaKeywordsRegex(target, excludeKeywords);
},
},
noRegex: {
caseSensitive: {
includeAndExclude: (target: string, keywords: string[][], excludeKeywords: string[][]): boolean => {
return matchAntennaKeywords(target, keywords) && !matchAntennaKeywords(target, excludeKeywords);
},
includeOnly: (target: string, keywords: string[][]): boolean => {
return matchAntennaKeywords(target, keywords);
},
excludeOnly: (target: string, excludeKeywords: string[][]): boolean => {
return !matchAntennaKeywords(target, excludeKeywords);
},
},
caseInsensitive: {
includeAndExclude: (target: string, keywords: string[][], excludeKeywords: string[][]): boolean => {
return matchAntennaKeywordsCaseInsensitive(target, keywords) && !matchAntennaKeywordsCaseInsensitive(target, excludeKeywords);
},
includeOnly: (target: string, keywords: string[][]): boolean => {
return matchAntennaKeywordsCaseInsensitive(target, keywords);
},
excludeOnly: (target: string, excludeKeywords: string[][]): boolean => {
return !matchAntennaKeywordsCaseInsensitive(target, excludeKeywords);
},
},
},
};
function alwaysTrue(): boolean {
return true;
}
export function createAntennaFilter(antenna: MiAntenna): AntennaFilter {
function createTestKeywordsFunction(antenna: MiAntenna): AntennaFilter['testKeywords'] {
// Clean up
const keywords = antenna.keywords
.map(xs => xs.filter(x => x !== ''))
.filter(xs => xs.length > 0);
const excludeKeywords = antenna.excludeKeywords
.map(xs => xs.filter(x => x !== ''))
.filter(xs => xs.length > 0);
if (antenna.useRegex) {
// 元々はAND検索を行うために2次元配列としてもっていた歴史的経緯がある.
// 正規表現の時は1行に付き1パターンとするため、[n][0]にパターンの内容すべてが格納されているものとして扱う.
const createRE2 = (pattern: string): RE2 => {
const regexp = pattern.match(/^\/(.+)\/(.*)$/) ?? [];
return new RE2(regexp[1], regexp[2]);
};
const keywordsPatterns = keywords.map(line => createRE2(line[0]));
const excludeKeywordsPatterns = excludeKeywords.map(line => createRE2(line[0]));
if (keywords.length > 0 && excludeKeywords.length > 0) {
return (target: string) => antennaFilters.regex.includeAndExclude(target, keywordsPatterns, excludeKeywordsPatterns);
} else if (keywords.length > 0) {
return (target: string) => antennaFilters.regex.includeOnly(target, keywordsPatterns);
} else if (excludeKeywords.length > 0) {
return (target: string) => antennaFilters.regex.excludeOnly(target, excludeKeywordsPatterns);
} else {
return alwaysTrue;
}
} else if (antenna.caseSensitive) {
if (keywords.length > 0 && excludeKeywords.length > 0) {
return (target: string) => antennaFilters.noRegex.caseSensitive.includeAndExclude(target, keywords, excludeKeywords);
} else if (keywords.length > 0) {
return (target: string) => antennaFilters.noRegex.caseSensitive.includeOnly(target, keywords);
} else if (excludeKeywords.length > 0) {
return (target: string) => antennaFilters.noRegex.caseSensitive.excludeOnly(target, excludeKeywords);
} else {
return alwaysTrue;
}
} else {
if (keywords.length > 0 && excludeKeywords.length > 0) {
return (target: string) => antennaFilters.noRegex.caseInsensitive.includeAndExclude(target, keywords, excludeKeywords);
} else if (keywords.length > 0) {
return (target: string) => antennaFilters.noRegex.caseInsensitive.includeOnly(target, keywords);
} else if (excludeKeywords.length > 0) {
return (target: string) => antennaFilters.noRegex.caseInsensitive.excludeOnly(target, excludeKeywords);
} else {
return alwaysTrue;
}
}
}
return {
antennaId: antenna.id,
src: antenna,
testKeywords: createTestKeywordsFunction(antenna),
};
}
@Injectable()
export class AntennaService implements OnApplicationShutdown {
private antennasFetched: boolean;
private antennas: MiAntenna[];
public static AntennaNotFoundError = class extends Error {
};
public static EmptyKeyWordError = class extends Error {
};
public static TooManyAntennasError = class extends Error {
};
public static InvalidRegexPatternError = class extends Error {
constructor(err?: unknown) {
const msg = err instanceof Error ? err.message : undefined;
super(msg);
}
};
private filtersFetched: boolean;
private filters: AntennaFilter[];
constructor(
@Inject(DI.redisForTimelines)
@ -36,16 +171,14 @@ export class AntennaService implements OnApplicationShutdown {
@Inject(DI.antennasRepository)
private antennasRepository: AntennasRepository,
@Inject(DI.userListMembershipsRepository)
private userListMembershipsRepository: UserListMembershipsRepository,
private cacheService: CacheService,
private roleService: RoleService,
private utilityService: UtilityService,
private globalEventService: GlobalEventService,
private fanoutTimelineService: FanoutTimelineService,
private idService: IdService,
) {
this.antennasFetched = false;
this.antennas = [];
this.filtersFetched = false;
this.filters = [];
this.redisForSub.on('message', this.onRedisMessage);
}
@ -57,37 +190,24 @@ export class AntennaService implements OnApplicationShutdown {
if (obj.channel === 'internal') {
const { type, body } = obj.message as GlobalEvents['internal']['payload'];
switch (type) {
case 'antennaCreated':
this.antennas.push({ // TODO: このあたりのデシリアライズ処理は各modelファイル内に関数としてexportしたい
...body,
lastUsedAt: new Date(body.lastUsedAt),
user: null, // joinなカラムは通常取ってこないので
userList: null, // joinなカラムは通常取ってこないので
});
case 'antennaCreated': {
this.filters.push(createAntennaFilter(MiAntenna.deserialize(body)));
break;
}
case 'antennaUpdated': {
const idx = this.antennas.findIndex(a => a.id === body.id);
const idx = this.filters.findIndex(a => a.antennaId === body.id);
if (idx >= 0) {
this.antennas[idx] = { // TODO: このあたりのデシリアライズ処理は各modelファイル内に関数としてexportしたい
...body,
lastUsedAt: new Date(body.lastUsedAt),
user: null, // joinなカラムは通常取ってこないので
userList: null, // joinなカラムは通常取ってこないので
};
this.filters[idx] = createAntennaFilter(MiAntenna.deserialize(body));
} else {
// サーバ起動時にactiveじゃなかった場合、リストに持っていないので追加する必要あり
this.antennas.push({ // TODO: このあたりのデシリアライズ処理は各modelファイル内に関数としてexportしたい
...body,
lastUsedAt: new Date(body.lastUsedAt),
user: null, // joinなカラムは通常取ってこないので
userList: null, // joinなカラムは通常取ってこないので
});
this.filters.push(createAntennaFilter(MiAntenna.deserialize(body)));
}
break;
}
case 'antennaDeleted': {
this.filters = this.filters.filter(a => a.antennaId !== body.id);
break;
case 'antennaDeleted':
this.antennas = this.antennas.filter(a => a.id !== body.id);
break;
}
default:
break;
}
@ -96,128 +216,224 @@ export class AntennaService implements OnApplicationShutdown {
@bindThis
public async addNoteToAntennas(note: MiNote, noteUser: { id: MiUser['id']; username: string; host: string | null; isBot: boolean; }): Promise<void> {
const antennas = await this.getAntennas();
const antennasWithMatchResult = await Promise.all(antennas.map(antenna => this.checkHitAntenna(antenna, note, noteUser).then(hit => [antenna, hit] as const)));
const matchedAntennas = antennasWithMatchResult.filter(([, hit]) => hit).map(([antenna]) => antenna);
const filters = await this.getFilters();
const redisPipeline = this.redisForTimelines.pipeline();
for (const antenna of matchedAntennas) {
this.fanoutTimelineService.push(`antennaTimeline:${antenna.id}`, note.id, 200, redisPipeline);
this.globalEventService.publishAntennaStream(antenna.id, 'note', note);
for (const filter of filters) {
if (this.checkHitAntenna(filter, note, noteUser)) {
this.fanoutTimelineService.push(`antennaTimeline:${filter.antennaId}`, note.id, 200, redisPipeline);
this.globalEventService.publishAntennaStream(filter.antennaId, 'note', note);
}
}
redisPipeline.exec();
}
// NOTE: フォローしているユーザーのノート、リストのユーザーのノート、グループのユーザーのノート指定はパフォーマンス上の理由で無効になっている
@bindThis
public async create(
ps: {
name: string;
src: AntennaSource;
keywords: string[][];
excludeKeywords: string[][];
users: string[];
caseSensitive: boolean;
localOnly?: boolean;
excludeBots?: boolean;
excludeNotesInSensitiveChannel?: boolean;
useRegex?: boolean;
withReplies: boolean;
withFile: boolean;
},
me: MiUser,
): Promise<MiAntenna> {
this.validateEmptyKeyWord(ps);
this.validateRegexPattern(ps);
const currentAntennasCount = await this.antennasRepository.countBy({ userId: me.id });
if (currentAntennasCount >= (await this.roleService.getUserPolicies(me.id)).antennaLimit) {
throw new AntennaService.TooManyAntennasError;
}
const now = new Date();
const antenna = await this.antennasRepository.insertOne({
id: this.idService.gen(now.getTime()),
lastUsedAt: now,
userId: me.id,
name: ps.name,
src: ps.src,
keywords: ps.keywords,
excludeKeywords: ps.excludeKeywords,
users: ps.users,
caseSensitive: ps.caseSensitive,
localOnly: ps.localOnly,
excludeBots: ps.excludeBots,
excludeNotesInSensitiveChannel: ps.excludeNotesInSensitiveChannel,
useRegex: ps.useRegex,
withReplies: ps.withReplies,
withFile: ps.withFile,
});
this.globalEventService.publishInternalEvent('antennaCreated', antenna);
return antenna;
}
@bindThis
public async checkHitAntenna(antenna: MiAntenna, note: (MiNote | Packed<'Note'>), noteUser: { id: MiUser['id']; username: string; host: string | null; isBot: boolean; }): Promise<boolean> {
if (antenna.excludeNotesInSensitiveChannel && note.channel?.isSensitive) return false;
public async update(
ps: {
antennaId: string;
name?: string;
src?: AntennaSource;
keywords?: string[][];
excludeKeywords?: string[][];
users?: string[];
caseSensitive?: boolean;
localOnly?: boolean;
excludeBots?: boolean;
excludeNotesInSensitiveChannel?: boolean;
useRegex?: boolean;
withReplies?: boolean;
withFile?: boolean;
},
me: MiUser,
): Promise<MiAntenna> {
this.validateEmptyKeyWord({
keywords: ps.keywords ?? [],
excludeKeywords: ps.excludeKeywords ?? [],
});
if (antenna.excludeBots && noteUser.isBot) return false;
this.validateRegexPattern({
keywords: ps.keywords ?? [],
excludeKeywords: ps.excludeKeywords ?? [],
useRegex: ps.useRegex,
});
if (antenna.localOnly && noteUser.host != null) return false;
const antenna = await this.antennasRepository.findOneBy({
id: ps.antennaId,
userId: me.id,
});
if (antenna == null) {
throw new AntennaService.AntennaNotFoundError;
}
if (!antenna.withReplies && note.replyId != null) return false;
await this.antennasRepository.update(antenna.id, {
name: ps.name,
src: ps.src,
keywords: ps.keywords,
excludeKeywords: ps.excludeKeywords,
users: ps.users,
caseSensitive: ps.caseSensitive,
localOnly: ps.localOnly,
excludeBots: ps.excludeBots,
excludeNotesInSensitiveChannel: ps.excludeNotesInSensitiveChannel,
useRegex: ps.useRegex,
withReplies: ps.withReplies,
withFile: ps.withFile,
isActive: true,
lastUsedAt: new Date(),
});
if (note.visibility === 'specified') {
if (note.userId !== antenna.userId) {
if (note.visibleUserIds == null) return false;
if (!note.visibleUserIds.includes(antenna.userId)) return false;
this.globalEventService.publishInternalEvent('antennaUpdated', await this.antennasRepository.findOneByOrFail({ id: antenna.id }));
return antenna;
}
@bindThis
private validateEmptyKeyWord(
ps: {
keywords: string[][];
excludeKeywords: string[][];
},
) {
if (ps.keywords.flat().every(x => x === '') && ps.excludeKeywords.flat().every(x => x === '')) {
throw new AntennaService.EmptyKeyWordError;
}
}
@bindThis
private validateRegexPattern(
ps: {
keywords: string[][];
excludeKeywords: string[][];
useRegex?: boolean;
},
) {
if (!ps.useRegex) {
return;
}
// NOTE: 正規表現パターンの場合は2次元配列の2次元目0番地にパターンが格納されていることを前提にする
if (ps.keywords.length > 0 && ps.keywords.some(x => x.length !== 1)) {
throw new AntennaService.InvalidRegexPatternError();
}
if (ps.excludeKeywords.length > 0 && ps.excludeKeywords.some(x => x.length !== 1)) {
throw new AntennaService.InvalidRegexPatternError();
}
for (const keywords of [ps.keywords, ps.excludeKeywords]) {
for (const keyword of keywords) {
const regexp = keyword[0].match(/^\/(.+)\/(.*)$/);
if (!regexp) {
throw new AntennaService.InvalidRegexPatternError();
}
try {
new RE2(regexp[1], regexp[2]);
} catch (err) {
throw new AntennaService.InvalidRegexPatternError(err);
}
}
}
}
if (note.visibility === 'followers') {
const isFollowing = Object.hasOwn(await this.cacheService.userFollowingsCache.fetch(antenna.userId), note.userId);
if (!isFollowing && antenna.userId !== note.userId) return false;
}
@bindThis
private isIncludeUser(antenna: MiAntenna, noteUser: { username: string; host: string | null; }): boolean {
const antennaUserAccounts = antenna.users.map(x => {
const { username, host } = Acct.parse(x);
return this.utilityService.getFullApAccount(username, host).toLowerCase();
});
if (antenna.src === 'home') {
// TODO
} else if (antenna.src === 'list') {
if (antenna.userListId == null) return false;
const exists = await this.userListMembershipsRepository.exists({
where: {
userListId: antenna.userListId,
userId: note.userId,
},
});
if (!exists) return false;
} else if (antenna.src === 'users') {
const accts = antenna.users.map(x => {
const { username, host } = Acct.parse(x);
return this.utilityService.getFullApAccount(username, host).toLowerCase();
});
if (!accts.includes(this.utilityService.getFullApAccount(noteUser.username, noteUser.host).toLowerCase())) return false;
} else if (antenna.src === 'users_blacklist') {
const accts = antenna.users.map(x => {
const { username, host } = Acct.parse(x);
return this.utilityService.getFullApAccount(username, host).toLowerCase();
});
if (accts.includes(this.utilityService.getFullApAccount(noteUser.username, noteUser.host).toLowerCase())) return false;
}
const keywords = antenna.keywords
// Clean up
.map(xs => xs.filter(x => x !== ''))
.filter(xs => xs.length > 0);
if (keywords.length > 0) {
if (note.text == null && note.cw == null) return false;
const _text = (note.text ?? '') + '\n' + (note.cw ?? '');
const matched = keywords.some(and =>
and.every(keyword =>
antenna.caseSensitive
? _text.includes(keyword)
: _text.toLowerCase().includes(keyword.toLowerCase()),
));
if (!matched) return false;
}
const excludeKeywords = antenna.excludeKeywords
// Clean up
.map(xs => xs.filter(x => x !== ''))
.filter(xs => xs.length > 0);
if (excludeKeywords.length > 0) {
if (note.text == null && note.cw == null) return false;
const _text = (note.text ?? '') + '\n' + (note.cw ?? '');
const matched = excludeKeywords.some(and =>
and.every(keyword =>
antenna.caseSensitive
? _text.includes(keyword)
: _text.toLowerCase().includes(keyword.toLowerCase()),
));
if (matched) return false;
}
const noteUserAccount = this.utilityService.getFullApAccount(noteUser.username, noteUser.host).toLowerCase();
return antennaUserAccounts.includes(noteUserAccount);
}
@bindThis
public checkHitAntenna(
filter: AntennaFilter,
note: (MiNote | Packed<'Note'>),
noteUser: { id: MiUser['id']; username: string; host: string | null; isBot: boolean; },
): boolean {
const antenna = filter.src;
if (antenna.excludeNotesInSensitiveChannel && note.channel?.isSensitive) return false;
if (antenna.excludeBots && noteUser.isBot) return false;
if (antenna.localOnly && noteUser.host != null) return false;
if (!antenna.withReplies && note.replyId != null) return false;
if (antenna.withFile) {
if (note.fileIds && note.fileIds.length === 0) return false;
}
// TODO: eval expression
if (antenna.src === 'users') {
if (!this.isIncludeUser(antenna, noteUser)) return false;
} else if (antenna.src === 'users_blacklist') {
if (this.isIncludeUser(antenna, noteUser)) return false;
}
return true;
const _text = (note.text ?? '') + '\n' + (note.cw ?? '');
return filter.testKeywords(_text);
}
@bindThis
public async getAntennas() {
if (!this.antennasFetched) {
this.antennas = await this.antennasRepository.findBy({
isActive: true,
});
this.antennasFetched = true;
private async getFilters() {
if (!this.filtersFetched) {
const antennas = await this.antennasRepository.findBy({ isActive: true });
this.filters = antennas.map(createAntennaFilter);
this.filtersFetched = true;
}
return this.antennas;
return this.filters;
}
@bindThis
@ -226,7 +442,7 @@ export class AntennaService implements OnApplicationShutdown {
// Get MiAntenna[] from cache and filter to select antennas with the src user is in the users list
const srcUserAcct = this.utilityService.getFullApAccount(src.username, src.host).toLowerCase();
const antennasToMigrate = (await this.getAntennas()).filter(antenna => {
const antennasToMigrate = (await this.getFilters()).map(it => it.src).filter(antenna => {
return antenna.users.some(user => {
const { username, host } = Acct.parse(user);
return this.utilityService.getFullApAccount(username, host).toLowerCase() === srcUserAcct;

1
packages/backend/src/core/entities/AntennaEntityService.ts
View File

@ -39,6 +39,7 @@ export class AntennaEntityService {
caseSensitive: antenna.caseSensitive,
localOnly: antenna.localOnly,
excludeBots: antenna.excludeBots,
useRegex: antenna.useRegex,
withReplies: antenna.withReplies,
withFile: antenna.withFile,
excludeNotesInSensitiveChannel: antenna.excludeNotesInSensitiveChannel,

34
packages/backend/src/models/Antenna.ts
View File

@ -3,10 +3,20 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import { PrimaryColumn, Entity, Index, JoinColumn, Column, ManyToOne } from 'typeorm';
import { id } from './util/id.js';
import { Column, Entity, Index, JoinColumn, ManyToOne, PrimaryColumn } from 'typeorm';
import { Serialized } from '@/types.js';
import { MiUser } from './User.js';
import { MiUserList } from './UserList.js';
import { id } from './util/id.js';
export const antennaSources = [
'all',
'users',
'users_blacklist',
// 'home', // TODO
// 'list', // NOTE: フォローしているユーザーのノート、リストのユーザーのノート、グループのユーザーのノート指定はパフォーマンス上の理由で無効になっている
] as const;
export type AntennaSource = typeof antennaSources[number];
@Entity('antenna')
export class MiAntenna {
@ -36,8 +46,8 @@ export class MiAntenna {
})
public name: string;
@Column('enum', { enum: ['home', 'all', 'users', 'list', 'users_blacklist'] })
public src: 'home' | 'all' | 'users' | 'list' | 'users_blacklist';
@Column('enum', { enum: antennaSources })
public src: AntennaSource;
@Column({
...id(),
@ -105,4 +115,20 @@ export class MiAntenna {
default: false,
})
public excludeNotesInSensitiveChannel: boolean;
@Column('boolean', {
default: false,
})
public useRegex: boolean;
public static deserialize(data: Serialized<MiAntenna>): MiAntenna {
return {
...data,
lastUsedAt: new Date(data.lastUsedAt),
// クエリビルダで明示的にSELECT/JOINしないかぎり設定されない値なのでnullにしておく
user: null,
// クエリビルダで明示的にSELECT/JOINしないかぎり設定されない値なのでnullにしておく
userList: null,
};
}
}

8
packages/backend/src/models/json-schema/antenna.ts
View File

@ -3,6 +3,8 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import { antennaSources } from '@/models/Antenna.js';
export const packedAntennaSchema = {
type: 'object',
properties: {
@ -47,7 +49,7 @@ export const packedAntennaSchema = {
src: {
type: 'string',
optional: false, nullable: false,
enum: ['home', 'all', 'users', 'list', 'users_blacklist'],
enum: antennaSources,
},
userListId: {
type: 'string',
@ -72,6 +74,10 @@ export const packedAntennaSchema = {
optional: false, nullable: false,
default: false,
},
useRegex: {
type: 'boolean',
optional: false, nullable: false,
},
excludeBots: {
type: 'boolean',
optional: false, nullable: false,

129
packages/backend/src/server/api/endpoints/antennas/create.ts
View File

@ -3,14 +3,11 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import { Inject, Injectable } from '@nestjs/common';
import { Endpoint } from '@/server/api/endpoint-base.js';
import { IdService } from '@/core/IdService.js';
import type { UserListsRepository, AntennasRepository } from '@/models/_.js';
import { GlobalEventService } from '@/core/GlobalEventService.js';
import { Injectable } from '@nestjs/common';
import { AntennaService } from '@/core/AntennaService.js';
import { AntennaEntityService } from '@/core/entities/AntennaEntityService.js';
import { DI } from '@/di-symbols.js';
import { RoleService } from '@/core/RoleService.js';
import { antennaSources } from '@/models/Antenna.js';
import { Endpoint } from '@/server/api/endpoint-base.js';
import { ApiError } from '../../error.js';
export const meta = {
@ -40,6 +37,13 @@ export const meta = {
code: 'EMPTY_KEYWORD',
id: '53ee222e-1ddd-4f9a-92e5-9fb82ddb463a',
},
invalidRegexPattern: {
message: 'Invalid regex pattern.',
code: 'INVALID_REGEX_PATTERN',
id: 'b06d08f4-6434-5faa-0fdd-a2aaf85e9de7',
httpStatusCode: 400,
},
},
res: {
@ -53,93 +57,66 @@ export const paramDef = {
type: 'object',
properties: {
name: { type: 'string', minLength: 1, maxLength: 100 },
src: { type: 'string', enum: ['home', 'all', 'users', 'list', 'users_blacklist'] },
userListId: { type: 'string', format: 'misskey:id', nullable: true },
keywords: { type: 'array', items: {
type: 'array', items: {
type: 'string',
src: { type: 'string', enum: antennaSources },
keywords: {
type: 'array',
items: {
type: 'array',
items: { type: 'string' },
},
} },
excludeKeywords: { type: 'array', items: {
type: 'array', items: {
type: 'string',
},
excludeKeywords: {
type: 'array',
items: {
type: 'array',
items: { type: 'string' },
},
} },
users: { type: 'array', items: {
type: 'string',
} },
},
users: {
type: 'array',
items: { type: 'string' },
},
caseSensitive: { type: 'boolean' },
localOnly: { type: 'boolean' },
excludeBots: { type: 'boolean' },
useRegex: { type: 'boolean' },
withReplies: { type: 'boolean' },
withFile: { type: 'boolean' },
excludeNotesInSensitiveChannel: { type: 'boolean' },
},
required: ['name', 'src', 'keywords', 'excludeKeywords', 'users', 'caseSensitive', 'withReplies', 'withFile'],
required: [
'name',
'src',
'keywords',
'excludeKeywords',
'users',
'caseSensitive',
'withReplies',
'withFile',
],
} as const;
@Injectable()
export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export
constructor(
@Inject(DI.antennasRepository)
private antennasRepository: AntennasRepository,
@Inject(DI.userListsRepository)
private userListsRepository: UserListsRepository,
private antennaEntityService: AntennaEntityService,
private roleService: RoleService,
private idService: IdService,
private globalEventService: GlobalEventService,
private readonly antennaEntityService: AntennaEntityService,
private readonly antennaService: AntennaService,
) {
super(meta, paramDef, async (ps, me) => {
if (ps.keywords.flat().every(x => x === '') && ps.excludeKeywords.flat().every(x => x === '')) {
throw new ApiError(meta.errors.emptyKeyword);
}
const currentAntennasCount = await this.antennasRepository.countBy({
userId: me.id,
});
if (currentAntennasCount >= (await this.roleService.getUserPolicies(me.id)).antennaLimit) {
throw new ApiError(meta.errors.tooManyAntennas);
}
let userList;
if (ps.src === 'list' && ps.userListId) {
userList = await this.userListsRepository.findOneBy({
id: ps.userListId,
userId: me.id,
});
if (userList == null) {
throw new ApiError(meta.errors.noSuchUserList);
try {
const antenna = await this.antennaService.create(ps, me);
return this.antennaEntityService.pack(antenna);
} catch (e) {
if (e instanceof AntennaService.EmptyKeyWordError) {
throw new ApiError(meta.errors.emptyKeyword);
} else if (e instanceof AntennaService.TooManyAntennasError) {
throw new ApiError(meta.errors.tooManyAntennas);
} else if (e instanceof AntennaService.InvalidRegexPatternError) {
throw new ApiError(meta.errors.invalidRegexPattern);
} else {
throw e;
}
}
const now = new Date();
const antenna = await this.antennasRepository.insertOne({
id: this.idService.gen(now.getTime()),
lastUsedAt: now,
userId: me.id,
name: ps.name,
src: ps.src,
userListId: userList ? userList.id : null,
keywords: ps.keywords,
excludeKeywords: ps.excludeKeywords,
users: ps.users,
caseSensitive: ps.caseSensitive,
localOnly: ps.localOnly,
excludeBots: ps.excludeBots,
withReplies: ps.withReplies,
withFile: ps.withFile,
excludeNotesInSensitiveChannel: ps.excludeNotesInSensitiveChannel,
});
this.globalEventService.publishInternalEvent('antennaCreated', antenna);
return await this.antennaEntityService.pack(antenna);
});
}
}

106
packages/backend/src/server/api/endpoints/antennas/update.ts
View File

@ -4,6 +4,8 @@
*/
import { Inject, Injectable } from '@nestjs/common';
import { AntennaService } from '@/core/AntennaService.js';
import { antennaSources } from '@/models/Antenna.js';
import { Endpoint } from '@/server/api/endpoint-base.js';
import type { AntennasRepository, UserListsRepository } from '@/models/_.js';
import { GlobalEventService } from '@/core/GlobalEventService.js';
@ -38,6 +40,13 @@ export const meta = {
code: 'EMPTY_KEYWORD',
id: '721aaff6-4e1b-4d88-8de6-877fae9f68c4',
},
invalidRegexPattern: {
message: 'Invalid regex pattern.',
code: 'INVALID_REGEX_PATTERN',
id: 'dbb44ec3-5d15-508d-e6b2-71f3794c6a41',
httpStatusCode: 400,
},
},
res: {
@ -52,24 +61,29 @@ export const paramDef = {
properties: {
antennaId: { type: 'string', format: 'misskey:id' },
name: { type: 'string', minLength: 1, maxLength: 100 },
src: { type: 'string', enum: ['home', 'all', 'users', 'list', 'users_blacklist'] },
userListId: { type: 'string', format: 'misskey:id', nullable: true },
keywords: { type: 'array', items: {
type: 'array', items: {
type: 'string',
src: { type: 'string', enum: antennaSources },
keywords: {
type: 'array',
items: {
type: 'array',
items: { type: 'string' },
},
} },
excludeKeywords: { type: 'array', items: {
type: 'array', items: {
type: 'string',
},
excludeKeywords: {
type: 'array',
items: {
type: 'array',
items: { type: 'string' },
},
} },
users: { type: 'array', items: {
type: 'string',
} },
},
users: {
type: 'array',
items: { type: 'string' },
},
caseSensitive: { type: 'boolean' },
localOnly: { type: 'boolean' },
excludeBots: { type: 'boolean' },
useRegex: { type: 'boolean' },
withReplies: { type: 'boolean' },
withFile: { type: 'boolean' },
excludeNotesInSensitiveChannel: { type: 'boolean' },
@ -80,64 +94,24 @@ export const paramDef = {
@Injectable()
export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export
constructor(
@Inject(DI.antennasRepository)
private antennasRepository: AntennasRepository,
@Inject(DI.userListsRepository)
private userListsRepository: UserListsRepository,
private antennaEntityService: AntennaEntityService,
private globalEventService: GlobalEventService,
private readonly antennaEntityService: AntennaEntityService,
private readonly antennaService: AntennaService,
) {
super(meta, paramDef, async (ps, me) => {
if (ps.keywords && ps.excludeKeywords) {
if (ps.keywords.flat().every(x => x === '') && ps.excludeKeywords.flat().every(x => x === '')) {
try {
const antenna = await this.antennaService.update(ps, me);
return this.antennaEntityService.pack(antenna);
} catch (e) {
if (e instanceof AntennaService.EmptyKeyWordError) {
throw new ApiError(meta.errors.emptyKeyword);
} else if (e instanceof AntennaService.AntennaNotFoundError) {
throw new ApiError(meta.errors.noSuchAntenna);
} else if (e instanceof AntennaService.InvalidRegexPatternError) {
throw new ApiError(meta.errors.invalidRegexPattern);
} else {
throw e;
}
}
// Fetch the antenna
const antenna = await this.antennasRepository.findOneBy({
id: ps.antennaId,
userId: me.id,
});
if (antenna == null) {
throw new ApiError(meta.errors.noSuchAntenna);
}
let userList;
if ((ps.src === 'list' || antenna.src === 'list') && ps.userListId) {
userList = await this.userListsRepository.findOneBy({
id: ps.userListId,
userId: me.id,
});
if (userList == null) {
throw new ApiError(meta.errors.noSuchUserList);
}
}
await this.antennasRepository.update(antenna.id, {
name: ps.name,
src: ps.src,
userListId: ps.userListId !== undefined ? userList ? userList.id : null : undefined,
keywords: ps.keywords,
excludeKeywords: ps.excludeKeywords,
users: ps.users,
caseSensitive: ps.caseSensitive,
localOnly: ps.localOnly,
excludeBots: ps.excludeBots,
withReplies: ps.withReplies,
withFile: ps.withFile,
excludeNotesInSensitiveChannel: ps.excludeNotesInSensitiveChannel,
isActive: true,
lastUsedAt: new Date(),
});
this.globalEventService.publishInternalEvent('antennaUpdated', await this.antennasRepository.findOneByOrFail({ id: antenna.id }));
return await this.antennaEntityService.pack(antenna.id);
});
}
}

65
packages/frontend/src/components/MkAntennaEditor.vue
View File

@ -13,21 +13,16 @@ SPDX-License-Identifier: AGPL-3.0-only
<MkSelect v-model="src">
<template #label>{{ i18n.ts.antennaSource }}</template>
<option value="all">{{ i18n.ts._antennaSources.all }}</option>
<!--<option value="home">{{ i18n.ts._antennaSources.homeTimeline }}</option>-->
<option value="users">{{ i18n.ts._antennaSources.users }}</option>
<!--<option value="list">{{ i18n.ts._antennaSources.userList }}</option>-->
<option value="users_blacklist">{{ i18n.ts._antennaSources.userBlacklist }}</option>
</MkSelect>
<MkSelect v-if="src === 'list'" v-model="userListId">
<template #label>{{ i18n.ts.userList }}</template>
<option v-for="list in userLists" :key="list.id" :value="list.id">{{ list.name }}</option>
</MkSelect>
<MkTextarea v-else-if="src === 'users' || src === 'users_blacklist'" v-model="users">
<MkTextarea v-if="src === 'users' || src === 'users_blacklist'" v-model="users">
<template #label>{{ i18n.ts.users }}</template>
<template #caption>{{ i18n.ts.antennaUsersDescription }} <button class="_textButton" @click="addUser">{{ i18n.ts.addUser }}</button></template>
</MkTextarea>
<MkSwitch v-model="excludeBots">{{ i18n.ts.antennaExcludeBots }}</MkSwitch>
<MkSwitch v-model="withReplies">{{ i18n.ts.withReplies }}</MkSwitch>
<MkSwitch v-model="useRegex">{{ i18n.ts.antennaUseRegex }}</MkSwitch>
<MkTextarea v-model="keywords">
<template #label>{{ i18n.ts.antennaKeywords }}</template>
<template #caption>{{ i18n.ts.antennaKeywordsDescription }}</template>
@ -88,6 +83,7 @@ const initialAntenna = deepMerge<PartialAllowedAntenna>(props.antenna ?? {}, {
localOnly: false,
withFile: false,
excludeNotesInSensitiveChannel: false,
useRegex: false,
isActive: true,
hasUnreadNote: false,
notify: false,
@ -109,17 +105,51 @@ const caseSensitive = ref<boolean>(initialAntenna.caseSensitive);
const localOnly = ref<boolean>(initialAntenna.localOnly);
const excludeBots = ref<boolean>(initialAntenna.excludeBots);
const withReplies = ref<boolean>(initialAntenna.withReplies);
const useRegex = ref<boolean>(initialAntenna.useRegex);
const withFile = ref<boolean>(initialAntenna.withFile);
const excludeNotesInSensitiveChannel = ref<boolean>(initialAntenna.excludeNotesInSensitiveChannel);
const userLists = ref<Misskey.entities.UserList[] | null>(null);
watch(() => src.value, async () => {
if (src.value === 'list' && userLists.value === null) {
userLists.value = await misskeyApi('users/lists/list');
}
});
async function saveAntenna() {
const _keywords: string[][] = [];
const _excludeKeywords: string[][] = [];
if (useRegex.value) {
function checkRegExError(words: string[], type: string) {
const errLineNumbers = words
.map((x, i) => {
try {
// RE2にしてバックエンドと揃える？
new RegExp(x);
return null;
} catch {
return i + 1;
}
})
.filter(x => x != null);
if (errLineNumbers.length > 0) {
os.alert({
type: 'error',
text: i18n.tsx.antennaUseRegexError({ src: type, line: errLineNumbers.join(', ') }),
});
return false;
}
return true;
}
const keywordsDraft = keywords.value.trim().split('\n').map(x => x.trim()).filter(x => x.length > 0);
if (!checkRegExError(keywordsDraft, i18n.ts.antennaKeywords)) return;
const excludeKeywordsDraft = excludeKeywords.value.trim().split('\n').map(x => x.trim()).filter(x => x.length > 0);
if (!checkRegExError(excludeKeywordsDraft, i18n.ts.antennaExcludeKeywords)) return;
_keywords.push(...keywordsDraft.map(x => [x]));
_excludeKeywords.push(...excludeKeywordsDraft.map(x => [x]));
} else {
_keywords.push(...keywords.value.trim().split('\n').map(x => x.trim().split(' ')).filter(x => x.length > 0));
_excludeKeywords.push(...excludeKeywords.value.trim().split('\n').map(x => x.trim().split(' ')).filter(x => x.length > 0));
}
const antennaData = {
name: name.value,
src: src.value,
@ -130,9 +160,10 @@ async function saveAntenna() {
excludeNotesInSensitiveChannel: excludeNotesInSensitiveChannel.value,
caseSensitive: caseSensitive.value,
localOnly: localOnly.value,
users: users.value.trim().split('\n').map(x => x.trim()),
keywords: keywords.value.trim().split('\n').map(x => x.trim().split(' ')),
excludeKeywords: excludeKeywords.value.trim().split('\n').map(x => x.trim().split(' ')),
useRegex: useRegex.value,
users: users.value.trim().split('\n').map(x => x.trim()).filter(x => x.length > 0),
keywords: _keywords,
excludeKeywords: _excludeKeywords,
};
if (initialAntenna.id == null) {

13
packages/misskey-js/src/autogen/types.ts
View File

@ -4934,7 +4934,7 @@ export type components = {
keywords: string[][];
excludeKeywords: string[][];
/** @enum {string} */
src: 'home' | 'all' | 'users' | 'list' | 'users_blacklist';
src: 'all' | 'users' | 'users_blacklist';
/** Format: id */
userListId: string | null;
users: string[];
@ -4942,6 +4942,7 @@ export type components = {
caseSensitive: boolean;
/** @default false */
localOnly: boolean;
useRegex: boolean;
/** @default false */
excludeBots: boolean;
/** @default false */
@ -11711,15 +11712,14 @@ export type operations = {
'application/json': {
name: string;
/** @enum {string} */
src: 'home' | 'all' | 'users' | 'list' | 'users_blacklist';
/** Format: misskey:id */
userListId?: string | null;
src: 'all' | 'users' | 'users_blacklist';
keywords: string[][];
excludeKeywords: string[][];
users: string[];
caseSensitive: boolean;
localOnly?: boolean;
excludeBots?: boolean;
useRegex?: boolean;
withReplies: boolean;
withFile: boolean;
excludeNotesInSensitiveChannel?: boolean;
@ -11993,15 +11993,14 @@ export type operations = {
antennaId: string;
name?: string;
/** @enum {string} */
src?: 'home' | 'all' | 'users' | 'list' | 'users_blacklist';
/** Format: misskey:id */
userListId?: string | null;
src?: 'all' | 'users' | 'users_blacklist';
keywords?: string[][];
excludeKeywords?: string[][];
users?: string[];
caseSensitive?: boolean;
localOnly?: boolean;
excludeBots?: boolean;
useRegex?: boolean;
withReplies?: boolean;
withFile?: boolean;
excludeNotesInSensitiveChannel?: boolean;