☰

Dynamic Include Sites Script (Protocol-Independent)

Run on default & user-defined sites using wildcard patterns (ignores protocols), with full management features.

This script should not be not be installed directly. It is a library for other scripts to include with the meta directive // @require https://update.greatest.deepsurf.us/scripts/526770/1585275/Dynamic%20Include%20Sites%20Script%20%28Protocol-Independent%29.js 

  1. // ==UserScript==
  2. // @name         Site Filter (Protocol-Independent)
  3. // @namespace    http://tampermonkey.net/
  4. // @version      2.6
  5. // @description  Manage allowed sites dynamically and reference this in other scripts.
  6. // @author       blvdmd
  7. // @match        *://*/*
  8. // @grant        GM_getValue
  9. // @grant        GM_setValue
  10. // @grant        GM_registerMenuCommand
  11. // @grant        GM_download
  12. // @run-at       document-start
  13. // ==/UserScript==
  14.  
  15. (function () {
  16.     'use strict';
  17.  
  18.      // Exit if the script is running in an iframe or embedded context
  19.      if (window.self !== window.top) {
  20.         return; // Stop execution for embedded pages
  21.     }
  22.  
  23.     const USE_EMOJI_FOR_STATUS = true; // Configurable flag to use emoji for true/false status
  24.     const SHOW_STATUS_ONLY_IF_TRUE = true; // Configurable flag to show status only if any value is true
  25.  
  26.     // ✅ Wait for `SCRIPT_STORAGE_KEY` to be set
  27.     function waitForScriptStorageKey(maxWait = 1000) {
  28.         return new Promise(resolve => {
  29.             const startTime = Date.now();
  30.             const interval = setInterval(() => {
  31.                 if (typeof window.SCRIPT_STORAGE_KEY !== 'undefined') {
  32.                     clearInterval(interval);
  33.                     resolve(window.SCRIPT_STORAGE_KEY);
  34.                 } else if (Date.now() - startTime > maxWait) {
  35.                     clearInterval(interval);
  36.                     console.error("🚨 SCRIPT_STORAGE_KEY is not set! Make sure your script sets it **before** @require.");
  37.                     resolve(null);
  38.                 }
  39.             }, 50);
  40.         });
  41.     }
  42.  
  43.     (async function initialize() {
  44.         async function waitForDocumentReady() {
  45.             if (document.readyState === "complete") return;
  46.             return new Promise(resolve => {
  47.                 window.addEventListener("load", resolve, { once: true });
  48.             });
  49.         }
  50.         // ✅ Wait for the script storage key
  51.         const key = await waitForScriptStorageKey();
  52.         if (!key) return;
  53.  
  54.         // ✅ Ensure the document is fully loaded before setting `shouldRunOnThisSite`
  55.         await waitForDocumentReady();
  56.  
  57.         const STORAGE_KEY = `additionalSites_${key}`;
  58.  
  59.         function getDefaultList() {
  60.             return typeof window.GET_DEFAULT_LIST === "function" ? window.GET_DEFAULT_LIST() : [];
  61.         }
  62.  
  63.         function normalizeUrl(url) {
  64.             if (typeof url !== 'string') {
  65.                 url = String(url);
  66.             }
  67.             return url.replace(/^https?:\/\//, '');
  68.         }
  69.  
  70.         let additionalSites = GM_getValue(STORAGE_KEY, []);
  71.  
  72.         let mergedSites = [...new Set([...getDefaultList(), ...additionalSites])].map(item => {
  73.             if (typeof item === 'string') {
  74.                 return { pattern: normalizeUrl(item), preProcessingRequired: false, postProcessingRequired: false };
  75.             }
  76.             return { ...item, pattern: normalizeUrl(item.pattern) };
  77.         });
  78.  
  79.         GM_registerMenuCommand("➕ Add Current Site to Include List", addCurrentSiteMenu);
  80.         GM_registerMenuCommand("📜 View Included Sites", viewIncludedSites);
  81.         GM_registerMenuCommand("🗑️ Delete Specific Entries", deleteEntries);
  82.         GM_registerMenuCommand("✏️ Edit an Entry", editEntry);
  83.         GM_registerMenuCommand("🚨 Clear All Entries", clearAllEntries);
  84.         GM_registerMenuCommand("📤 Export Site List as JSON", exportAdditionalSites);
  85.         GM_registerMenuCommand("📥 Import Site List from JSON", importAdditionalSites);
  86.  
  87.         async function shouldRunOnThisSite() {
  88.             const currentFullPath = normalizeUrl(`${window.top.location.href}`);
  89.             return mergedSites.some(item => wildcardToRegex(normalizeUrl(item.pattern)).test(currentFullPath));
  90.         }
  91.  
  92.         function wildcardToRegex(pattern) {
  93.             return new RegExp("^" + pattern
  94.                     .replace(/[-[\]{}()+^$|#\s]/g, '\\$&')
  95.                     .replace(/\./g, '\\.')
  96.                     .replace(/\?/g, '\\?')
  97.                     .replace(/\*/g, '.*')
  98.                 + "$");
  99.         }
  100.  
  101.         function addCurrentSiteMenu() {
  102.             const currentHost = window.top.location.hostname; // Use window.top to get the top-level hostname
  103.             const currentPath = window.top.location.pathname; // Use window.top to get the top-level pathname
  104.             const domainParts = currentHost.split('.');
  105.             const baseDomain = domainParts.length > 2 ? domainParts.slice(-2).join('.') : domainParts.join('.');
  106.             const secondLevelDomain = domainParts.length > 2 ? domainParts.slice(-2, -1)[0] : domainParts[0];
  107.         
  108.             const options = [
  109.                 { name: `Preferred Domain Match (*${secondLevelDomain}.*)`, pattern: `*${secondLevelDomain}.*` },
  110.                 { name: `Base Hostname (*.${baseDomain}*)`, pattern: `*.${baseDomain}*` },
  111.                 { name: `Base Domain (*.${secondLevelDomain}.*)`, pattern: `*.${secondLevelDomain}.*` },
  112.                 { name: `Host Contains (*${secondLevelDomain}*)`, pattern: `*${secondLevelDomain}*` },
  113.                 { name: `Exact Path (${currentHost}${currentPath})`, pattern: normalizeUrl(`${window.top.location.href}`) },
  114.                 { name: "Custom Wildcard Pattern", pattern: normalizeUrl(`${window.top.location.href}`) }
  115.             ];
  116.  
  117.             const userChoice = prompt(
  118.                 "Select an option to add the site:\n" +
  119.                 options.map((opt, index) => `${index + 1}. ${opt.name}`).join("\n") +
  120.                 "\nEnter a number or cancel."
  121.             );
  122.  
  123.             if (!userChoice) return;
  124.             const selectedIndex = parseInt(userChoice, 10) - 1;
  125.             if (selectedIndex >= 0 && selectedIndex < options.length) {
  126.                 let pattern = normalizeUrl(options[selectedIndex].pattern);
  127.                 if (options[selectedIndex].name === "Custom Wildcard Pattern") {
  128.                     pattern = normalizeUrl(prompt("Edit custom wildcard pattern:", pattern));
  129.                     if (!pattern.trim()) return alert("Invalid pattern. Operation canceled.");
  130.                 }
  131.  
  132.                 const preProcessingRequired = prompt("Is pre-processing required? (y/n)", "n").toLowerCase() === 'y';
  133.                 const postProcessingRequired = prompt("Is post-processing required? (y/n)", "n").toLowerCase() === 'y';
  134.                 const onDemandFloatingButtonRequired = prompt("Is on-demand floating button required? (y/n)", "n").toLowerCase() === 'y';
  135.                 const backgroundChangeObserverRequired = prompt("Is background change observer required? (y/n)", "n").toLowerCase() === 'y';
  136.  
  137.                 const entry = { 
  138.                     pattern, 
  139.                     preProcessingRequired, 
  140.                     postProcessingRequired, 
  141.                     onDemandFloatingButtonRequired, 
  142.                     backgroundChangeObserverRequired 
  143.                 };
  144.                 
  145.                 if (!additionalSites.some(item => item.pattern === pattern)) {
  146.                     additionalSites.push(entry);
  147.                     GM_setValue(STORAGE_KEY, additionalSites);
  148.                     mergedSites = [...new Set([...getDefaultList(), ...additionalSites])].map(item => {
  149.                         if (typeof item === 'string') {
  150.                             return { 
  151.                                 pattern: normalizeUrl(item), 
  152.                                 preProcessingRequired: false, 
  153.                                 postProcessingRequired: false, 
  154.                                 onDemandFloatingButtonRequired: false, 
  155.                                 backgroundChangeObserverRequired: false 
  156.                             };
  157.                         }
  158.                         return { 
  159.                             ...item, 
  160.                             pattern: normalizeUrl(item.pattern),
  161.                             onDemandFloatingButtonRequired: item.onDemandFloatingButtonRequired || false,
  162.                             backgroundChangeObserverRequired: item.backgroundChangeObserverRequired || false
  163.                         };
  164.                     });
  165.                     alert(`✅ Added site with pattern: ${pattern}`);
  166.                 } else {
  167.                     alert(`⚠️ Pattern "${pattern}" is already in the list.`);
  168.                 }
  169.             }
  170.         }
  171.  
  172.         function viewIncludedSites() {
  173.             const siteList = additionalSites.map(item => {
  174.                 const status = formatStatus(item.preProcessingRequired, item.postProcessingRequired, item.onDemandFloatingButtonRequired, item.backgroundChangeObserverRequired);
  175.                 return `${item.pattern}${status ? ` (${status})` : ''}`;
  176.             }).join("\n");
  177.             alert(`🔍 Included Sites:\n${siteList || "No sites added yet."}`);
  178.         }
  179.  
  180.         function deleteEntries() {
  181.             if (additionalSites.length === 0) return alert("⚠️ No user-defined entries to delete.");
  182.             const userChoice = prompt("Select entries to delete (comma-separated numbers):\n" +
  183.                 additionalSites.map((item, index) => `${index + 1}. ${item.pattern}`).join("\n"));
  184.             if (!userChoice) return;
  185.             const indicesToRemove = userChoice.split(',').map(num => parseInt(num.trim(), 10) - 1);
  186.             additionalSites = additionalSites.filter((_, index) => !indicesToRemove.includes(index));
  187.             GM_setValue(STORAGE_KEY, additionalSites);
  188.             mergedSites = [...new Set([...getDefaultList(), ...additionalSites])].map(item => {
  189.                 if (typeof item === 'string') {
  190.                     return { pattern: normalizeUrl(item), preProcessingRequired: false, postProcessingRequired: false };
  191.                 }
  192.                 return { ...item, pattern: normalizeUrl(item.pattern) };
  193.             });
  194.             alert("✅ Selected entries have been deleted.");
  195.         }
  196.  
  197.         function editEntry() {
  198.             if (additionalSites.length === 0) return alert("⚠️ No user-defined entries to edit.");
  199.             const userChoice = prompt("Select an entry to edit:\n" +
  200.                 additionalSites.map((item, index) => {
  201.                     const status = formatStatus(item.preProcessingRequired, item.postProcessingRequired, item.onDemandFloatingButtonRequired, item.backgroundChangeObserverRequired);
  202.                     return `${index + 1}. ${item.pattern}${status ? ` (${status})` : ''}`;
  203.                 }).join("\n"));
  204.             if (!userChoice) return;
  205.             const selectedIndex = parseInt(userChoice, 10) - 1;
  206.             if (selectedIndex < 0 || selectedIndex >= additionalSites.length) return alert("❌ Invalid selection.");
  207.             const entry = additionalSites[selectedIndex];
  208.             const newPattern = normalizeUrl(prompt("Edit the pattern:", entry.pattern));
  209.             if (!newPattern || !newPattern.trim()) return;
  210.         
  211.             const preProcessingRequired = prompt("Is pre-processing required? (y/n)", entry.preProcessingRequired ? "y" : "n").toLowerCase() === 'y';
  212.             const postProcessingRequired = prompt("Is post-processing required? (y/n)", entry.postProcessingRequired ? "y" : "n").toLowerCase() === 'y';
  213.             const onDemandFloatingButtonRequired = prompt("Is on-demand floating button required? (y/n)", entry.onDemandFloatingButtonRequired ? "y" : "n").toLowerCase() === 'y';
  214.             const backgroundChangeObserverRequired = prompt("Is background change observer required? (y/n)", entry.backgroundChangeObserverRequired ? "y" : "n").toLowerCase() === 'y';
  215.         
  216.             entry.pattern = newPattern.trim();
  217.             entry.preProcessingRequired = preProcessingRequired;
  218.             entry.postProcessingRequired = postProcessingRequired;
  219.             entry.onDemandFloatingButtonRequired = onDemandFloatingButtonRequired;
  220.             entry.backgroundChangeObserverRequired = backgroundChangeObserverRequired;
  221.             GM_setValue(STORAGE_KEY, additionalSites);
  222.             mergedSites = [...new Set([...getDefaultList(), ...additionalSites])].map(item => {
  223.                 if (typeof item === 'string') {
  224.                     return { 
  225.                         pattern: normalizeUrl(item), 
  226.                         preProcessingRequired: false, 
  227.                         postProcessingRequired: false, 
  228.                         onDemandFloatingButtonRequired: false, 
  229.                         backgroundChangeObserverRequired: false 
  230.                     };
  231.                 }
  232.                 return { 
  233.                     ...item, 
  234.                     pattern: normalizeUrl(item.pattern),
  235.                     onDemandFloatingButtonRequired: item.onDemandFloatingButtonRequired || false,
  236.                     backgroundChangeObserverRequired: item.backgroundChangeObserverRequired || false
  237.                 };
  238.             });
  239.             alert("✅ Entry updated.");
  240.         }
  241.  
  242.         function clearAllEntries() {
  243.             if (additionalSites.length === 0) return alert("⚠️ No user-defined entries to clear.");
  244.             if (confirm(`🚨 You have ${additionalSites.length} entries. Clear all?`)) {
  245.                 additionalSites = [];
  246.                 GM_setValue(STORAGE_KEY, additionalSites);
  247.                 mergedSites = [...getDefaultList()].map(item => {
  248.                     if (typeof item === 'string') {
  249.                         return { pattern: normalizeUrl(item), preProcessingRequired: false, postProcessingRequired: false };
  250.                     }
  251.                     return { ...item, pattern: normalizeUrl(item.pattern) };
  252.                 });
  253.                 alert("✅ All user-defined entries cleared.");
  254.             }
  255.         }
  256.  
  257.         // function exportAdditionalSites() {
  258.         //     GM_download("data:text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(additionalSites, null, 2)), "additionalSites_backup.json");
  259.         //     alert("📤 Additional sites exported as JSON.");
  260.         // }
  261.  
  262.         function exportAdditionalSites() {
  263.             const data = JSON.stringify(additionalSites, null, 2);
  264.             const blob = new Blob([data], { type: 'application/json' });
  265.             const url = URL.createObjectURL(blob);
  266.             const a = document.createElement('a');
  267.             a.href = url;
  268.             a.download = 'additionalSites_backup.json';
  269.             document.body.appendChild(a);
  270.             a.click();
  271.             document.body.removeChild(a);
  272.             URL.revokeObjectURL(url);
  273.             alert("📤 Additional sites exported as JSON.");
  274.         }
  275.  
  276.         // function importAdditionalSites() {
  277.         //     const input = document.createElement("input");
  278.         //     input.type = "file";
  279.         //     input.accept = ".json";
  280.         //     input.onchange = event => {
  281.         //         const reader = new FileReader();
  282.         //         reader.onload = e => {
  283.         //             additionalSites = JSON.parse(e.target.result);
  284.         //             GM_setValue(STORAGE_KEY, additionalSites);
  285.         //             mergedSites = [...new Set([...getDefaultList(), ...additionalSites])].map(item => {
  286.         //                 if (typeof item === 'string') {
  287.         //                     return { pattern: normalizeUrl(item), preProcessingRequired: false, postProcessingRequired: false };
  288.         //                 }
  289.         //                 return { ...item, pattern: normalizeUrl(item.pattern) };
  290.         //             });
  291.         //             alert("📥 Sites imported successfully.");
  292.         //         };
  293.         //         reader.readAsText(event.target.files[0]);
  294.         //     };
  295.         //     input.click();
  296.         // }
  297.  
  298.         function importAdditionalSites() {
  299.             const input = document.createElement('input');
  300.             input.type = 'file';
  301.             input.accept = '.json';
  302.             input.style.display = 'none';
  303.             input.onchange = event => {
  304.                 const reader = new FileReader();
  305.                 reader.onload = e => {
  306.                     try {
  307.                         const importedData = JSON.parse(e.target.result);
  308.                         if (Array.isArray(importedData)) {
  309.                             additionalSites = importedData.map(item => {
  310.                                 if (typeof item === 'string') {
  311.                                     return normalizeUrl(item);
  312.                                 } else if (typeof item === 'object' && item.pattern) {
  313.                                     return { ...item, pattern: normalizeUrl(item.pattern) };
  314.                                 }
  315.                                 throw new Error('Invalid data format');
  316.                             });
  317.                             GM_setValue(STORAGE_KEY, additionalSites);
  318.                             mergedSites = [...new Set([...getDefaultList(), ...additionalSites])].map(item => {
  319.                                 if (typeof item === 'string') {
  320.                                     return normalizeUrl(item);
  321.                                 }
  322.                                 return { ...item, pattern: normalizeUrl(item.pattern) };
  323.                             });
  324.                             alert('📥 Sites imported successfully.');
  325.                         } else {
  326.                             throw new Error('Invalid data format');
  327.                         }
  328.                     } catch (error) {
  329.                         alert('❌ Failed to import sites: ' + error.message);
  330.                     }
  331.                 };
  332.                 reader.readAsText(event.target.files[0]);
  333.             };
  334.             document.body.appendChild(input);
  335.             input.click();
  336.             document.body.removeChild(input);
  337.         }
  338.  
  339.         function formatStatus(preProcessingRequired, postProcessingRequired, onDemandFloatingButtonRequired, backgroundChangeObserverRequired) {
  340.             if (SHOW_STATUS_ONLY_IF_TRUE && !preProcessingRequired && !postProcessingRequired && !onDemandFloatingButtonRequired && !backgroundChangeObserverRequired) {
  341.                 return '';
  342.             }
  343.             const preStatus = USE_EMOJI_FOR_STATUS ? (preProcessingRequired ? '✅' : '✖️') : (preProcessingRequired ? 'true' : 'false');
  344.             const postStatus = USE_EMOJI_FOR_STATUS ? (postProcessingRequired ? '✅' : '✖️') : (postProcessingRequired ? 'true' : 'false');
  345.             const floatingButtonStatus = USE_EMOJI_FOR_STATUS ? (onDemandFloatingButtonRequired ? '✅' : '✖️') : (onDemandFloatingButtonRequired ? 'true' : 'false');
  346.             const backgroundObserverStatus = USE_EMOJI_FOR_STATUS ? (backgroundChangeObserverRequired ? '✅' : '✖️') : (backgroundChangeObserverRequired ? 'true' : 'false');
  347.             return `Pre: ${preStatus}, Post: ${postStatus}, Floating Button: ${floatingButtonStatus}, Background Observer: ${backgroundObserverStatus}`;
  348.         }
  349.  
  350.         window.shouldRunOnThisSite = shouldRunOnThisSite;
  351.         window.isPreProcessingRequired = function() {
  352.             const currentFullPath = normalizeUrl(`${window.top.location.href}`);
  353.             const entry = mergedSites.find(item => wildcardToRegex(normalizeUrl(item.pattern)).test(currentFullPath));
  354.             return entry ? entry.preProcessingRequired : false;
  355.         };
  356.         window.isPostProcessingRequired = function() {
  357.             const currentFullPath = normalizeUrl(`${window.top.location.href}`);
  358.             const entry = mergedSites.find(item => wildcardToRegex(normalizeUrl(item.pattern)).test(currentFullPath));
  359.             return entry ? entry.postProcessingRequired : false;
  360.         };
  361.         // Expose isOnDemandFloatingButtonRequired
  362.         window.isOnDemandFloatingButtonRequired = function() {
  363.             const currentFullPath = normalizeUrl(`${window.top.location.href}`);
  364.             const entry = mergedSites.find(item => wildcardToRegex(normalizeUrl(item.pattern)).test(currentFullPath));
  365.             return entry ? entry.onDemandFloatingButtonRequired : false;
  366.         };
  367.  
  368.         // Expose isBackgroundChangeObserverRequired
  369.         window.isBackgroundChangeObserverRequired = function() {
  370.             const currentFullPath = normalizeUrl(`${window.top.location.href}`);
  371.             const entry = mergedSites.find(item => wildcardToRegex(normalizeUrl(item.pattern)).test(currentFullPath));
  372.             return entry ? entry.backgroundChangeObserverRequired : false;
  373.         };
  374.     })();
  375. })();
  376.  
  377. //To use this in another script use @require
  378.  
  379. // // @run-at       document-end
  380. // // ==/UserScript==
  381.  
  382. // window.SCRIPT_STORAGE_KEY = "magnetLinkHashChecker"; // UNIQUE STORAGE KEY
  383.  
  384.  
  385. // window.GET_DEFAULT_LIST = function() {
  386. //      return [
  387. //         { pattern: "*1337x.*", preProcessingRequired: false, postProcessingRequired: false, onDemandFloatingButtonRequired: false, backgroundChangeObserverRequired: false },
  388. //         { pattern: "*yts.*", preProcessingRequired: true, postProcessingRequired: true, onDemandFloatingButtonRequired: false, backgroundChangeObserverRequired: false },
  389. //         { pattern: "*torrentgalaxy.*", preProcessingRequired: false, postProcessingRequired: true, onDemandFloatingButtonRequired: false, backgroundChangeObserverRequired: false },
  390. //         { pattern: "*bitsearch.*", preProcessingRequired: false, postProcessingRequired: false, onDemandFloatingButtonRequired: false, backgroundChangeObserverRequired: false },
  391. //         { pattern: "*thepiratebay.*", preProcessingRequired: false, postProcessingRequired: false, onDemandFloatingButtonRequired: false, backgroundChangeObserverRequired: false },
  392. //         { pattern: "*ext.*", preProcessingRequired: false, postProcessingRequired: false, onDemandFloatingButtonRequired: false, backgroundChangeObserverRequired: false }
  393. //     ];
  394. // };
  395.  
  396.  
  397. // (async function () {
  398. //     'use strict';
  399.  
  400. //     // ✅ Wait until `shouldRunOnThisSite` is available
  401. //     while (typeof shouldRunOnThisSite === 'undefined') {
  402. //         await new Promise(resolve => setTimeout(resolve, 50));
  403. //     }
  404.  
  405. //     if (!(await shouldRunOnThisSite())) return;
  406. //     //alert("running");
  407.  
  408. //     console.log("Pre-Customization enabled for this site: " + isPreProcessingRequired() );
  409. //     console.log("Post-Customization enabled for this site: " + isPostProcessingRequired() );
  410.  
  411. //     const OFFCLOUD_CACHE_API_URL = 'https://offcloud.com/api/cache';