mirror of
https://github.com/th-ch/youtube-music.git
synced 2026-01-11 18:41:47 +00:00
Merge pull request #19 from th-ch/migrate-to-adblock-rs
[Plugins] Migrate ad blocker
This commit is contained in:
th-ch
GitHub
34
.travis.yml
34
.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:
|
||||
|
||||
11
appveyor.yml
11
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
|
||||
|
||||
29
package.json
29
package.json
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "youtube-music",
|
||||
"productName": "YouTube Music",
|
||||
"version": "1.2.0",
|
||||
"version": "1.3.0",
|
||||
"description": "YouTube Music Desktop App - including custom plugins",
|
||||
"license": "MIT",
|
||||
"repository": "th-ch/youtube-music",
|
||||
@ -30,34 +30,37 @@
|
||||
"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-is": "^3.0.0",
|
||||
"electron-localshortcut": "^3.2.1",
|
||||
"electron-store": "^3.1.0",
|
||||
"electron-updater": "^4.2.2"
|
||||
"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": "^8.2.1",
|
||||
"electron-builder": "^22.4.1",
|
||||
"electron-devtools-installer": "^2.2.4",
|
||||
"electron-icon-maker": "0.0.4",
|
||||
"electron-rebuild": "^1.8.4",
|
||||
"rimraf": "^2.6.3",
|
||||
"xo": "^0.24.0"
|
||||
},
|
||||
|
||||
2
plugins/adblocker/.gitignore
vendored
2
plugins/adblocker/.gitignore
vendored
@ -1 +1 @@
|
||||
detector.buffer
|
||||
/ad-blocker-engine.bin
|
||||
|
||||
@ -1,3 +1,2 @@
|
||||
const { blockWindowAds } = require("./blocker");
|
||||
|
||||
module.exports = win => blockWindowAds(win.webContents);
|
||||
const { loadAdBlockerEngine } = require("./blocker");
|
||||
module.exports = () => loadAdBlockerEngine(true);
|
||||
|
||||
@ -1,12 +1,33 @@
|
||||
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 { session } = require("electron");
|
||||
const fetch = require("node-fetch");
|
||||
|
||||
const SOURCES = [
|
||||
"https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt"
|
||||
];
|
||||
|
||||
const loadAdBlockerEngine = (enableBlocking = false) =>
|
||||
ElectronBlocker.fromLists(
|
||||
fetch,
|
||||
SOURCES,
|
||||
{},
|
||||
{
|
||||
path: path.resolve(__dirname, "ad-blocker-engine.bin"),
|
||||
read: promises.readFile,
|
||||
write: promises.writeFile
|
||||
}
|
||||
);
|
||||
};
|
||||
)
|
||||
.then(blocker => {
|
||||
if (enableBlocking) {
|
||||
blocker.enableBlockingInSession(session.defaultSession);
|
||||
}
|
||||
})
|
||||
.catch(err => console.log("Error loading adBlocker engine", err));
|
||||
|
||||
module.exports = { loadAdBlockerEngine };
|
||||
if (require.main === module) {
|
||||
loadAdBlockerEngine(false); // Generate the engine without enabling it
|
||||
}
|
||||
|
||||
@ -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;
|
||||
@ -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();
|
||||
}
|
||||
Reference in New Issue
Block a user