Add partial blacklist item

src/shared/settings/Blacklist.ts

@@ -1,39 +1,117 @@
-export type BlacklistJSON = string[];
+export type BlacklistItemJSON = string | {
+  url: string,
+  keys: string[],
+};
 
-const fromWildcard = (pattern: string): RegExp => {
+export type BlacklistJSON = BlacklistItemJSON[];
+
+const regexFromWildcard = (pattern: string): RegExp => {
   let regexStr = '^' + pattern.replace(/\*/g, '.*') + '$';
   return new RegExp(regexStr);
 };
 
+const isArrayOfString = (raw: any): boolean => {
+  if (!Array.isArray(raw)) {
+    return false;
+  }
+  for (let x of Array.from(raw)) {
+    if (typeof x !== 'string') {
+      return false;
+    }
+  }
+  return true;
+};
+
+export class BlacklistItem {
+  public readonly pattern: string;
+
+  private regex: RegExp;
+
+  public readonly partial: boolean;
+
+  public readonly keys: string[];
+
+  private constructor(
+    pattern: string,
+    partial: boolean,
+    keys: string[]
+  ) {
+    this.pattern = pattern;
+    this.regex = regexFromWildcard(pattern);
+    this.partial = partial;
+    this.keys = keys;
+  }
+
+  static fromJSON(raw: any): BlacklistItem {
+    if (typeof raw === 'string') {
+      return new BlacklistItem(raw, false, []);
+    } else if (typeof raw === 'object' && raw !== null) {
+      if (!('url' in raw)) {
+        throw new TypeError(
+          `missing field "url" of blacklist item: ${JSON.stringify(raw)}`);
+      }
+      if (typeof raw.url !== 'string') {
+        throw new TypeError(
+          `invalid field "url" of blacklist item: ${JSON.stringify(raw)}`);
+      }
+      if (!('keys' in raw)) {
+        throw new TypeError(
+          `missing field "keys" of blacklist item: ${JSON.stringify(raw)}`);
+      }
+      if (!isArrayOfString(raw.keys)) {
+        throw new TypeError(
+          `invalid field "keys" of blacklist item: ${JSON.stringify(raw)}`);
+      }
+      return new BlacklistItem(raw.url as string, true, raw.keys as string[]);
+    }
+    throw new TypeError(
+      `invalid format of blacklist item: ${JSON.stringify(raw)}`);
+  }
+
+  toJSON(): BlacklistItemJSON {
+    if (!this.partial) {
+      return this.pattern;
+    }
+    return { url: this.pattern, keys: this.keys };
+  }
+
+  matches(url: URL): boolean {
+    return this.pattern.includes('/')
+      ? this.regex.test(url.host + url.pathname)
+      : this.regex.test(url.host);
+  }
+
+  includeKey(url: URL, keys: string): boolean {
+    if (!this.matches(url)) {
+      return false;
+    }
+    return !this.partial || this.keys.includes(keys);
+  }
+}
+
 export default class Blacklist {
   constructor(
-    private blacklist: string[],
+    private blacklist: BlacklistItem[],
   ) {
   }
 
   static fromJSON(json: any): Blacklist {
     if (!Array.isArray(json)) {
-      throw new TypeError(`"blacklist" is not an array of string`);
+      throw new TypeError('blacklist is not an array: ' + JSON.stringify(json));
     }
-    for (let x of json) {
-      if (typeof x !== 'string') {
-        throw new TypeError(`"blacklist" is not an array of string`);
-      }
-    }
-    return new Blacklist(json);
+    let items = Array.from(json).map(item => BlacklistItem.fromJSON(item));
+    return new Blacklist(items);
   }
 
   toJSON(): BlacklistJSON {
-    return this.blacklist;
+    return this.blacklist.map(item => item.toJSON());
   }
 
-  includes(url: string): boolean {
-    let u = new URL(url);
-    return this.blacklist.some((item) => {
-      if (!item.includes('/')) {
-        return fromWildcard(item).test(u.host);
-      }
-      return fromWildcard(item).test(u.host + u.pathname);
-    });
+  includesEntireBlacklist(url: URL): boolean {
+    return this.blacklist.some(item => !item.partial && item.matches(url));
+  }
+
+  includeKey(url: URL, key: string) {
+    return this.blacklist.some(item => item.includeKey(url, key));
   }
 }