Merge pull request #298 from ajayyy/experimental

Options Improvements

.github/workflows/release.yml

@@ -1,6 +1,8 @@
 name: Upload Release Build
 
-on: release
+on: 
+  release:
+    types: [published]
 
 jobs:
 
@@ -9,22 +11,68 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      # Build Artifacts
+      # Initialization
       - uses: actions/checkout@v1
-      - name: Build Artifacts
+      - uses: actions/setup-node@v1
-        uses: ./.github/workflows/ci.yml
+      - run: npm install
+      - name: Copy configuration
+        run: cp config.json.example config.json
+
+      # Create Chrome artifacts
+      - name: Create Chrome artifacts
+        run: npm run build:chrome
+      - uses: actions/upload-artifact@v1
+        with:
+          name: ChromeExtension
+          path: dist
+      - run: mkdir ./builds
+      - uses: montudor/action-zip@v0.1.0
+        with:
+          args: zip -qq -r ./builds/ChromeExtension.zip ./dist
+
+      # Create Firefox artifacts
+      - name: Create Firefox artifacts
+        run: npm run build:firefox
+      - uses: actions/upload-artifact@v1
+        with:
+          name: FirefoxExtension
+          path: dist
+      - uses: montudor/action-zip@v0.1.0
+        with:
+          args: zip -qq -r ./builds/FirefoxExtension.zip ./dist
+
+      # Create Beta artifacts (Builds with the name changed to beta)
+      - name: Create Chrome Beta artifacts
+        run: npm run build:chrome -- --env.stream=beta
+      - uses: actions/upload-artifact@v1
+        with:
+          name: ChromeExtensionBeta
+          path: dist
+      - uses: montudor/action-zip@v0.1.0
+        with:
+          args: zip -qq -r ./builds/ChromeExtensionBeta.zip ./dist
+
+      - name: Create Firefox Beta artifacts
+        run: npm run build:firefox -- --env.stream=beta
+      - uses: actions/upload-artifact@v1
+        with:
+          name: FirefoxExtensionBeta
+          path: dist
+      - uses: montudor/action-zip@v0.1.0
+        with:
+          args: zip -qq -r ./builds/FirefoxExtensionBeta.zip ./dist
 
       # Upload each release asset
       - name: Upload to release
-        uses: JasonEtco/upload-to-release@master
+        uses: Shopify/upload-to-release@master
         with:
-          args: ./builds/ChromeExtension.zip
+          args: builds/ChromeExtension.zip
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Upload to release
-        uses: JasonEtco/upload-to-release@master
+        uses: Shopify/upload-to-release@master
         with:
-          args: ./builds/FirefoxExtension.zip
+          args: builds/FirefoxExtension.zip
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
 

README.md

@@ -40,32 +40,30 @@ The backend server code is available here: https://github.com/ajayyy/SponsorBloc
 
 It is a simple Sqlite database that will hold all the timing data.
 
-To make sure that this project doesn't die, I have made the database publicly downloadable at https://api.sponsor.ajay.app/database.db. So, you can download a backup or get archive.org to take a backup for you if you want.
+To make sure that this project doesn't die, I have made the database publicly downloadable at https://sponsor.ajay.app/database.db. You can download a backup or get archive.org to take a backup for you if you want.
 
