🔀 Merge pull request #334 from richardfrost/small_fixes

richardfrost · web-flow · commit b48087389754 · 2021-08-30T23:48:58.000-04:00
Add Off Filter Method and Fix for Audio Muting (Cue mode)
diff --git a/src/script/bookmarkletFilter.ts b/src/script/bookmarkletFilter.ts
@@ -24,6 +24,7 @@ export default class BookmarkletFilter extends Filter {
   cfg: WebConfig;
   domain: Domain;
   extension: boolean;
+  filterText: boolean;
   hostname: string;
   iframe: Location;
   location: Location | URL;
@@ -37,6 +38,7 @@ export default class BookmarkletFilter extends Filter {
   constructor() {
     super();
     this.extension = false;
+    this.filterText = true;
     this.audioWordlistId = Constants.ALL_WORDS_WORDLIST_ID;
     this.mutePage = false;
     this.processMutationTarget = false;
@@ -155,12 +157,12 @@ export default class BookmarkletFilter extends Filter {
     if (node.nodeName) {
       if (node.textContent && node.textContent.trim() != '') {
         const result = this.replaceTextResult(node.textContent, wordlistId, statsType);
-        if (result.modified) {
+        if (result.modified && this.filterText) {
           node.textContent = result.filtered;
         }
       } else if (node.nodeName == 'IMG') {
-        if (node.alt != '') { node.alt = this.replaceText(node.alt, wordlistId, statsType); }
-        if (node.title != '') { node.title = this.replaceText(node.title, wordlistId, statsType); }
+        this.cleanNodeAttribute(node, 'alt', wordlistId, statsType);
+        this.cleanNodeAttribute(node, 'title', wordlistId, statsType);
       } else if (node.shadowRoot) {
         this.filterShadowRoot(node.shadowRoot, wordlistId, statsType);
       }
@@ -179,8 +181,18 @@ export default class BookmarkletFilter extends Filter {
     }
   }
 
+  cleanNodeAttribute(node, attribute: string, wordlistId: number, statsType: string | null = Constants.STATS_TYPE_TEXT) {
+    if (node[attribute] != '') {
+      const result = this.replaceTextResult(node[attribute], wordlistId, statsType);
+      if (result.modified && this.filterText) {
+        node[attribute] = result.filtered;
+      }
+    }
+  }
+
   cleanPage() {
     this.cfg = new WebConfig(config);
+    this.filterText = this.cfg.filterMethod !== Constants.FILTER_METHODS.OFF;
     this.domain = Domain.byHostname(this.hostname, this.cfg.domains);
     this.cfg.muteMethod = Constants.MUTE_METHODS.VIDEO; // Bookmarklet: Force video volume mute method
 
diff --git a/src/script/lib/constants.ts b/src/script/lib/constants.ts
@@ -6,7 +6,7 @@ export default class Constants {
   static readonly ALL_WORDS_WORDLIST_ID = 0;
   static readonly DOMAIN_MODES = { NORMAL: 0, ADVANCED: 1, DEEP: 2 };
   static readonly FALSE = 0;
-  static readonly FILTER_METHODS = { CENSOR: 0, SUBSTITUTE: 1, REMOVE: 2 };
+  static readonly FILTER_METHODS = { CENSOR: 0, SUBSTITUTE: 1, REMOVE: 2, OFF: 3 };
   static readonly MATCH_METHODS = { EXACT: 0, PARTIAL: 1, WHOLE: 2, REGEX: 3 };
   static readonly MUTE_METHODS = { TAB: 0, VIDEO: 1, NONE: 2 };
   static readonly SHOW_SUBTITLES = { ALL: 0, FILTERED: 1, UNFILTERED: 2, NONE: 3 };
diff --git a/src/script/lib/filter.ts b/src/script/lib/filter.ts
@@ -107,6 +107,7 @@ export default class Filter {
     const wordlist = this.wordlists[wordlistId];
 
     switch(this.cfg.filterMethod) {
+      case Constants.FILTER_METHODS.OFF:
       case Constants.FILTER_METHODS.CENSOR:
         wordlist.regExps.forEach((regExp, index) => {
           str = str.replace(regExp, (originalMatch, ...args): string => {
diff --git a/src/script/optionPage.ts b/src/script/optionPage.ts
@@ -812,7 +812,11 @@ export default class OptionPage {
     if (testText.value === '') {
       filteredTestText.textContent = 'Enter some text above to test the filter...';
     } else {
-      filteredTestText.textContent = filter.replaceText(testText.value, filter.cfg.wordlistId, null);
+      if (option.cfg.filterMethod === Constants.FILTER_METHODS.OFF) {
+        filteredTestText.textContent = testText.value;
+      } else {
+        filteredTestText.textContent = filter.replaceText(testText.value, filter.cfg.wordlistId, null);
+      }
     }
   }
 
@@ -1540,6 +1544,7 @@ export default class OptionPage {
         OptionPage.show(document.getElementById('substitutionSettings'));
         OptionPage.show(document.getElementById('wordSubstitution'));
         break;
+      case Constants.FILTER_METHODS.OFF:
       case Constants.FILTER_METHODS.REMOVE:
         OptionPage.hide(document.getElementById('censorSettings'));
         OptionPage.hide(document.getElementById('substitutionSettings'));
diff --git a/src/script/webAudio.ts b/src/script/webAudio.ts
@@ -180,7 +180,7 @@ export default class WebAudio {
 
     const result = this.replaceTextResult(node.textContent);
     if (result.modified) {
-      node.textContent = result.filtered;
+      if (this.youTubeAutoSubsRule.filterSubtitles) { node.textContent = result.filtered; }
       this.mute(this.youTubeAutoSubsRule);
       this.youTubeAutoSubsUnmuteDelay = null;
       this.filter.updateCounterBadge();
@@ -399,6 +399,7 @@ export default class WebAudio {
     if (!rule.disabled) {
       // Setup rule defaults
       if (rule.filterSubtitles == null) { rule.filterSubtitles = true; }
+      if (this.filter.filterText == false) { rule.filterSubtitles = false; }
       this.initDisplaySelector(rule);
 
       // Allow rules to override global settings
@@ -470,7 +471,7 @@ export default class WebAudio {
       this.filter.cfg.addWord(youTubeAutoCensor, youTubeAutoCensorOptions);
 
       // Setup rule for YouTube Auto Subs
-      this.youTubeAutoSubsRule = { mode: 'ytauto', muteMethod: this.filter.cfg.muteMethod } as AudioRule;
+      this.youTubeAutoSubsRule = { filterSubtitles: true, mode: 'ytauto', muteMethod: this.filter.cfg.muteMethod } as AudioRule;
     }
   }
 
@@ -679,7 +680,7 @@ export default class WebAudio {
       cue.originalText = cue.text;
       if (result.modified) {
         cue.filtered = true;
-        cue.text = result.filtered;
+        if (rule.filterSubtitles) { cue.text = result.filtered; }
       } else {
         cue.filtered = false;
       }
@@ -985,8 +986,13 @@ export default class WebAudio {
               const activeCues = Array.from(textTrack.activeCues as any as FilteredVTTCue[]);
               const apfLines = [];
 
+              // Process cues
               const processed = activeCues.some((activeCue) => activeCue.hasOwnProperty('filtered'));
-              if (!processed) { instance.processCues(activeCues, rule); }
+              if (!processed) {
+                const allCues = Array.from(textTrack.cues as any as FilteredVTTCue[]);
+                instance.processCues(allCues, rule);
+              }
+
               const filtered = activeCues.some((activeCue) => activeCue.filtered);
               filtered ? instance.mute(rule, video) : instance.unmute(rule, video);
               const shouldBeShown = instance.subtitlesShouldBeShown(rule, filtered);
@@ -1019,6 +1025,10 @@ export default class WebAudio {
               instance.unmute(rule, video);
             }
           };
+
+          // Pre-process all cues after setting oncuechange
+          const allCues = Array.from(textTrack.cues as any as FilteredVTTCue[]);
+          instance.processCues(allCues, rule);
         }
       }
     }
diff --git a/src/script/webAudioSites.ts b/src/script/webAudioSites.ts
@@ -46,7 +46,17 @@ export default class WebAudioSites {
         rootNode: true,
         subtitleSelector: 'div > div > div > div > div',
         tagName: 'DIV',
-      }
+      },
+      {
+        displaySelector: 'div.video-container > div > div > div',
+        mode: 'elementChild',
+        muteMethod: Constants.MUTE_METHODS.TAB,
+        parentSelector: 'div.video-container',
+        preserveWhiteSpace: true,
+        rootNode: true,
+        subtitleSelector: 'div > div > div > div > span',
+        tagName: 'DIV',
+      },
     ],
     'www.att.tv': [{ mode: 'cue', videoSelector: 'video#quickplayPlayer' }],
     'www.attwatchtv.com': [{ mode: 'cue', videoSelector: 'video#quickplayPlayer' }],
diff --git a/src/script/webFilter.ts b/src/script/webFilter.ts
@@ -17,6 +17,7 @@ export default class WebFilter extends Filter {
   cfg: WebConfig;
   domain: Domain;
   extension: boolean;
+  filterText: boolean;
   hostname: string;
   iframe: Location;
   location: Location | URL;
@@ -32,6 +33,7 @@ export default class WebFilter extends Filter {
     super();
     this.audioWordlistId = Constants.ALL_WORDS_WORDLIST_ID;
     this.extension = true;
+    this.filterText = true;
     this.mutePage = false;
     this.processMutationTarget = false;
     this.stats = { mutes: 0, words: {} };
@@ -164,13 +166,13 @@ export default class WebFilter extends Filter {
     if (node.nodeName) {
       if (node.textContent && node.textContent.trim() != '') {
         const result = this.replaceTextResult(node.textContent, wordlistId, statsType);
-        if (result.modified) {
+        if (result.modified && this.filterText) {
           // logger.debug(`Normal node text changed: '${result.original}' to '${result.filtered}'.`);
           node.textContent = result.filtered;
         }
       } else if (node.nodeName == 'IMG') {
-        if (node.alt != '') { node.alt = this.replaceText(node.alt, wordlistId, statsType); }
-        if (node.title != '') { node.title = this.replaceText(node.title, wordlistId, statsType); }
+        this.cleanNodeAttribute(node, 'alt', wordlistId, statsType);
+        this.cleanNodeAttribute(node, 'title', wordlistId, statsType);
       } else if (node.shadowRoot) {
         this.filterShadowRoot(node.shadowRoot, wordlistId, statsType);
       }
@@ -190,8 +192,18 @@ export default class WebFilter extends Filter {
     }
   }
 
+  cleanNodeAttribute(node, attribute: string, wordlistId: number, statsType: string | null = Constants.STATS_TYPE_TEXT) {
+    if (node[attribute] != '') {
+      const result = this.replaceTextResult(node[attribute], wordlistId, statsType);
+      if (result.modified && this.filterText) {
+        node[attribute] = result.filtered;
+      }
+    }
+  }
+
   async cleanPage() {
     this.cfg = await WebConfig.build();
+    this.filterText = this.cfg.filterMethod !== Constants.FILTER_METHODS.OFF;
     this.domain = Domain.byHostname(this.hostname, this.cfg.domains);
     logger.info('Config loaded', this.cfg);
 
@@ -284,7 +296,11 @@ export default class WebFilter extends Filter {
 
     if (this.cfg.showSummary) {
       if (this.summary[word.value]) {
-        this.summary[word.value].count += 1;
+        if (this.filterText) {
+          this.summary[word.value].count += 1;
+        } else {
+          this.counter--; // Remove count if we've already found a match for this word when the filter is 'OFF'
+        }
       } else {
         let result;
         if (word.matchMethod === Constants.MATCH_METHODS.REGEX) {
@@ -303,9 +319,11 @@ export default class WebFilter extends Filter {
         wordStats[word.value] = { [ Constants.STATS_TYPE_AUDIO ]: 0, [ Constants.STATS_TYPE_TEXT ]: 0 };
       }
 
-      switch(statsType) {
-        case Constants.STATS_TYPE_AUDIO: wordStats[word.value].audio++; break;
-        case Constants.STATS_TYPE_TEXT: wordStats[word.value].text++; break;
+      if (this.filterText) {
+        switch(statsType) {
+          case Constants.STATS_TYPE_AUDIO: wordStats[word.value].audio++; break;
+          case Constants.STATS_TYPE_TEXT: wordStats[word.value].text++; break;
+        }
       }
     }
   }
diff --git a/src/static/optionPage.html b/src/static/optionPage.html
@@ -65,6 +65,12 @@ <h4 class="sectionHeader">Filter Method</h4>
       <input id="filterRemove" class="w3-radio" type="radio" name="filterMethod" value="REMOVE">
       Remove<span class="notes">(dog: doghouse = house)</span>
     </label>
+
+    <br/>
+    <label>
+      <input id="filterOff" class="w3-radio" type="radio" name="filterMethod" value="OFF">
+      Off<span class="notes">(disabled/summary only)</span>
+    </label>
   </div>
 
   <div id="censorSettings" class="w3-hide">
@@ -579,6 +585,8 @@ <h4 id="substitution-mode">Substitution Mode</h4>
     </ul>
     <h4 id="remove-mode">Remove Mode</h4>
     <p>When selected, the offensive word will simply be removed completely from the page, with no indicator that it was ever there. Note that this can sometimes lead to strange sentences.</p>
+    <h4 id="off-mode">Off Mode</h4>
+    <p>This mode disables filtering and is useful for detecting words without modifying the page. You can see the list of matching words found in the extension popup. The summary will list each found word once per page. Stats will not be captured, because words aren&#39;t being filtered. This essentially results in the filter &quot;being disabled&quot; and applies to every domain. If you want filtering to resume, please choose one of the above mentioned filter modes.</p>
     <h3 id="global-matching-method">Global Matching Method</h3>
     <p>The matching method will dictate how the filter matches words from the word list. By default, the <code>Partial Match</code> mode is selected. <em>All matching methods are case-insensitive</em>.</p>
     <ul>
@@ -651,7 +659,8 @@ <h3 id="advanced-mode">Advanced Mode:</h3>
     <p><em><strong>WARNING</strong>: This mode will result in lower performance.</em></p>
     <p>Handle matching text that is split between multiple elements on the page. This is not usually necessary.</p>
     <p><em>Example:</em></p>
-    <pre><code class="language-html">&lt;span&gt;some text to fil&lt;/span&gt;&lt;span&gt;ter&lt;/span&gt;</code></pre>
+    <pre><code class="language-html">&lt;span&gt;some text to fil&lt;/span&gt;&lt;span&gt;ter&lt;/span&gt;
+    </code></pre>
     <p>On the page, this would look like: &quot;some text to filter&quot;, but the extension (without advanced mode) would see <code>some text to fil</code>, and <code>ter</code>. If you were trying to filter the word <code>text</code>, it would work as expected (because &quot;text&quot; isn&#39;t split across elements). If you were trying to filter the word <code>filter</code>, it would fail without Advanced mode being turned on, because it doesn&#39;t match on <code>some text to fil</code>, or <code>ter</code>. This is not a common practice, and is only needed in a very small number of websites.</p>
     <h3 id="deep-mode">Deep Mode:</h3>
     <p><em><strong>WARNING</strong>: This mode will result in lower performance.</em></p>
@@ -676,7 +685,7 @@ <h1 id="audio">Audio</h1>
     <li>Hide all subtitles - This may make it difficult to know what is happening when the audio is muted</li>
     </ul>
     </li>
-    <li><strong>Filler Audio</strong> - Replace the silence while muting with a filler sound. (Must use "Video volume" mute method)</li>
+    <li><strong>Filler Audio</strong> - Replace the silence while muting with a filler sound. (Must use &quot;Video volume&quot; mute method)</li>
     <li><strong>Only mute audio</strong> - This will disable the text filter, and only perform filtering/muting on supported video sites.
     This mode will disable the text filter everywhere, and only mute audio (and filter subtitles) on supported sites.</li>
     <li><strong>Require subtitles to be showing</strong> - This setting is only for sites using the &quot;cue&quot; mode, and will only filter when subtitles are set to &quot;showing&quot; for the current video. If enabled, this typically means there is a manual step involved in turning on the subtitles (varies by site) to enable audio muting through the filter.</li>
