youtube-music/plugins/adblocker/blocker.ts

// Used for caching
import path from 'node:path';
import fs, { promises } from 'node:fs';

import { ElectronBlocker } from '@cliqz/adblocker-electron';
import { app } from 'electron';

const SOURCES = [
  'https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt',
  // UBlock Origin
  'https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters.txt',
  'https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters-2020.txt',
  'https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters-2021.txt',
  'https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters-2022.txt',
  'https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters-2023.txt',
  // Fanboy Annoyances
  'https://secure.fanboy.co.nz/fanboy-annoyance_ubo.txt',
];

export const loadAdBlockerEngine = (
  session: Electron.Session | undefined = undefined,
  cache = true,
  additionalBlockLists = [],
  disableDefaultLists: boolean | unknown[] = false,
) => {
  // Only use cache if no additional blocklists are passed
  let cacheDirectory: string;
  if (app.isPackaged) {
    cacheDirectory = path.join(app.getPath('userData'), 'adblock_cache');
  } else {
    cacheDirectory = path.resolve(__dirname, 'adblock_cache');
  }
  if (!fs.existsSync(cacheDirectory)) {
    fs.mkdirSync(cacheDirectory);
  }
  const cachingOptions
    = cache && additionalBlockLists.length === 0
    ? {
      path: path.join(cacheDirectory, 'adblocker-engine.bin'),
      read: promises.readFile,
      write: promises.writeFile,
    }
    : undefined;
  const lists = [
    ...(
      (disableDefaultLists && !Array.isArray(disableDefaultLists)) ||
      (Array.isArray(disableDefaultLists) && disableDefaultLists.length > 0) ? [] : SOURCES
    ),
    ...additionalBlockLists,
  ];

  ElectronBlocker.fromLists(
    fetch,
    lists,
    {
      // When generating the engine for caching, do not load network filters
      // So that enhancing the session works as expected
      // Allowing to define multiple webRequest listeners
      loadNetworkFilters: session !== undefined,
    },
    cachingOptions,
  )
    .then((blocker) => {
      if (session) {
        blocker.enableBlockingInSession(session);
      } else {
        console.log('Successfully generated adBlocker engine.');
      }
    })
    .catch((error) => console.log('Error loading adBlocker engine', error));
};

export default { loadAdBlockerEngine };