Format blocker file + use window session in adblocker

Add options and tray

.travis.yml

@@ -1,16 +1,14 @@
-matrix:
+language: node_js
+node_js: "10"
+env:
+  - ELECTRON_CACHE=$HOME/.cache/electron ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
+
+jobs:
   include:
     - os: osx
-      osx_image: xcode9.4
-      language: node_js
-      node_js: "10"
-      env:
-        - ELECTRON_CACHE=$HOME/.cache/electron
-        - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
-
+      osx_image: xcode11.3
     - os: linux
-      services: docker
-      language: generic
+      dist: xenial
 
 cache:
   yarn: false
@@ -21,24 +19,16 @@ cache:
 script:
   - |
     if [ "$TRAVIS_OS_NAME" == "linux" ]; then
-      docker run --rm \
-        $(env | \
-          grep -Eo '^[^\s=]*(DEBUG|NODE_|ELECTRON_|YARN_|NPM_|CI|CIRCLE|TRAVIS|APPVEYOR_|CSC_|_TOKEN|_KEY|AWS_|STRIP|BUILD_)[^\s=]*' | \
-          sed '/^$/d;s/^/-e /' | \
-          paste -sd ' ' \
-        ) \
-        -v ${PWD}:/project \
-        -v ~/.cache/electron:/root/.cache/electron \
-        -v ~/.cache/electron-builder:/root/.cache/electron-builder \
-        electronuserland/builder:10 \
-        /bin/bash -c "yarn && npm run release:linux"
+      yarn run release:linux
     else
-      npm run release:mac
+      yarn run release:mac
     fi
 before_cache:
   - rm -rf $HOME/.cache/electron-builder
 before_install:
   - rm -rf node_modules
+  # Install dependencies
+  - travis_wait 30 yarn --frozen-lockfile
 
 branches:
   except:

appveyor.yml

@@ -1,4 +1,4 @@
-image: Visual Studio 2017
+image: Visual Studio 2019
 
 platform:
   - x64
@@ -11,8 +11,15 @@ init:
   - git config --global core.autocrlf input
 
 install:
+  # Install node
   - ps: Install-Product node 10 x64
-  - yarn
+  # Install dependencies
+  - yarn --frozen-lockfile
+
+# on_finish:
+#   # Enable RDP to the build worker (using APPVEYOR_RDP_PASSWORD env var)
+#   # https://www.appveyor.com/docs/how-to/rdp-to-build-worker/
+#   - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
 
 build_script:
   - yarn run release:win

index.js

@@ -1,13 +1,19 @@
 "use strict";
 const path = require("path");
 
-const electron        = require("electron");
-const is              = require("electron-is");
+const electron = require("electron");
+const is = require("electron-is");
 const { autoUpdater } = require("electron-updater");
 
-const { setApplicationMenu }       = require("./menu");
-const { getEnabledPlugins, store } = require("./store");
-const { fileExists, injectCSS }    = require("./plugins/utils");
+const { setApplicationMenu } = require("./menu");
+const {
+	autoUpdate,
+	getEnabledPlugins,
+	isAppVisible,
+	store,
+} = require("./store");
+const { fileExists, injectCSS } = require("./plugins/utils");
+const { setUpTray } = require("./tray");
 
 const app = electron.app;
 