-Hopefully this project can be combined with projects like [this](https://github.com/Sponsoff/sponsorship_remover) and use this data to create a neural network to predict when sponsored segments happen. That project is sadly abandoned now, so I have decided to attempt to revive this idea.
+The dataset and API are now being used in some [ports](https://github.com/ajayyy/SponsorBlock/wiki/Unofficial-Ports) as well as a [neural network](https://github.com/andrewzlee/NeuralBlock).
+
+A [previous project](https://github.com/Sponsoff/sponsorship_remover) attempted to create a neural network to predict when sponsored segments happen. That project is sadly abandoned now, so I have decided to attempt to revive this idea starting from a crowd-sourced system instead.
 
 # API
 
 You can read the API docs [here](https://github.com/ajayyy/SponsorBlockServer#api-docs).
 
-# Build Yourself
+# Building
 
-You can load this project as an unpacked extension. Make sure to rename the `config.json.example` file to `config.json` before installing.
+There are also other build scripts available. Install `npm`, then run `npm install` in the repository to install dependencies. 
 
-There are also other build scripts available. Install `npm`, then run `npm install` in the repository.
+Run `npm run build` to generate a Chrome extension.
+
+Use `npm run build:firefox` to generate a Firefox extension.
+
+The result is in `dist`. This can be loaded as an unpacked extension
 
 ## Developing with a clean profile
 
 Run `npm run dev` to run the extension using a clean browser profile with hot reloading. Use `npm run dev:firefox` for Firefox. This uses [`web-ext run`](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#commands).
 
-## Packing
-
-Run `npm run build` to generate a packed Chrome extension.
-
-Use `npm run build:firefox` to generate a Firefox extension.
-
-The result is in `dist`.
-
 # Credit
 
 The awesome [Invidious API](https://github.com/omarroth/invidious/wiki/API) previously was used.

manifest/manifest.json

@@ -1,7 +1,7 @@
 {
     "name": "__MSG_fullName__",
     "short_name": "__MSG_Name__",
-    "version": "1.2.18",
+    "version": "1.2.22",
     "default_locale": "en",
     "description": "__MSG_Description__",
     "content_scripts": [{

public/_locales/en/messages.json

@@ -425,5 +425,20 @@
     },
     "mobileUpdateInfo": {
         "message": "m.youtube.com is now supported"
+    },
+    "exportOptions": {
+        "message": "Import/Export All Options"
+    },
+    "whatExportOptions": {
+        "message": "This is your entire configuration in JSON. This includes your userID, so be sure to share this wisely."
+    },
+    "setOptions": {
+        "message": "Set Options"
+    },
+    "exportOptionsWarning": {
+        "message": "Warning: Changing the options is permanent and can break your install. Are you sure you would like to do this? Make sure to backup your old one just in case."
+    },
+    "incorrectlyFormattedOptions": {
+        "message": "This JSON is not formatted correctly. Your options have not been changed."
     }
 }

public/options/options.html

@@ -308,6 +308,32 @@
 			<br/>
 			<br/>
 	
+			<div option-type="private-text-change" sync-option="*" confirm-message="exportOptionsWarning">
+				<div class="option-button trigger-button">
+					__MSG_exportOptions__
+				</div>
+	
+				<br/>
+	
+				<div class="small-description">__MSG_whatExportOptions__</div>
+	
+				<div class="option-hidden-section hidden">
+					<br/>
+	
+					<input class="option-text-box" type="text">
+	
+					<br/>
+					<br/>
+	
+					<div class="option-button text-change-set">
+						__MSG_setOptions__
+					</div>
+				</div>
+			</div>
+
+			<br/>
+			<br/>
+
 			<div option-type="text-change" sync-option="serverAddress">
 				<label class="text-label-container">
 					<div>__MSG_customServerAddress__</div>

src/background.ts

@@ -1,5 +1,8 @@
 import * as Types from "./types";
+
 import Config from "./config";
+// Make the config public for debugging purposes
+(<any> window).SB = Config;
 
 import Utils from "./utils";
 var utils = new Utils({

src/config.ts

@@ -84,13 +84,8 @@ class SBMap<T, U> extends Map {
 
         return result;
     }
-
-    toJSON() {
-        return Array.from(this.entries());
-    }
 }
 
-
 var Config: SBObject = {
     /**
      * Callback function when an option is updated
@@ -131,14 +126,14 @@ var Config: SBObject = {
 
 /**
  * A SBMap cannot be stored in the chrome storage. 
- * This data will be encoded into an array instead as specified by the toJSON function.
+ * This data will be encoded into an array instead
  * 
  * @param data 
  */
 function encodeStoredItem(data) {
     // if data is SBMap convert to json for storing
     if(!(data instanceof SBMap)) return data;
-    return JSON.stringify(data);
+    return Array.from(data.entries());
 }
 
 /**
@@ -148,18 +143,30 @@ function encodeStoredItem(data) {
  * @param {*} data 
  */
 function decodeStoredItem(id: string, data) {
-    if(typeof data !== "string") return data;
+    if (!Config.defaults[id]) return data;
 
-    try {
+    if (Config.defaults[id] instanceof SBMap) {
-        let str = JSON.parse(data);
+        try {
+            let jsonData: any = data;
 
-        if(!Array.isArray(str)) return data;
+            // Check if data is stored in the old format for SBMap (a JSON string)
-        return new SBMap(id, str);
+            if (typeof data === "string") {
-    } catch(e) {
+                try {	
+                    jsonData = JSON.parse(data);	   
+                } catch(e) {
+                    // Continue normally (out of this if statement)
+                }
+            }
 
-        // If all else fails, return the data
+            if (!Array.isArray(jsonData)) return data;
-        return data;
+            return new SBMap(id, jsonData);
+        } catch(e) {
+            console.error("Failed to parse SBMap: " + id);
+        }
     }
+
+    // If all else fails, return the data
+    return data;
 }
 
 function configProxy(): any {

src/content.ts

@@ -45,7 +45,12 @@ var lastPreviewBarUpdate;
 var durationListenerSetUp = false;
 
 // Is the video currently being switched
-var switchingVideos = false;
+var switchingVideos = null;
+
+// Used by the play and playing listeners to make sure two aren't
+// called at the same time
+var lastCheckTime = 0;
+var lastCheckVideoTime = -1;
 
 //the channel this video is about
 var channelURL;
@@ -238,6 +243,9 @@ document.onkeydown = function(e: KeyboardEvent){
 }
 
 function resetValues() {
+    lastCheckTime = 0;
+    lastCheckVideoTime = -1;
+
     //reset sponsor times
     sponsorTimes = null;
     UUIDs = [];
@@ -250,6 +258,8 @@ function resetValues() {
 
     //reset sponsor data found check
     sponsorDataFound = false;
+
+    switchingVideos = true;
 }
 
 async function videoIDChange(id) {
@@ -264,8 +274,6 @@ async function videoIDChange(id) {
 	//id is not valid
     if (!id) return;
 
-    switchingVideos = true;
-
     // Wait for options to be ready
     await utils.wait(() => Config.config !== null, 5000, 1);
 
@@ -449,7 +457,7 @@ function startSponsorSchedule(currentTime?: number): void {
         return;
     }
 
-    if (currentTime === undefined) currentTime = video.currentTime;
+    if (currentTime === undefined || currentTime === null) currentTime = video.currentTime;
 
     let skipInfo = getNextSkipIndex(currentTime);
 
@@ -459,11 +467,19 @@ function startSponsorSchedule(currentTime?: number): void {
     let timeUntilSponsor = skipTime[0] - currentTime;
 
     let skippingFunction = () => {
+        let forcedSkipTime: number = null;
+
         if (video.currentTime >= skipTime[0] && video.currentTime < skipTime[1]) {
             skipToTime(video, skipInfo.index, skipInfo.array, skipInfo.openNotice);
+
+            if (Config.config.disableAutoSkip) {
+                forcedSkipTime = skipTime[0] + 0.001;
+            } else {
+                forcedSkipTime = skipTime[1];
+            }
         }
 
-        startSponsorSchedule();
+        startSponsorSchedule(forcedSkipTime);
     };
 
     if (timeUntilSponsor <= 0) {
@@ -493,7 +509,23 @@ function sponsorsLookup(id: string, channelIDPromise?) {
 
         video.addEventListener('play', () => {
             switchingVideos = false;
-            startSponsorSchedule();
+
+             // Make sure it doesn't get double called with the playing event
+             if (lastCheckVideoTime !== video.currentTime && Date.now() - lastCheckTime > 2000) {
+                lastCheckTime = Date.now();
+                lastCheckVideoTime = video.currentTime;
+
+                startSponsorSchedule();
+            }
+        });
+        video.addEventListener('playing', () => {
+            // Make sure it doesn't get double called with the play event
+            if (lastCheckVideoTime !== video.currentTime && Date.now() - lastCheckTime > 2000) {
+                lastCheckTime = Date.now();
+                lastCheckVideoTime = video.currentTime;
+
+                startSponsorSchedule();
+            }
         });
         video.addEventListener('seeked', () => {
             if (!video.paused) startSponsorSchedule();
@@ -848,16 +880,14 @@ function skipToTime(v, index, sponsorTimes, openNotice) {
         }
 
         //send telemetry that a this sponsor was skipped
-        if (Config.config.trackViewCount && !sponsorSkipped[index]) {
+        if (Config.config.trackViewCount && !sponsorSkipped[index] && !Config.config.disableAutoSkip) {
             utils.sendRequestToServer("POST", "/api/viewedVideoSponsorTime?UUID=" + currentUUID);
 
-            if (!Config.config.disableAutoSkip) {
+            // Count this as a skip
-                // Count this as a skip
+            Config.config.minutesSaved = Config.config.minutesSaved + (sponsorTimes[index][1] - sponsorTimes[index][0]) / 60;
-                Config.config.minutesSaved = Config.config.minutesSaved + (sponsorTimes[index][1] - sponsorTimes[index][0]) / 60;
+            Config.config.skipCount = Config.config.skipCount + 1;
-                Config.config.skipCount = Config.config.skipCount + 1;
 
-                sponsorSkipped[index] = true;
+            sponsorSkipped[index] = true;
-            }
         }
     }
 }

src/js-components/skipNotice.ts

@@ -1,5 +1,7 @@
 'use strict';
 
+import Config from "../config";
+
 /**
  * The notice that tells the user that a sponsor was just skipped
  */
@@ -305,7 +307,7 @@ class SkipNotice {
         if (this.manualSkip) {
             this.changeNoticeTitle(chrome.i18n.getMessage("noticeTitle"));
 
-            this.contentContainer().vote(1, this.UUID, this);
+            if (Config.config.autoUpvote) this.contentContainer().vote(1, this.UUID);
         }
     }
 

src/options.ts

@@ -1,4 +1,6 @@
 import Config from "./config";
+// Make the config public for debugging purposes
+(<any> window).SB = Config;
 
 import Utils from "./utils";
 var utils = new Utils();
@@ -72,7 +74,7 @@ async function init() {
 
                 textChangeInput.value = Config.config[textChangeOption];
 
-                textChangeSetButton.addEventListener("click", () => {
+                textChangeSetButton.addEventListener("click", async () => {
                     // See if anything extra must be done
                     switch (textChangeOption) {
                         case "serverAddress":
@@ -84,6 +86,18 @@ async function init() {
                                 return;
                             }
 
+                            // Permission needed on Firefox
+                            if (utils.isFirefox()) {
+                                let permissionSuccess = await new Promise((resolve, reject) => {
+                                    chrome.permissions.request({
+                                        origins: [textChangeInput.value + "/"],
+                                        permissions: []
+                                    }, resolve);
+                                });
+
+                                if (!permissionSuccess) return;
+                            }
+
                             break;
                     }
 
@@ -259,6 +273,8 @@ function invidiousOnClick(checkbox: HTMLInputElement, option: string) {
             if (!granted) {
                 Config.config[option] = false;
                 checkbox.checked = false;
+            } else {
+                checkbox.checked = true;
             }
         });
     } else {
@@ -346,14 +362,49 @@ function activatePrivateTextChange(element: HTMLElement) {
             return;
     }
     
-    textBox.value = Config.config[option];
+    let result = Config.config[option];
+
+    // See if anything extra must be done
+    switch (option) {
+        case "*":
+            result = JSON.stringify(Config.localConfig);
+            break;
+    }
+
+    textBox.value = result;
     
     let setButton = element.querySelector(".text-change-set");
     setButton.addEventListener("click", () => {
         let confirmMessage = element.getAttribute("confirm-message");
 
         if (confirmMessage === null || confirm(chrome.i18n.getMessage(confirmMessage))) {
-            Config.config[option] = textBox.value;
+            
+            // See if anything extra must be done
+            switch (option) {
+                case "*":
+                    try {
+                        let newConfig = JSON.parse(textBox.value);
+                        for (const key in newConfig) {
+                            Config.config[key] = newConfig[key];
+                        }
+
+                        init();
+
+                        if (newConfig.supportInvidious) {
+                            let checkbox = <HTMLInputElement> document.querySelector("#support-invidious > label > label > input");
+                            
+                            checkbox.checked = true;
+                            invidiousOnClick(checkbox, "supportInvidious");
+                        }
+                        
+                    } catch (e) {
+                        alert(chrome.i18n.getMessage("incorrectlyFormattedOptions"));
+                    }
+
+                    break;
+                default:
+                    Config.config[option] = textBox.value;
+            }
         }
     });