TwitchAdSolutions
Code Issues

Convert to a common script with configs

Browse Source
This commit is contained in:
pixeltris
2020-12-26 06:15:48 +00:00
parent d9c191a606
commit bc0303d460
14 changed files with 4811 additions and 1139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dyn/dyn-userscript.js
+368 -30
View File
@@ -1,39 +1,64 @@
// ==UserScript==
// @name TwitchAdSolutions (dyn)
// @name TwitchAdSolutions
// @namespace https://github.com/pixeltris/TwitchAdSolutions
// @version 1.0
// @description Replaces twitch ad segments with lower resolution live segments
// @description Multiple solutions for blocking Twitch ads
// @author pixeltris
// @match *://*.twitch.tv/*
// @downloadURL https://github.com/pixeltris/TwitchAdSolutions/raw/master/dyn/dyn-userscript.js
// @run-at document-start
// @grant none
// ==/UserScript==
(function() {
(function() {
'use strict';
function declareOptions(scope) {
// Options / globals
scope.OPT_MODE_MUTE_BLACK = false;
scope.OPT_MODE_VIDEO_SWAP = false;
scope.OPT_MODE_LOW_RES = false;
scope.OPT_MODE_STRIP_AD_SEGMENTS = true;
scope.OPT_MODE_NOTIFY_ADS_WATCHED = false;
scope.OPT_MODE_NOTIFY_ADS_WATCHED_ATTEMPTS = 2;// Larger values might increase load time. Lower values may increase ad chance.
scope.OPT_VIDEO_SWAP_PLAYER_TYPE = 'thunderdome';
scope.OPT_INITIAL_M3U8_ATTEMPTS = 1;
scope.OPT_ACCESS_TOKEN_PLAYER_TYPE = "";//'embed';
scope.OPT_ACCESS_TOKEN_PLAYER_TYPE = '';
scope.AD_SIGNIFIER = 'stitched-ad';
scope.LIVE_SIGNIFIER = ',live';
scope.CLIENT_ID = 'kimne78kx3ncx6brgo4mv6wki5h1ko';
// Modify options based on mode
if (!scope.OPT_ACCESS_TOKEN_PLAYER_TYPE && scope.OPT_MODE_LOW_RES) {
scope.OPT_ACCESS_TOKEN_PLAYER_TYPE = 'thunderdome';//480p
//scope.OPT_ACCESS_TOKEN_PLAYER_TYPE = 'picture-by-picture';//360p
}
// These are only really for Worker scope...
scope.StreamInfos = [];
scope.StreamInfosByUrl = [];
}
// Worker injection by instance01 (https://github.com/instance01/Twitch-HLS-AdBlock)
declareOptions(window);
////////////////////////////////////
// stream swap / stream mute
////////////////////////////////////
var tempVideo = null;// A temporary video container to hold a lower resolution stream without ads
var disabledVideo = null;// The original video element (disabled for the duration of the ad)
var originalVolume = 0;// The volume of the original video element
var foundAdContainer = false;// Have ad containers been found (the clickable ad)
var foundAdBanner = false;// Is the ad banner visible (top left of screen)
////////////////////////////////////
var gql_device_id = null;
var twitchMainWorker = null;
const oldWorker = window.Worker;
window.Worker = class Worker extends oldWorker {
constructor(twitchBlobUrl) {
if (twitchMainWorker) {
super(twitchBlobUrl);
return;
}
var jsURL = getWasmWorkerUrl(twitchBlobUrl);
var version = jsURL.match(/wasmworker\.min\-(.*)\.js/)[1];
if (typeof jsURL !== 'string') {
super(twitchBlobUrl);
return;
}
var newBlobStr = `
var Module = {
WASM_BINARY_URL: '${jsURL.replace('.js', '.wasm')}',
WASM_CACHE_MODE: true
}
${stripAds.toString()}
${processM3U8.toString()}
${getSegmentTimes.toString()}
${hookWorkerFetch.toString()}
${declareOptions.toString()}
@@ -42,6 +67,7 @@
importScripts('${jsURL}');
`
super(URL.createObjectURL(new Blob([newBlobStr])));
twitchMainWorker = this;
var adDiv = null;
this.onmessage = function(e) {
if (e.data.key == 'UboShowAdBanner') {
@@ -52,6 +78,9 @@
if (adDiv == null) { adDiv = getAdDiv(); }
adDiv.style.display = 'none';
}
else if (e.data.key == 'UboFoundAdSegment') {
onFoundAd(e.data.hasLiveSeg);
}
}
function getAdDiv() {
var msg = 'uBlock Origin is waiting for ads to finish...';
@@ -90,8 +119,19 @@
}
return result;
}
async function stripAds(url, textStr, realFetch) {
async function processM3U8(url, textStr, realFetch) {
var haveAdTags = textStr.includes(AD_SIGNIFIER);
if (haveAdTags) {
if (!OPT_MODE_STRIP_AD_SEGMENTS) {// TODO: Look into "Failed to execute ‘postMessage’ on ‘DOMWindow’: The target origin provided (‘https://supervisor.ext-twitch.tv’) does not match the recipient window’s origin (‘https://www.twitch.tv’)."
postMessage({
key: 'UboFoundAdSegment',
hasLiveSeg: textStr.includes(LIVE_SIGNIFIER)
});
}
}
if (!OPT_MODE_STRIP_AD_SEGMENTS) {
return textStr;
}
var streamInfo = StreamInfosByUrl[url];
if (streamInfo == null) {
console.log('Unknown stream url!');
@@ -185,12 +225,10 @@
fetch = async function(url, options) {
if (typeof url === 'string') {
if (url.endsWith('m3u8')) {
// Based on https://github.com/jpillora/xhook
return new Promise(function(resolve, reject) {
var processAfter = async function(response) {
var str = await stripAds(url, await response.text(), realFetch);
var modifiedResponse = new Response(str);
resolve(modifiedResponse);
var str = await processM3U8(url, await response.text(), realFetch);
resolve(new Response(str));
};
var send = function() {
return realFetch(url, options).then(function(response) {
@@ -202,8 +240,7 @@
};
send();
});
}
else if (url.includes('/api/channel/hls/') && !url.includes('picture-by-picture')) {
} else if (url.includes('/api/channel/hls/') && !url.includes('picture-by-picture') && OPT_MODE_STRIP_AD_SEGMENTS) {
return new Promise(async function(resolve, reject) {
// - First m3u8 request is the m3u8 with the video encodings (360p,480p,720p,etc).
// - Second m3u8 request is the m3u8 for the given encoding obtained in the first request. At this point we will know if there's ads.
@@ -254,27 +291,328 @@
return realFetch.apply(this, arguments);
}
}
// This hooks fetch in the global scope (which is different to the Worker scope, and therefore different to the Worker fetch hook)
function makeGraphQlPacket(event, radToken, payload) {
return [{
operationName: 'ClientSideAdEventHandling_RecordAdEvent',
variables: {
input: {
eventName: event,
eventPayload: JSON.stringify(payload),
radToken,
},
},
extensions: {
persistedQuery: {
version: 1,
sha256Hash: '7e6c69e6eb59f8ccb97ab73686f3d8b7d85a72a0298745ccd8bfc68e4054ca5b',
},
},
}];
}
function gqlRequest(body) {
return fetch('https://gql.twitch.tv/gql', {
method: 'POST',
body: JSON.stringify(body),
headers: {
'client-id': CLIENT_ID,
'X-Device-Id': gql_device_id
}
});
}
function parseAttributes(str) {
return Object.fromEntries(
str.split(/(?:^|,)((?:[^=]*)=(?:"[^"]*"|[^,]*))/)
.filter(Boolean)
.map(x => {
const idx = x.indexOf('=');
const key = x.substring(0, idx);
const value = x.substring(idx +1);
const num = Number(value);
return [key, Number.isNaN(num) ? value.startsWith('"') ? JSON.parse(value) : value : num]
}));
}
async function tryNotifyAdsWatched(realFetch, i, sig, token) {
var tokInfo = JSON.parse(token);
var channelName = tokInfo.channel;
var urlInfo = new URL('https://usher.ttvnw.net/api/channel/hls/' + channelName + '.m3u8');
urlInfo.searchParams.set('sig', sig);
urlInfo.searchParams.set('token', token);
var encodingsM3u8Response = await realFetch(urlInfo.href);
if (encodingsM3u8Response.status === 200) {
var encodingsM3u8 = await encodingsM3u8Response.text();
var streamM3u8Url = encodingsM3u8.match(/^https:.*\.m3u8$/m)[0];
var streamM3u8Response = await realFetch(streamM3u8Url);
var streamM3u8 = await streamM3u8Response.text();
//console.log(streamM3u8);
if (streamM3u8.includes(AD_SIGNIFIER)) {
console.log('ad at req ' + i);
var matches = streamM3u8.match(/#EXT-X-DATERANGE:(ID="stitched-ad-[^\n]+)\n/);
if (matches.length > 1) {
const attrString = matches[1];
const attr = parseAttributes(attrString);
var podLength = parseInt(attr['X-TV-TWITCH-AD-POD-LENGTH'] ? attr['X-TV-TWITCH-AD-POD-LENGTH'] : '1');
var podPosition = parseInt(attr['X-TV-TWITCH-AD-POD-POSITION'] ? attr['X-TV-TWITCH-AD-POD-POSITION'] : '0');
var radToken = attr['X-TV-TWITCH-AD-RADS-TOKEN'];
var lineItemId = attr['X-TV-TWITCH-AD-LINE-ITEM-ID'];
var orderId = attr['X-TV-TWITCH-AD-ORDER-ID'];
var creativeId = attr['X-TV-TWITCH-AD-CREATIVE-ID'];
var adId = attr['X-TV-TWITCH-AD-ADVERTISER-ID'];
var rollType = attr['X-TV-TWITCH-AD-ROLL-TYPE'].toLowerCase();
const baseData = {
stitched: true,
roll_type: rollType,
player_mute: false,
player_volume: 0.5,
visible: true,
};
for (let podPosition = 0; podPosition < podLength; podPosition++) {
const extendedData = {
...baseData,
ad_id: adId,
ad_position: podPosition,
duration: 30,
creative_id: creativeId,
total_ads: podLength,
order_id: orderId,
line_item_id: lineItemId,
};
await gqlRequest(makeGraphQlPacket('video_ad_impression', radToken, extendedData));
for (let quartile = 0; quartile < 4; quartile++) {
await gqlRequest(
makeGraphQlPacket('video_ad_quartile_complete', radToken, {
...extendedData,
quartile: quartile + 1,
})
);
}
await gqlRequest(makeGraphQlPacket('video_ad_pod_complete', radToken, baseData));
}
}
} else {
console.log("no ad at req " + i);
return 1;
}
} else {
// http error
return 2;
}
return 0;
}
function hookFetch() {
var realFetch = window.fetch;
window.fetch = function(url, init, ...args) {
if (typeof url === 'string') {
if (OPT_ACCESS_TOKEN_PLAYER_TYPE) {
if (url.includes('/access_token')) {
var modifiedUrl = new URL(url);
modifiedUrl.searchParams.set('player_type', OPT_ACCESS_TOKEN_PLAYER_TYPE);
arguments[0] = modifiedUrl.href;
if (url.includes('/access_token') || url.includes('gql')) {
if (OPT_ACCESS_TOKEN_PLAYER_TYPE) {
if (url.includes('/access_token')) {
var modifiedUrl = new URL(url);
modifiedUrl.searchParams.set('player_type', OPT_ACCESS_TOKEN_PLAYER_TYPE);
arguments[0] = modifiedUrl.href;
}
else if (url.includes('gql') && init && typeof init.body === 'string' && init.body.includes('PlaybackAccessToken')) {
const newBody = JSON.parse(init.body);
newBody.variables.playerType = OPT_ACCESS_TOKEN_PLAYER_TYPE;
init.body = JSON.stringify(newBody);
}
}
else if (url.includes('gql') && init && typeof init.body === 'string' && init.body.includes('PlaybackAccessToken')) {
const newBody = JSON.parse(init.body);
newBody.variables.playerType = OPT_ACCESS_TOKEN_PLAYER_TYPE;
init.body = JSON.stringify(newBody);
var deviceId = init.headers['X-Device-Id'];
if (typeof deviceId !== 'string') {
deviceId = init.headers['Device-ID'];
}
if (typeof deviceId === 'string') {
gql_device_id = deviceId;
}
if (OPT_MODE_NOTIFY_ADS_WATCHED) {
var tok = null, sig = null;
if (url.includes('/access_token')) {
return new Promise(async function(resolve, reject) {
var response = await realFetch(url, init);
if (response.status === 200) {
// NOTE: This code path is untested
for (var i = 0; i < OPT_MODE_NOTIFY_ADS_WATCHED_ATTEMPTS; i++) {
var cloned = response.clone();
var responseData = await cloned.json();
if (responseData && responseData.sig && responseData.token) {
if (await tryNotifyAdsWatched(realFetch, i, responseData.sig, responseData.token) > 0) {
break;
}
} else {
console.log('malformed');
console.log(responseData);
break;
}
}
} else {
resolve(response);
}
});
}
else if (url.includes('gql') && init && typeof init.body === 'string' && init.body.includes('PlaybackAccessToken')) {
return new Promise(async function(resolve, reject) {
var response = await realFetch(url, init);
if (response.status === 200) {
for (var i = 0; i < OPT_MODE_NOTIFY_ADS_WATCHED_ATTEMPTS; i++) {
var cloned = response.clone();
var responseData = await cloned.json();
if (responseData && responseData.data && responseData.data.streamPlaybackAccessToken && responseData.data.streamPlaybackAccessToken.value && responseData.data.streamPlaybackAccessToken.signature) {
if (await tryNotifyAdsWatched(realFetch, i, responseData.data.streamPlaybackAccessToken.signature, responseData.data.streamPlaybackAccessToken.value) > 0) {
break;
}
} else {
console.log('malformed');
console.log(responseData);
break;
}
}
resolve(response);
} else {
resolve(response);
}
});
}
}
}
}
return realFetch.apply(this, arguments);
}
}
declareOptions(window);
function onFoundAd(hasLiveSeg) {
if (hasLiveSeg) {
return;
}
if (OPT_MODE_VIDEO_SWAP && typeof Hls === 'undefined') {
return;
}
if (!foundAdContainer) {
// hide ad contianers
var adContainers = document.querySelectorAll('[data-test-selector="sad-overlay"]');
for (var i = 0; i < adContainers.length; i++) {
adContainers[i].style.display = "none";
}
foundAdContainer = adContainers.length > 0;
}
if (disabledVideo) {
disabledVideo.volume = 0;
} else {
//get livestream video element
var liveVid = document.getElementsByTagName("video");
if (liveVid.length) {
disabledVideo = liveVid = liveVid[0];
if (!disabledVideo) {
return;
}
//mute
originalVolume = liveVid.volume;
liveVid.volume = 0;
//black out
liveVid.style.filter = "brightness(0%)";
if (OPT_MODE_VIDEO_SWAP) {
var createTempStream = async function() {
// Create new video stream TODO: Do this with callbacks
var channelName = window.location.pathname.substr(1);// TODO: Better way of determining the channel name
var tempM3u8 = null;
var accessTokenResponse = await fetch('https://api.twitch.tv/api/channels/' + channelName + '/access_token?oauth_token=undefined&need_https=true&platform=web&player_type=' + OPT_VIDEO_SWAP_PLAYER_TYPE + '&player_backend=mediaplayer', {headers:{'client-id':CLIENT_ID}});
if (accessTokenResponse.status === 200) {
var accessToken = JSON.parse(await accessTokenResponse.text());
var urlInfo = new URL('https://usher.ttvnw.net/api/channel/hls/' + channelName + '.m3u8?allow_source=true');
urlInfo.searchParams.set('sig', accessToken.sig);
urlInfo.searchParams.set('token', accessToken.token);
var encodingsM3u8Response = await fetch(urlInfo.href);
if (encodingsM3u8Response.status === 200) {
// TODO: Maybe look for the most optimal m3u8
var encodingsM3u8 = await encodingsM3u8Response.text();
var streamM3u8Url = encodingsM3u8.match(/^https:.*\.m3u8$/m)[0];
// Maybe this request is a bit unnecessary
var streamM3u8Response = await fetch(streamM3u8Url);
if (streamM3u8Response.status == 200) {
tempM3u8 = streamM3u8Url;
} else {
console.log('Backup url request (streamM3u8) failed with ' + streamM3u8Response.status);
}
} else {
console.log('Backup url request (encodingsM3u8) failed with ' + encodingsM3u8Response.status);
}
} else {
console.log('Backup url request (accessToken) failed with ' + accessTokenResponse.status);
}
if (tempM3u8 != null) {
tempVideo = document.createElement('video');
tempVideo.autoplay = true;
tempVideo.volume = originalVolume;
console.log(disabledVideo);
disabledVideo.parentElement.insertBefore(tempVideo, disabledVideo.nextSibling);
if (Hls.isSupported()) {
tempVideo.hls = new Hls();
tempVideo.hls.loadSource(tempM3u8);
tempVideo.hls.attachMedia(tempVideo);
}
console.log(tempVideo);
console.log(tempM3u8);
}
};
createTempStream();
}
}
}
}
function pollForAds() {
//check ad by looking for text banner
var adBanner = document.querySelectorAll("span.tw-c-text-overlay");
var foundAd = false;
for (var i = 0; i < adBanner.length; i++) {
if (adBanner[i].attributes["data-test-selector"]) {
foundAd = true;
foundAdBanner = true;
break;
}
}
if (tempVideo && disabledVideo && tempVideo.paused != disabledVideo.paused) {
if (disabledVideo.paused) {
tempVideo.pause();
} else {
tempVideo.play();//TODO: Fix issue with Firefox
}
}
if (foundAd) {
onFoundAd(false);
} else if (!foundAd && foundAdBanner) {
if (disabledVideo) {
disabledVideo.volume = originalVolume;
disabledVideo.style.filter = "";
disabledVideo = null;
foundAdContainer = false;
foundAdBanner = false;
if (tempVideo) {
tempVideo.hls.stopLoad();
tempVideo.remove();
tempVideo = null;
}
}
}
setTimeout(pollForAds,100);
}
function onContentLoaded() {
// These modes use polling of the ad elements (e.g. ad banner text) to show/hide content
if (!OPT_MODE_VIDEO_SWAP && !OPT_MODE_MUTE_BLACK) {
return;
}
if (OPT_MODE_VIDEO_SWAP && typeof Hls === 'undefined') {
var script = document.createElement('script');
script.src = "https://cdn.jsdelivr.net/npm/hls.js@latest";
script.onload = function() {
pollForAds();
}
document.head.appendChild(script);
} else {
pollForAds();
}
}
hookFetch();
if (document.readyState === "complete" || document.readyState === "loaded" || document.readyState === "interactive") {
onContentLoaded();
} else {
window.addEventListener("DOMContentLoaded", function() {
onContentLoaded();
});
}
})();