@@ -32,23 +38,23 @@ function onClosed() {
 }
 
 function createMainWindow() {
-	const windowSize      = store.get("window-size");
+	const windowSize = store.get("window-size");
 	const windowMaximized = store.get("window-maximized");
 
 	const win = new electron.BrowserWindow({
-		icon           : icon,
-		width          : windowSize.width,
-		height         : windowSize.height,
+		icon: icon,
+		width: windowSize.width,
+		height: windowSize.height,
 		backgroundColor: "#000",
-		show           : false,
-		webPreferences : {
-			nodeIntegration : false,
-			preload         : path.join(__dirname, "preload.js"),
-			nativeWindowOpen: true,                                 // window.open return Window object(like in regular browsers), not BrowserWindowProxy
-			affinity        : "main-window"                         // main window, and addition windows should work in one process
+		show: false,
+		webPreferences: {
+			nodeIntegration: false,
+			preload: path.join(__dirname, "preload.js"),
+			nativeWindowOpen: true, // window.open return Window object(like in regular browsers), not BrowserWindowProxy
+			affinity: "main-window", // main window, and addition windows should work in one process
 		},
-		frame        : !is.macOS(),
-		titleBarStyle: is.macOS() ? "hiddenInset": "default"
+		frame: !is.macOS(),
+		titleBarStyle: is.macOS() ? "hiddenInset" : "default",
 	});
 	if (windowMaximized) {
 		win.maximize();
@@ -65,7 +71,7 @@ function createMainWindow() {
 		}
 	});
 
-	getEnabledPlugins().forEach(plugin => {
+	getEnabledPlugins().forEach((plugin) => {
 		console.log("Loaded plugin - " + plugin);
 		const pluginPath = path.join(__dirname, "plugins", plugin, "back.js");
 		fileExists(pluginPath, () => {
@@ -88,6 +94,21 @@ function createMainWindow() {
 		}
 	});
 
+	win.webContents.on("will-navigate", (_, url) => {
+		if (url.startsWith("https://accounts.google.com")) {
+			// Force user-agent "Firefox Windows" for Google OAuth to work
+			// From https://github.com/firebase/firebase-js-sdk/issues/2478#issuecomment-571356751
+			// Only set on accounts.google.com, otherwise querySelectors in preload scripts fail (?)
+			const userAgent =
+				"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:70.0) Gecko/20100101 Firefox/70.0";
+
+			win.webContents.session.webRequest.onBeforeSendHeaders((details, cb) => {
+				details.requestHeaders["User-Agent"] = userAgent;
+				cb({ requestHeaders: details.requestHeaders });
+			});
+		}
+	});
+
 	win.webContents.on(
 		"new-window",
 		(e, url, frameName, disposition, options) => {
@@ -114,7 +135,9 @@ function createMainWindow() {
 	});
 
 	win.once("ready-to-show", () => {
-		win.show();
+		if (isAppVisible()) {
+			win.show();
+		}
 	});
 
 	return win;
@@ -142,16 +165,18 @@ app.on("activate", () => {
 app.on("ready", () => {
 	setApplicationMenu();
 	mainWindow = createMainWindow();
-	if (!is.dev()) {
+	setUpTray(app, mainWindow);
+
+	if (!is.dev() && autoUpdate()) {
 		autoUpdater.checkForUpdatesAndNotify();
 		autoUpdater.on("update-available", () => {
 			const dialogOpts = {
-				type   : "info",
+				type: "info",
 				buttons: ["OK"],
-				title  : "Application Update",
+				title: "Application Update",
 				message: "A new version is available",
-				detail : 
-					"A new version is available and can be downloaded at https://github.com/th-ch/youtube-music/releases/latest"
+				detail:
+					"A new version is available and can be downloaded at https://github.com/th-ch/youtube-music/releases/latest",
 			};
 			electron.dialog.showMessageBox(dialogOpts);
 		});
@@ -159,11 +184,15 @@ app.on("ready", () => {
 
 	// Optimized for Mac OS X
 	if (process.platform === "darwin") {
+		if (!isAppVisible()) {
+			app.dock.hide();
+		}
+
 		var forceQuit = false;
 		app.on("before-quit", () => {
 			forceQuit = true;
 		});
-		mainWindow.on("close", event => {
+		mainWindow.on("close", (event) => {
 			if (!forceQuit) {
 				event.preventDefault();
 				mainWindow.hide();

menu.js

@@ -1,33 +1,79 @@
 const { app, Menu } = require("electron");
 
-const { getAllPlugins }                                = require("./plugins/utils");
-const { isPluginEnabled, enablePlugin, disablePlugin } = require("./store");
+const { getAllPlugins } = require("./plugins/utils");
+const {
+	isPluginEnabled,
+	enablePlugin,
+	disablePlugin,
+	autoUpdate,
+	isAppVisible,
+	isTrayEnabled,
+	setOptions,
+} = require("./store");
 
-module.exports.setApplicationMenu = () => {
-	const menuTemplate = [
-		{
-			label  : "Plugins",
-			submenu: getAllPlugins().map(plugin => {
-				return {
-					label  : plugin,
-					type   : "checkbox",
-					checked: isPluginEnabled(plugin),
-					click  : item => {
-						if (item.checked) {
-							enablePlugin(plugin);
-						} else {
-							disablePlugin(plugin);
-						}
+const mainMenuTemplate = [
+	{
+		label: "Plugins",
+		submenu: getAllPlugins().map((plugin) => {
+			return {
+				label: plugin,
+				type: "checkbox",
+				checked: isPluginEnabled(plugin),
+				click: (item) => {
+					if (item.checked) {
+						enablePlugin(plugin);
+					} else {
+						disablePlugin(plugin);
 					}
-				};
-			})
-		}
-	];
+				},
+			};
+		}),
+	},
+	{
+		label: "Options",
+		submenu: [
+			{
+				label: "Auto-update",
+				type: "checkbox",
+				checked: autoUpdate(),
+				click: (item) => {
+					setOptions({ autoUpdates: item.checked });
+				},
+			},
+			{
+				label: "Tray",
+				submenu: [
+					{
+						label: "Disabled",
+						type: "radio",
+						checked: !isTrayEnabled(),
+						click: () => setOptions({ tray: false, appVisible: true }),
+					},
+					{
+						label: "Enabled + app visible",
+						type: "radio",
+						checked: isTrayEnabled() && isAppVisible(),
+						click: () => setOptions({ tray: true, appVisible: true }),
+					},
+					{
+						label: "Enabled + app hidden",
+						type: "radio",
+						checked: isTrayEnabled() && !isAppVisible(),
+						click: () => setOptions({ tray: true, appVisible: false }),
+					},
+				],
+			},
+		],
+	},
+];
 
+module.exports.mainMenuTemplate = mainMenuTemplate;
+module.exports.setApplicationMenu = () => {
+	const menuTemplate = [...mainMenuTemplate];
 	if (process.platform === "darwin") {
 		const name = app.getName();
 		menuTemplate.unshift({
-			label  : name,
+			label: name,
 			submenu: [
 				{ role: "about" },
 				{ type: "separator" },
@@ -36,9 +82,9 @@ module.exports.setApplicationMenu = () => {
 				{ role: "unhide" },
 				{ type: "separator" },
 				{
-					label      : "Select All",
+					label: "Select All",
 					accelerator: "CmdOrCtrl+A",
-					selector   : "selectAll:"
+					selector: "selectAll:",
 				},
 				{ label: "Cut", accelerator: "CmdOrCtrl+X", selector: "cut:" },
 				{ label: "Copy", accelerator: "CmdOrCtrl+C", selector: "copy:" },
@@ -46,8 +92,8 @@ module.exports.setApplicationMenu = () => {
 				{ type: "separator" },
 				{ role: "minimize" },
 				{ role: "close" },
-				{ role: "quit" }
-			]
+				{ role: "quit" },
+			],
 		});
 	}
 

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "youtube-music",
 	"productName": "YouTube Music",
-	"version": "1.2.0",
+	"version": "1.3.1",
 	"description": "YouTube Music Desktop App - including custom plugins",
 	"license": "MIT",
 	"repository": "th-ch/youtube-music",
@@ -30,36 +30,39 @@
 		"start": "electron .",
 		"icon": "rimraf assets/generated && electron-icon-maker --input=assets/youtube-music.png --output=assets/generated",
 		"generate:package": "node utils/generate-package-json.js",
-		"postinstall": "yarn run generate:package YoutubeNonStop && yarn run icon && npm rebuild && node plugins/adblocker/generator.js && electron-rebuild",
+		"postinstall": "yarn run icon && yarn run plugins",
 		"clean": "rimraf dist",
-		"build": "yarn run clean && build --win --mac --linux",
-		"build:mac": "yarn run clean && build --mac",
-		"build:win": "yarn run clean && build --win",
-		"release:linux": "yarn run clean && build --linux -p always",
-		"release:mac": "yarn run clean && build --mac -p always",
-		"release:win": "yarn run clean && build --win -p always"
+		"build": "yarn run clean && electron-builder --win --mac --linux",
+		"build:mac": "yarn run clean && electron-builder --mac",
+		"build:win": "yarn run clean && electron-builder --win",
+		"plugins": "yarn run plugin:adblocker && yarn run plugin:autoconfirm",
+		"plugin:adblocker": "rimraf plugins/adblocker/ad-blocker-engine.bin && node plugins/adblocker/blocker.js",
+		"plugin:autoconfirm": "yarn run generate:package YoutubeNonStop",
+		"release:linux": "yarn run clean && electron-builder --linux -p always -c.snap.publish=github",
+		"release:mac": "yarn run clean && electron-builder --mac -p always",
+		"release:win": "yarn run clean && electron-builder --win -p always"
 	},
 	"engines": {
 		"npm": "Please use yarn and not npm"
 	},
 	"dependencies": {
+		"@cliqz/adblocker-electron": "^1.14.1",
 		"YoutubeNonStop": "git://github.com/lawfx/YoutubeNonStop.git#v0.7.1",
-		"ad-block": "^4.1.3",
-		"electron-debug": "^2.2.0",
+		"electron-debug": "^3.0.1",
 		"electron-is": "^3.0.0",
 		"electron-localshortcut": "^3.2.1",
-		"electron-store": "^3.1.0",
-		"electron-updater": "^4.2.2"
+		"electron-store": "^5.1.1",
+		"electron-updater": "^4.2.2",
+		"node-fetch": "^2.6.0"
 	},
 	"devDependencies": {
 		"devtron": "^1.4.0",
-		"electron": "^4.0.8",
-		"electron-builder": "^20.40.2",
-		"electron-devtools-installer": "^2.2.4",
+		"electron": "^8.2.1",
+		"electron-builder": "^22.4.1",
+		"electron-devtools-installer": "^3.0.0",
 		"electron-icon-maker": "0.0.4",
-		"electron-rebuild": "^1.8.4",
-		"rimraf": "^2.6.3",
-		"xo": "^0.24.0"
+		"rimraf": "^3.0.2",
+		"xo": "^0.29.0"
 	},
 	"xo": {
 		"envs": [

plugins/adblocker/.gitignore

@@ -1 +1 @@
-detector.buffer
+/ad-blocker-engine.bin

plugins/adblocker/back.js

@@ -1,3 +1,2 @@
-const { blockWindowAds } = require("./blocker");
-
-module.exports = win => blockWindowAds(win.webContents);
+const { loadAdBlockerEngine } = require("./blocker");
+module.exports = (win) => loadAdBlockerEngine(win.webContents.session);

plugins/adblocker/blocker.js

@@ -1,12 +1,34 @@
-const { initialize, containsAds } = require("./contains-ads");
+const { promises } = require("fs"); // used for caching
+const path = require("path");
 
-module.exports.blockWindowAds = webContents => {
-	initialize();
-	webContents.session.webRequest.onBeforeRequest(
-		["*://*./*"],
-		(details, cb) => {
-			const shouldBeBlocked = containsAds(details.url);
-			cb({ cancel: shouldBeBlocked });
+const { ElectronBlocker } = require("@cliqz/adblocker-electron");
+const fetch = require("node-fetch");
+
+const SOURCES = [
+	"https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt",
+];
+
+const loadAdBlockerEngine = (session = undefined) =>
+	ElectronBlocker.fromLists(
+		fetch,
+		SOURCES,
+		{},
+		{
+			path: path.resolve(__dirname, "ad-blocker-engine.bin"),
+			read: promises.readFile,
+			write: promises.writeFile,
 		}
-	);
-};
+	)
+		.then((blocker) => {
+			if (session) {
+				blocker.enableBlockingInSession(session);
+			} else {
+				console.log("Successfully generated adBlocker engine.");
+			}
+		})
+		.catch((err) => console.log("Error loading adBlocker engine", err));
+
+module.exports = { loadAdBlockerEngine };
+if (require.main === module) {
+	loadAdBlockerEngine(); // Generate the engine without enabling it
+}

plugins/adblocker/contains-ads.js

@@ -1,24 +0,0 @@
-const fs = require("fs");
-const path    = require("path");
-const Blocker = require("ad-block");
-
-const client = new Blocker.AdBlockClient();
-const file   = path.resolve(__dirname, "detector.buffer");
-
-module.exports.client     = client;
-module.exports.initialize = () =>
-	new Promise((resolve, reject) => {
-		fs.readFile(file, (err, buffer) => {
-			if (err) {
-				return reject(err);
-			}
-			client.deserialize(buffer);
-			return resolve();
-		});
-	});
-
-const none = Blocker.FilterOptions.noFilterOption;
-const isAd = (req, base) => client.matches(req, none, base);
-
-module.exports.containsAds = (req, base) => isAd(req, base);
-module.exports.isAd        = isAd;

plugins/adblocker/generator.js

@@ -1,67 +0,0 @@
-// This file generates the detector buffer
-const fs      = require("fs");
-const path    = require("path");
-const Blocker = require("ad-block");
-const https   = require("https");
-
-const SOURCES = [
-	"https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt"
-];
-
-function parseAdblockList(client, adblockList) {
-	const urls      = adblockList.split("\n");
-	const totalSize = urls.length;
-	console.log(
-		"Parsing " + totalSize + " urls (this can take a couple minutes)."
-	);
-	urls.map(line => client.parse(line));
-	console.log("Created buffer.");
-}
-
-function writeBuffer(client) {
-	const output = path.resolve(__dirname, "detector.buffer");
-	fs.writeFile(output, client.serialize(64), err => {
-		if (err) {
-			console.error(err);
-			return;
-		}
-		console.log("Wrote buffer to detector.buffer!");
-	});
-}
-
-function generateDetectorBuffer() {
-	const client           = new Blocker.AdBlockClient();
-	let   nbSourcesFetched = 0;
-
-	// fetch updated versions
-	SOURCES.forEach(source => {
-		console.log("Downloading " + source);
-		https
-			.get(source, resp => {
-				let data = "";
-
-				// A chunk of data has been recieved.
-				resp.on("data", chunk => {
-					data += chunk;
-				});
-
-				// The whole response has been received. Print out the result.
-				resp.on("end", () => {
-					parseAdblockList(client, data);
-					nbSourcesFetched++;
-
-					if (nbSourcesFetched === SOURCES.length) {
-						writeBuffer(client);
-					}
-				});
-			})
-			.on("error", err => {
-				console.log("Error: " + err.message);
-			});
-	});
-}
-
-module.exports = generateDetectorBuffer;
-if (require.main === module) {
-	generateDetectorBuffer();
-}

readme.md

@@ -6,6 +6,7 @@
 [![Build status](https://ci.appveyor.com/api/projects/status/tgre12r150ynvwl2?svg=true)](https://ci.appveyor.com/project/th-ch/youtube-music)
 [![Build Status](https://travis-ci.org/th-ch/youtube-music.svg?branch=master)](https://travis-ci.org/th-ch/youtube-music)
 [![Known Vulnerabilities](https://snyk.io/test/github/th-ch/youtube-music/badge.svg)](https://snyk.io/test/github/th-ch/youtube-music)
+![GitHub All Releases](https://img.shields.io/github/downloads/th-ch/youtube-music/total)
 
 ![Screenshot](screenshot.jpg "Screenshot")
 
@@ -92,7 +93,7 @@ module.exports = () => {
 ## Build
 
 ```sh
-npm run build
+yarn run build
 ```
 
 Builds the app for macOS, Linux, and Windows, using [electron-builder](https://github.com/electron-userland/electron-builder).

store/index.js

@@ -4,18 +4,30 @@ const plugins = require("./plugins");
 const store = new Store({
 	defaults: {
 		"window-size": {
-			width : 1100,
+			width: 1100,
 			height: 550
 		},
-		url    : "https://music.youtube.com",
-		plugins: ["navigation", "shortcuts", "adblocker"]
+		url: "https://music.youtube.com",
+		plugins: ["navigation", "shortcuts", "adblocker"],
+		options: {
+			tray: false,
+			appVisible: true,
+			autoUpdates: true
+		}
 	}
 });
 
 module.exports = {
-	store            : store,
-	isPluginEnabled  : plugin => plugins.isEnabled(store, plugin),
+	store: store,
+	// Plugins
+	isPluginEnabled: plugin => plugins.isEnabled(store, plugin),
 	getEnabledPlugins: () => plugins.getEnabledPlugins(store),
-	enablePlugin     : plugin => plugins.enablePlugin(store, plugin),
-	disablePlugin    : plugin => plugins.disablePlugin(store, plugin)
+	enablePlugin: plugin => plugins.enablePlugin(store, plugin),
+	disablePlugin: plugin => plugins.disablePlugin(store, plugin),
+	// Options
+	setOptions: options =>
+		store.set("options", { ...store.get("options"), ...options }),
+	isTrayEnabled: () => store.get("options.tray"),
+	isAppVisible: () => store.get("options.appVisible"),
+	autoUpdate: () => store.get("options.autoUpdates")
 };

tray.js

@@ -0,0 +1,69 @@
+const path = require("path");
+
+const { Menu, nativeImage, Tray } = require("electron");
+
+const { mainMenuTemplate } = require("./menu");
+const { isTrayEnabled } = require("./store");
+const { clickInYoutubeMusic } = require("./utils/youtube-music");
+
+// Prevent tray being garbage collected
+let tray;
+
+module.exports.setUpTray = (app, win) => {
+	if (!isTrayEnabled()) {
+		tray = undefined;
+		return;
+	}
+
+	const iconPath = path.join(__dirname, "assets", "youtube-music-tray.png");
+	let trayIcon = nativeImage.createFromPath(iconPath).resize({
+		width: 16,
+		height: 16,
+	});
+	tray = new Tray(trayIcon);
+	tray.setToolTip("Youtube Music");
+
+	const trayMenu = Menu.buildFromTemplate([
+		{
+			label: "Play/Pause",
+			click: () => {
+				clickInYoutubeMusic(
+					win,
+					"#left-controls > div > paper-icon-button.play-pause-button.style-scope.ytmusic-player-bar"
+				);
+			},
+		},
+		{
+			label: "Next",
+			click: () => {
+				clickInYoutubeMusic(
+					win,
+					"#left-controls > div > paper-icon-button.next-button.style-scope.ytmusic-player-bar"
+				);
+			},
+		},
+		{
+			label: "Previous",
+			click: () => {
+				clickInYoutubeMusic(
+					win,
+					"#left-controls > div > paper-icon-button.previous-button.style-scope.ytmusic-player-bar"
+				);
+			},
+		},
+		{
+			label: "Show",
+			click: () => {
+				win.show();
+			},
+		},
+		...mainMenuTemplate,
+		{
+			label: "Quit",
+			click: () => {
+				app.quit();
+			},
+		},
+	]);
+	tray.setContextMenu(trayMenu);
+};

utils/youtube-music.js

@@ -0,0 +1,8 @@
+const clickInYoutubeMusic = (win, selector) => {
+	win.webContents.executeJavaScript(
+		`document.querySelector("${selector}").click();`,
+		true
+	);
+};
+
+module.exports = { clickInYoutubeMusic };