☰

grr

Base library for my scripts

此腳本不應該直接安裝，它是一個供其他腳本使用的函式庫。欲使用本函式庫，請在腳本 metadata 寫上： // @require https://update.cn-greasyfork.org/scripts/411595/849664/grr.js 

  1. // ==UserScript==
  2. // @name          grr
  3. // @namespace     brazenvoid
  4. // @version       1.0
  5. // @author        brazenvoid
  6. // @license       GPL-3.0-only
  7. // @description   Base library for my scripts
  8. // @grant         GM_addStyle
  9. // @run-at  	  document-end
  10. // ==/UserScript==
  11.  
  12. /**
  13.  * @function GM_addStyle
  14.  * @param {string} style
  15.  */
  16. GM_addStyle(
  17.     `@keyframes fadeEffect{from{opacity:0}to{opacity:1}}button.form-button{padding:0 5px;width:100%}button.show-settings{background-color:#ffa31a;border:0;margin:2px 5px;padding:2px 5px;width:100%}button.show-settings.fixed{color:#000;font-size:.7rem;left:0;height:90vh;margin:0;padding:0;position:fixed;top:5vh;width:.1vw;writing-mode:sideways-lr;z-index:999}button.tab-button{background-color:inherit;border:1px solid #000;border-bottom:0;border-top-left-radius:3px;border-top-right-radius:3px;cursor:pointer;float:left;outline:none;padding:5px 10px;transition:.3s}button.tab-button:hover{background-color:#fff}button.tab-button.active{background-color:#fff;display:block}div.form-actions{text-align:center}div.form-actions button.form-button{padding:0 15px;width:auto}div.form-actions-wrapper{display:inline-flex}div.form-actions-wrapper > div.form-group + *{margin-left:15px}div.form-group{min-height:15px;padding:4px 0}div.form-group.form-range-input-group > input{padding:0 5px;width:70px}div.form-group.form-range-input-group > input + input{margin-right:5px}div.form-section{text-align:center}div.form-section button + button{margin-left:5px}div.form-section label.title{display:block;height:20px;width:100%}div.form-section button.form-button{width:auto}div.tab-panel{animation:fadeEffect 1s;border:1px solid #000;display:none;padding:5px 10px}div.tab-panel.active{display:block}div.tabs-nav{overflow:hidden}div.tabs-section{margin-bottom:5px}hr{margin:3px}input.form-input{height:18px;text-align:center}input.form-input.check-radio-input{float:left;margin-right:5px}input.form-input.regular-input{float:right;width:100px}label.form-label{padding:2px 0}label.form-label.regular-input{float:left}label.form-label.check-radio-input{float:left}label.form-stat-label{float:right;padding:2px 0}section.form-section{color:#000;font-size:12px;font-weight:700;position:fixed;left:0;padding:5px 10px;z-index:1000}select.form-dropdown{float:right;height:18px;text-align:center;width:100px}textarea.form-input{display:block;height:auto;position:relative;width:98%}`)
  18.  
  19. /**
  20.  * @param milliseconds
  21.  * @return {Promise<*>}
  22.  */
  23. const sleep = (milliseconds) => {
  24.     return new Promise(resolve => setTimeout(resolve, milliseconds))
  25. }
  26.  
  27. /**
  28.  * @param {string} text
  29.  * @return {string}
  30.  */
  31. function toKebabCase (text)
  32. {
  33.     return text.toLowerCase().replace(' ', '-')
  34. }
  35.  
  36. class ChildObserver
  37. {
  38.     /**
  39.      * @callback observerOnMutation
  40.      * @param {NodeList} nodes
  41.      */
  42.  
  43.     /**
  44.      * @return {ChildObserver}
  45.      */
  46.     static create ()
  47.     {
  48.         return new ChildObserver
  49.     }
  50.  
  51.     /**
  52.      * ChildObserver constructor
  53.      */
  54.     constructor ()
  55.     {
  56.         this._node = null
  57.         this._observer = null
  58.         this._onNodesAdded = null
  59.         this._onNodesRemoved = null
  60.     }
  61.  
  62.     /**
  63.      * @return {ChildObserver}
  64.      * @private
  65.      */
  66.     _observeNodes ()
  67.     {
  68.         this._observer.observe(this._node, {childList: true})
  69.         return this
  70.     }
  71.  
  72.     /**
  73.      * Attach an observer to the specified node(s)
  74.      * @param {Node} node
  75.      * @returns {ChildObserver}
  76.      */
  77.     observe (node)
  78.     {
  79.         this._node = node
  80.         this._observer = new MutationObserver((mutations) => {
  81.             for (let mutation of mutations) {
  82.                 if (mutation.addedNodes.length && this._onNodesAdded !== null) {
  83.                     this._onNodesAdded(
  84.                         mutation.addedNodes,
  85.                         mutation.previousSibling,
  86.                         mutation.nextSibling,
  87.                         mutation.target,
  88.                     )
  89.                 }
  90.                 if (mutation.removedNodes.length && this._onNodesRemoved !== null) {
  91.                     this._onNodesRemoved(
  92.                         mutation.removedNodes,
  93.                         mutation.previousSibling,
  94.                         mutation.nextSibling,
  95.                         mutation.target,
  96.                     )
  97.                 }
  98.             }
  99.         })
  100.         return this._observeNodes()
  101.     }
  102.  
  103.     /**
  104.      * @param {observerOnMutation} eventHandler
  105.      * @returns {ChildObserver}
  106.      */
  107.     onNodesAdded (eventHandler)
  108.     {
  109.         this._onNodesAdded = eventHandler
  110.         return this
  111.     }
  112.  
  113.     /**
  114.      * @param {observerOnMutation} eventHandler
  115.      * @returns {ChildObserver}
  116.      */
  117.     onNodesRemoved (eventHandler)
  118.     {
  119.         this._onNodesRemoved = eventHandler
  120.         return this
  121.     }
  122.  
  123.     pauseObservation ()
  124.     {
  125.         this._observer.disconnect()
  126.     }
  127.  
  128.     resumeObservation ()
  129.     {
  130.         this._observeNodes()
  131.     }
  132. }
  133.  
  134. class LocalStore
  135. {
  136.     /**
  137.      * @callback storeEventHandler
  138.      * @param {Object} store
  139.      */
  140.  
  141.     /**
  142.      * @param {string} scriptPrefix
  143.      * @param {Object} defaults
  144.      * @return {LocalStore}
  145.      */
  146.     static createGlobalConfigStore (scriptPrefix, defaults)
  147.     {
  148.         return new LocalStore(scriptPrefix + 'globals', defaults)
  149.     }
  150.  
  151.     static createPresetConfigStore (scriptPrefix, defaults)
  152.     {
  153.         return new LocalStore(scriptPrefix + 'presets', [
  154.             {
  155.                 name: 'default',
  156.                 config: defaults,
  157.             },
  158.         ])
  159.     }
  160.  
  161.     /**
  162.      * @param {string} key
  163.      * @param {Object} defaults
  164.      */
  165.     constructor (key, defaults)
  166.     {
  167.         /**
  168.          * @type {string}
  169.          * @private
  170.          */
  171.         this._key = key
  172.  
  173.         /**
  174.          * @type {Object}
  175.          * @private
  176.          */
  177.         this._store = {}
  178.  
  179.         /**
  180.          * @type {string}
  181.          * @private
  182.          */
  183.         this._defaults = this._toJSON(defaults)
  184.  
  185.         /**
  186.          * @type {storeEventHandler}
  187.          */
  188.         this._onChange = null
  189.     }
  190.  
  191.     /**
  192.      * @param {string} json
  193.      * @return {Object}
  194.      * @private
  195.      */
  196.     _fromJSON (json)
  197.     {
  198.         /** @type {{arrays: Object, objects: Object, properties: Object}} */
  199.         let parsedJSON = JSON.parse(json)
  200.         let arrayObject = {}
  201.         let store = {}
  202.  
  203.         for (let property in parsedJSON.arrays) {
  204.             arrayObject = JSON.parse(parsedJSON.arrays[property])
  205.             store[property] = []
  206.  
  207.             for (let key in arrayObject) {
  208.                 store[property].push(arrayObject[key])
  209.             }
  210.         }
  211.         for (let property in parsedJSON.objects) {
  212.             store[property] = this._fromJSON(parsedJSON.objects[property])
  213.         }
  214.         for (let property in parsedJSON.properties) {
  215.             store[property] = parsedJSON.properties[property]
  216.         }
  217.         return store
  218.     }
  219.  
  220.     /**
  221.      * @return {string}
  222.      * @private
  223.      */
  224.     _getStore ()
  225.     {
  226.         return window.localStorage.getItem(this._key)
  227.     }
  228.  
  229.     /**
  230.      * @return {Object}
  231.      * @private
  232.      */
  233.     _getDefaults ()
  234.     {
  235.         return this._fromJSON(this._defaults)
  236.     }
  237.  
  238.     /**
  239.      * @param {Object} store
  240.      * @return {string}
  241.      * @private
  242.      */
  243.     _toJSON (store)
  244.     {
  245.         let arrayToObject = {}
  246.         let json = {arrays: {}, objects: {}, properties: {}}
  247.  
  248.         for (let property in store) {
  249.             if (typeof store[property] === 'object') {
  250.                 if (Array.isArray(store[property])) {
  251.                     for (let key in store[property]) {
  252.                         arrayToObject[key] = store[property][key]
  253.                     }
  254.                     json.arrays[property] = JSON.stringify(arrayToObject)
  255.                 } else {
  256.                     json.objects[property] = this._toJSON(store[property])
  257.                 }
  258.             } else {
  259.                 json.properties[property] = store[property]
  260.             }
  261.         }
  262.         return JSON.stringify(json)
  263.     }
  264.  
  265.     _handleOnChange ()
  266.     {
  267.         if (this._onChange !== null) {
  268.             this._onChange(this._store)
  269.         }
  270.     }
  271.  
  272.     /**
  273.      * @return {LocalStore}
  274.      */
  275.     delete ()
  276.     {
  277.         window.localStorage.removeItem(this._key)
  278.         return this
  279.     }
  280.  
  281.     /**
  282.      * @return {*}
  283.      */
  284.     get ()
  285.     {
  286.         return this._store
  287.     }
  288.  
  289.     /**
  290.      * @return {boolean}
  291.      */
  292.     isPurged ()
  293.     {
  294.         return this._getStore() === null
  295.     }
  296.  
  297.     /**
  298.      * @param {storeEventHandler} handler
  299.      * @return {LocalStore}
  300.      */
  301.     onChange (handler)
  302.     {
  303.         this._onChange = handler
  304.         return this
  305.     }
  306.  
  307.     /**
  308.      * @return {LocalStore}
  309.      */
  310.     restoreDefaults ()
  311.     {
  312.         this._store = this._getDefaults()
  313.         this._handleOnChange()
  314.         return this
  315.     }
  316.  
  317.     /**
  318.      * @return {LocalStore}
  319.      */
  320.     retrieve ()
  321.     {
  322.         let storedStore = this._getStore()
  323.         if (storedStore === null) {
  324.             this.restoreDefaults()
  325.         } else {
  326.             this._store = this._fromJSON(storedStore)
  327.         }
  328.         this._handleOnChange()
  329.         return this
  330.     }
  331.  
  332.     /**
  333.      * @return {LocalStore}
  334.      */
  335.     save ()
  336.     {
  337.         window.localStorage.setItem(this._key, this._toJSON(this._store))
  338.         this._handleOnChange()
  339.         return this
  340.     }
  341.  
  342.     /**
  343.      * @param {*} data
  344.      * @return {LocalStore}
  345.      */
  346.     update (data)
  347.     {
  348.         this._store = data
  349.         return this.save()
  350.     }
  351. }
  352.  
  353. class SelectorGenerator
  354. {
  355.     /**
  356.      * @param {string} selectorPrefix
  357.      */
  358.     constructor (selectorPrefix)
  359.     {
  360.         /**
  361.          * @type {string}
  362.          * @private
  363.          */
  364.         this._prefix = selectorPrefix
  365.     }
  366.  
  367.     /**
  368.      * @param {string} selector
  369.      * @return {string}
  370.      */
  371.     getSelector (selector)
  372.     {
  373.         return this._prefix + selector
  374.     }
  375.  
  376.     /**
  377.      * @param {string} settingName
  378.      * @return {string}
  379.      */
  380.     getSettingsInputSelector (settingName)
  381.     {
  382.         return this.getSelector(toKebabCase(settingName) + '-setting')
  383.     }
  384.  
  385.     /**
  386.      * @param {string} settingName
  387.      * @param {boolean} getMinInputSelector
  388.      * @return {string}
  389.      */
  390.     getSettingsRangeInputSelector (settingName, getMinInputSelector)
  391.     {
  392.         return this.getSelector(toKebabCase(settingName) + (getMinInputSelector ? '-min' : '-max') + '-setting')
  393.     }
  394.  
  395.     /**
  396.      * @param {string} statisticType
  397.      * @return {string}
  398.      */
  399.     getStatLabelSelector (statisticType)
  400.     {
  401.         return this.getSelector(toKebabCase(statisticType) + '-stat')
  402.     }
  403. }
  404.  
  405. class StatisticsRecorder
  406. {
  407.     /**
  408.      * @param {string} selectorPrefix
  409.      */
  410.     constructor (selectorPrefix)
  411.     {
  412.         /**
  413.          * @type {SelectorGenerator}
  414.          * @private
  415.          */
  416.         this._selectorGenerator = new SelectorGenerator(selectorPrefix)
  417.  
  418.         /**
  419.          * @type {{Total: number}}
  420.          * @private
  421.          */
  422.         this._statistics = {Total: 0}
  423.     }
  424.  
  425.     /**
  426.      * @param {string} statisticType
  427.      * @param {boolean} validationResult
  428.      * @param {number} value
  429.      */
  430.     record (statisticType, validationResult, value = 1)
  431.     {
  432.         if (!validationResult) {
  433.             if (typeof this._statistics[statisticType] !== 'undefined') {
  434.                 this._statistics[statisticType] += value
  435.             } else {
  436.                 this._statistics[statisticType] = value
  437.             }
  438.             this._statistics.Total += value
  439.         }
  440.     }
  441.  
  442.     reset ()
  443.     {
  444.         for (const statisticType in this._statistics) {
  445.             this._statistics[statisticType] = 0
  446.         }
  447.     }
  448.  
  449.     updateUI ()
  450.     {
  451.         let label, labelSelector
  452.  
  453.         for (const statisticType in this._statistics) {
  454.             labelSelector = this._selectorGenerator.getStatLabelSelector(statisticType)
  455.             label = document.getElementById(labelSelector)
  456.             if (label !== null) {
  457.                 label.textContent = this._statistics[statisticType]
  458.             }
  459.         }
  460.     }
  461. }
  462.  
  463. class UIGenerator
  464. {
  465.     /**
  466.      * @param {HTMLElement|Node} node
  467.      */
  468.     static appendToBody (node)
  469.     {
  470.         document.getElementsByTagName('body')[0].appendChild(node)
  471.     }
  472.  
  473.     /**
  474.      * @param {HTMLElement} node
  475.      * @param {HTMLElement[]} children
  476.      * @return {HTMLElement}
  477.      */
  478.     static populateChildren (node, children)
  479.     {
  480.         for (let child of children) {
  481.             node.appendChild(child)
  482.         }
  483.         return node
  484.     }
  485.  
  486.     /**
  487.      * @param {boolean} showUI
  488.      * @param {string} selectorPrefix
  489.      */
  490.     constructor (showUI, selectorPrefix)
  491.     {
  492.         /**
  493.          * @type {*}
  494.          * @private
  495.          */
  496.         this._buttonBackroundColor = null
  497.  
  498.         /**
  499.          * @type {HTMLElement}
  500.          * @private
  501.          */
  502.         this._section = null
  503.  
  504.         /**
  505.          * @type {SelectorGenerator}
  506.          * @private
  507.          */
  508.         this._selectorGenerator = new SelectorGenerator(selectorPrefix)
  509.  
  510.         /**
  511.          * @type {string}
  512.          * @private
  513.          */
  514.         this._selectorPrefix = selectorPrefix
  515.  
  516.         /**
  517.          * @type {boolean}
  518.          * @private
  519.          */
  520.         this._showUI = showUI
  521.  
  522.         /**
  523.          * @type {HTMLLabelElement}
  524.          * @private
  525.          */
  526.         this._statusLine = null
  527.  
  528.         /**
  529.          * @type {string}
  530.          * @private
  531.          */
  532.         this._statusText = ''
  533.     }
  534.  
  535.     /**
  536.      * @param {HTMLElement} node
  537.      * @param {string} text
  538.      * @return {this}
  539.      * @private
  540.      */
  541.     _addHelpTextOnHover (node, text)
  542.     {
  543.         node.addEventListener('mouseover', () => this.updateStatus(text, true))
  544.         node.addEventListener('mouseout', () => this.resetStatus())
  545.     }
  546.  
  547.     /**
  548.      * @param {HTMLElement[]} children
  549.      * @return {HTMLElement}
  550.      */
  551.     addSectionChildren (children)
  552.     {
  553.         return UIGenerator.populateChildren(this._section, children)
  554.     }
  555.  
  556.     /**
  557.      * @return {HTMLBRElement}
  558.      */
  559.     createBreakSeparator ()
  560.     {
  561.         return document.createElement('br')
  562.     }
  563.  
  564.     /**
  565.      * @param {HTMLElement[]} children
  566.      * @return {HTMLDivElement}
  567.      */
  568.     createFormActions (children)
  569.     {
  570.         let wrapperDiv = document.createElement('div')
  571.         wrapperDiv.classList.add('form-actions-wrapper')
  572.  
  573.         UIGenerator.populateChildren(wrapperDiv, children)
  574.  
  575.         let formActionsDiv = document.createElement('div')
  576.         formActionsDiv.classList.add('form-actions')
  577.         formActionsDiv.appendChild(wrapperDiv)
  578.  
  579.         return formActionsDiv
  580.     }
  581.  
  582.     /**
  583.      * @param {string} caption
  584.      * @param {EventListenerOrEventListenerObject} onClick
  585.      * @param {string} hoverHelp
  586.      * @return {HTMLButtonElement}
  587.      */
  588.     createFormButton (caption, onClick, hoverHelp = '')
  589.     {
  590. 		console.log (caption);
  591.  
  592.         let button = document.createElement('button')
  593. 		if (caption == 'Apply')
  594. 		{
  595.         button.classList.add('grrapp')
  596. 		} else {
  597. 		button.classList.add('formapp')
  598. 		}
  599.         button.textContent = caption
  600.         button.addEventListener('click', onClick)
  601.  
  602.         if (hoverHelp !== '') {
  603.             this._addHelpTextOnHover(button, hoverHelp)
  604.         }
  605.         if (this._buttonBackroundColor !== null) {
  606.             button.style.backgroundColor = this._buttonBackroundColor
  607.         }
  608.         return button
  609.     }
  610.  
  611.     /**
  612.      * @param {HTMLElement[]} children
  613.      * @return {HTMLElement}
  614.      */
  615.     createFormGroup (children)
  616.     {
  617.         let divFormGroup = document.createElement('div')
  618.         divFormGroup.classList.add('form-group')
  619.  
  620.         return UIGenerator.populateChildren(divFormGroup, children)
  621.     }
  622.  
  623.     /**
  624.      * @param {string} id
  625.      * @param {Array} keyValuePairs
  626.      * @param {*} defaultValue
  627.      * @return {HTMLSelectElement}
  628.      */
  629.     createFormGroupDropdown (id, keyValuePairs, defaultValue = null)
  630.     {
  631.         let dropdown = document.createElement('select'), item
  632.         dropdown.id = id
  633.         dropdown.classList.add('form-dropdown')
  634.  
  635.         for (let [key, value] of keyValuePairs) {
  636.             item = document.createElement('option')
  637.             item.textContent = value
  638.             item.value = key
  639.             dropdown.appendChild(item)
  640.         }
  641.         dropdown.value = defaultValue === null ? keyValuePairs[0][0] : defaultValue
  642.  
  643.         return dropdown
  644.     }
  645.  
  646.     /**
  647.      * @param {string} id
  648.      * @param {string} type
  649.      * @param {*} defaultValue
  650.      * @return {HTMLInputElement}
  651.      */
  652.     createFormGroupInput (id, type, defaultValue = null)
  653.     {
  654.         let inputFormGroup = document.createElement('input')
  655.         inputFormGroup.id = id
  656.         inputFormGroup.classList.add('form-input')
  657.         inputFormGroup.type = type
  658.  
  659.         switch (type) {
  660.             case 'number':
  661.             case 'text':
  662.                 inputFormGroup.classList.add('regular-input')
  663.  
  664.                 if (defaultValue !== null) {
  665.                     inputFormGroup.value = defaultValue
  666.                 }
  667.                 break
  668.             case 'radio':
  669.             case 'checkbox':
  670.                 inputFormGroup.classList.add('check-radio-input')
  671.  
  672.                 if (defaultValue !== null) {
  673.                     inputFormGroup.checked = defaultValue
  674.                 }
  675.                 break
  676.         }
  677.         return inputFormGroup
  678.     }
  679.  
  680.     /**
  681.      * @param {string} label
  682.      * @param {string} inputID
  683.      * @param {string} inputType
  684.      * @return {HTMLLabelElement}
  685.      */
  686.     createFormGroupLabel (label, inputID = '', inputType = '')
  687.     {
  688.         let labelFormGroup = document.createElement('label')
  689.         labelFormGroup.classList.add('form-label')
  690.         labelFormGroup.textContent = label
  691.  
  692.         if (inputID !== '') {
  693.             labelFormGroup.setAttribute('for', inputID)
  694.         }
  695.         if (inputType !== '') {
  696.             switch (inputType) {
  697.                 case 'number':
  698.                 case 'text':
  699.                     labelFormGroup.classList.add('regular-input')
  700.                     labelFormGroup.textContent += ': '
  701.                     break
  702.                 case 'radio':
  703.                 case 'checkbox':
  704.                     labelFormGroup.classList.add('check-radio-input')
  705.                     break
  706.             }
  707.         }
  708.         return labelFormGroup
  709.     }
  710.  
  711.     /**
  712.      * @param {string} statisticType
  713.      * @return {HTMLLabelElement}
  714.      */
  715.     createFormGroupStatLabel (statisticType)
  716.     {
  717.         let labelFormGroup = document.createElement('label')
  718.         labelFormGroup.id = this._selectorGenerator.getStatLabelSelector(statisticType)
  719.         labelFormGroup.classList.add('form-stat-label')
  720.         labelFormGroup.textContent = '0'
  721.  
  722.         return labelFormGroup
  723.     }
  724.  
  725.     /**
  726.      * @param {string} label
  727.      * @param {string} inputType
  728.      * @param {string} hoverHelp
  729.      * @param {*} defaultValue
  730.      * @return {HTMLElement}
  731.      */
  732.     createFormInputGroup (label, inputType = 'text', hoverHelp = '', defaultValue = null)
  733.     {
  734.         let divFormInputGroup
  735.         let inputID = this._selectorGenerator.getSettingsInputSelector(label)
  736.         let labelFormGroup = this.createFormGroupLabel(label, inputID, inputType)
  737.         let inputFormGroup = this.createFormGroupInput(inputID, inputType, defaultValue)
  738.  
  739.         switch (inputType) {
  740.             case 'number':
  741.             case 'text':
  742.                 divFormInputGroup = this.createFormGroup([labelFormGroup, inputFormGroup])
  743.                 break
  744.             case 'radio':
  745.             case 'checkbox':
  746.                 divFormInputGroup = this.createFormGroup([inputFormGroup, labelFormGroup])
  747.                 break
  748.         }
  749.         if (hoverHelp !== '') {
  750.             this._addHelpTextOnHover(divFormInputGroup, hoverHelp)
  751.         }
  752. 		
  753.         return divFormInputGroup
  754.     }
  755.  
  756.     /**
  757.      * @param {string} label
  758.      * @param {string} inputsType
  759.      * @param {int[]|string[]} defaultValues
  760.      * @return {HTMLElement}
  761.      */
  762.     createFormRangeInputGroup (label, inputsType = 'text', defaultValues = [])
  763.     {
  764.         let maxInputSelector = this._selectorGenerator.getSettingsRangeInputSelector(label, false)
  765.         let minInputSelector = this._selectorGenerator.getSettingsRangeInputSelector(label, true)
  766.  
  767.         let divFormInputGroup = this.createFormGroup([
  768.             this.createFormGroupLabel(label, '', inputsType),
  769.             this.createFormGroupInput(maxInputSelector, inputsType, defaultValues.length ? defaultValues[1] : null),
  770.             this.createFormGroupInput(minInputSelector, inputsType, defaultValues.length ? defaultValues[0] : null),
  771.         ])
  772.         divFormInputGroup.classList.add('form-range-input-group')
  773.  
  774.         return divFormInputGroup
  775.     }
  776.  
  777.     /**
  778.      * @param {string} title
  779.      * @param {HTMLElement[]} children
  780.      * @return {HTMLElement|HTMLDivElement}
  781.      */
  782.     createFormSection (title, children)
  783.     {
  784.         let sectionDiv = document.createElement('div')
  785.         sectionDiv.classList.add('form-section')
  786.  
  787.         if (title !== '') {
  788.             let sectionTitle = document.createElement('label')
  789.             sectionTitle.textContent = title
  790.             sectionTitle.classList.add('title')
  791.             UIGenerator.populateChildren(sectionDiv, [sectionTitle])
  792.         }
  793.         return UIGenerator.populateChildren(sectionDiv, children)
  794.     }
  795.  
  796.     /**
  797.      * @param {string} caption
  798.      * @param {string} tooltip
  799.      * @param {EventListenerOrEventListenerObject} onClick
  800.      * @param {string} hoverHelp
  801.      * @return {HTMLButtonElement}
  802.      */
  803.     createFormSectionButton (caption, tooltip, onClick, hoverHelp = '', grr= '')
  804.     {
  805.         let button = this.createFormButton(caption, onClick, hoverHelp, grr)
  806.         button.title = tooltip
  807.  
  808.         return button
  809.     }
  810.  
  811.     /**
  812.      * @param {string} label
  813.      * @param {int} rows
  814.      * @param {string} hoverHelp
  815.      * @param {string} defaultValue
  816.      * @return {HTMLElement}
  817.      */
  818.     createFormTextAreaGroup (label, rows, hoverHelp = '', defaultValue = '')
  819.     {
  820.         let labelElement = this.createFormGroupLabel(label)
  821.         labelElement.style.textAlign = 'center'
  822.  
  823.         let textAreaElement = document.createElement('textarea')
  824.         textAreaElement.id = this._selectorGenerator.getSettingsInputSelector(label)
  825.         textAreaElement.classList.add('form-input')
  826.         textAreaElement.value = defaultValue
  827.         textAreaElement.setAttribute('rows', rows.toString())
  828.  
  829.         let group = this.createFormGroup([labelElement, textAreaElement])
  830.  
  831.         if (hoverHelp !== '') {
  832.             this._addHelpTextOnHover(group, hoverHelp)
  833.         }
  834.         return group
  835.     }
  836.  
  837.     /**
  838.      * @param {string} IDSuffix
  839.      * @param {*} backgroundColor
  840.      * @param {*} top
  841.      * @param {*} width
  842.      * @return {this}
  843.      */
  844.     createSection (IDSuffix, backgroundColor, top, width)
  845.     {
  846.         this._section = document.createElement('section')
  847.         this._section.id = this._selectorGenerator.getSelector(IDSuffix)
  848.         this._section.classList.add('form-section')
  849.         this._section.style.display = this._showUI ? 'block' : 'none'
  850.         this._section.style.top = top
  851.         this._section.style.width = width
  852.         this._section.style.backgroundColor = backgroundColor
  853.  
  854.         return this
  855.     }
  856.  
  857.     /**
  858.      * @return {HTMLHRElement}
  859.      */
  860.     createSeparator ()
  861.     {
  862.         return document.createElement('hr')
  863.     }
  864.  
  865.     /**
  866.      * @param {LocalStore} localStore
  867.      * @param {EventListenerOrEventListenerObject|Function} onClick
  868.      * @param {boolean} addTopPadding
  869.      * @return {HTMLDivElement}
  870.      */
  871.     createSettingsFormActions (localStore, onClick, addTopPadding = false)
  872.     {
  873.         let divFormActions = this.createFormSection('', [
  874.             this.createFormActions([
  875.                 this.createFormButton('Apply', onClick, 'Filter items as per the settings in the dialog.', 'derpapply'),
  876.                 this.createFormButton('Reset', () => {
  877.                     localStore.retrieve()
  878.                     onClick()
  879.                 }, 'Restore and apply saved configuration.', 'derpreset'),
  880.             ]),
  881.         ])
  882.         if (addTopPadding) {
  883.             divFormActions.style.paddingTop = '10px'
  884.         }
  885.         return divFormActions
  886.     }
  887.  
  888.     /**
  889.      * @param {string} label
  890.      * @param {Array} keyValuePairs
  891.      * @param {*} defaultValue
  892.      * @return {HTMLElement}
  893.      */
  894.     createSettingsDropDownFormGroup (label, keyValuePairs, defaultValue = null)
  895.     {
  896.         let dropdownID = this._selectorGenerator.getSettingsInputSelector(label)
  897.  
  898.         return this.createFormGroup([
  899.             this.createFormGroupLabel(label, dropdownID, 'text'),
  900.             this.createFormGroupDropdown(dropdownID, keyValuePairs, defaultValue),
  901.         ])
  902.     }
  903.  
  904.     /**
  905.      * @return {HTMLButtonElement}
  906.      */
  907.     createSettingsHideButton ()
  908.     {
  909.         let section = this._section
  910.         return this.createFormButton('<< Hide', () => section.style.display = 'none')
  911.     }
  912.  
  913.     /**
  914.      * @param {string} caption
  915.      * @param {HTMLElement} settingsSection
  916.      * @param {boolean} fixed
  917.      * @param {EventListenerOrEventListenerObject|Function|null} onMouseLeave
  918.      * @return {HTMLButtonElement}
  919.      */
  920.     createSettingsShowButton (caption, settingsSection, fixed = true, onMouseLeave = null)
  921.     {
  922.         let controlButton = document.createElement('button')
  923.         controlButton.textContent = caption
  924.         controlButton.classList.add('show-settings')
  925.  
  926.         if (fixed) {
  927.             controlButton.classList.add('fixed')
  928.         }
  929.         controlButton.addEventListener('click', () => {
  930.             let settingsUI = document.getElementById(settingsSection.id)
  931.             settingsUI.style.display = settingsUI.style.display === 'none' ? 'block' : 'none'
  932.         })
  933.         settingsSection.addEventListener('mouseleave', onMouseLeave ? () => onMouseLeave() : () => settingsSection.style.display = 'none')
  934.  
  935.         return controlButton
  936.     }
  937.  
  938.     /**
  939.      * @param {string} statisticsType
  940.      * @param {string} label
  941.      * @return {HTMLElement}
  942.      */
  943.     createStatisticsFormGroup (statisticsType, label = '')
  944.     {
  945.         if (label === '') {
  946.             label = statisticsType
  947.         }
  948.         return this.createFormGroup([
  949.             this.createFormGroupLabel(label + ' Filter'),
  950.             this.createFormGroupStatLabel(statisticsType),
  951.         ])
  952.     }
  953.  
  954.     /**
  955.      * @return {HTMLElement}
  956.      */
  957.     createStatisticsTotalsGroup ()
  958.     {
  959.         return this.createFormGroup([
  960.             this.createFormGroupLabel('Total'),
  961.             this.createFormGroupStatLabel('Total'),
  962.         ])
  963.     }
  964.  
  965.     /**
  966.      * @return {HTMLElement|HTMLDivElement}
  967.      */
  968.     createStatusSection ()
  969.     {
  970.         this._statusLine = this.createFormGroupLabel('Status')
  971.         this._statusLine.id = this._selectorGenerator.getSelector('status')
  972.  
  973.         return this.createFormSection('', [this._statusLine])
  974.     }
  975.  
  976.     /**
  977.      * @param {LocalStore} localStore
  978.      * @return {HTMLElement}
  979.      */
  980.     createStoreFormSection (localStore)
  981.     {
  982.         return this.createFormSection('Cached Configuration', [
  983.             this.createFormActions([
  984.                 this.createFormSectionButton(
  985.                     'Update', 'Save UI settings in store', () => localStore.save(), 'Saves applied settings.'),
  986.                 this.createFormSectionButton(
  987.                     'Purge', 'Purge store', () => localStore.delete(), 'Removes saved settings. Settings will then be sourced from the defaults defined in the script.'),
  988.             ]),
  989.         ])
  990.     }
  991.  
  992.     /**
  993.      * @param {string} tabName
  994.      * @return {HTMLButtonElement}
  995.      */
  996.     createTabButton (tabName)
  997.     {
  998.         let button = document.createElement('button')
  999.         button.classList.add('tab-button')
  1000.         button.textContent = tabName
  1001.         button.addEventListener('click', (event) => {
  1002.  
  1003.             let button = event.currentTarget
  1004.             let tabsSection = button.closest('.tabs-section')
  1005.             let tabToOpen = tabsSection.querySelector('#' + toKebabCase(tabName))
  1006.  
  1007.             for (let tabButton of tabsSection.querySelectorAll('.tab-button')) {
  1008.                 tabButton.classList.remove('active')
  1009.             }
  1010.             for (let tabPanel of tabsSection.querySelectorAll('.tab-panel')) {
  1011.                 tabPanel.classList.remove('active')
  1012.             }
  1013.  
  1014.             button.classList.add('active')
  1015.             tabToOpen.classList.add('active')
  1016.         })
  1017.         return button
  1018.     }
  1019.  
  1020.     /**
  1021.      * @param {string} tabName
  1022.      * @param {HTMLElement[]} children
  1023.      * @return {HTMLElement|HTMLDivElement}
  1024.      */
  1025.     createTabPanel (tabName, children)
  1026.     {
  1027.         let panel = document.createElement('div')
  1028.         panel.id = toKebabCase(tabName)
  1029.         panel.classList.add('tab-panel')
  1030.  
  1031.         return UIGenerator.populateChildren(panel, children)
  1032.     }
  1033.  
  1034.     /**
  1035.      * @param {string[]} tabNames
  1036.      * @param {HTMLElement[]} tabPanels
  1037.      * @return {HTMLElement|HTMLDivElement}
  1038.      */
  1039.     createTabsSection (tabNames, tabPanels)
  1040.     {
  1041.         let wrapper = document.createElement('div')
  1042.         wrapper.classList.add('tabs-section')
  1043.  
  1044.         let tabsDiv = document.createElement('div')
  1045.         tabsDiv.classList.add('tabs-nav')
  1046.  
  1047.         let tabButtons = []
  1048.         for (let tabName of tabNames) {
  1049.             tabButtons.push(this.createTabButton(tabName))
  1050.         }
  1051.  
  1052.         UIGenerator.populateChildren(tabsDiv, tabButtons)
  1053.         UIGenerator.populateChildren(wrapper, [tabsDiv, ...tabPanels])
  1054.         tabButtons[0].click()
  1055.  
  1056.         return wrapper
  1057.     }
  1058.  
  1059.     /**
  1060.      * @param {string} label
  1061.      * @return {HTMLElement}
  1062.      */
  1063.     getSettingsInput (label)
  1064.     {
  1065.         return document.getElementById(this._selectorGenerator.getSettingsInputSelector(label))
  1066.     }
  1067.  
  1068.     /**
  1069.      * @param {string} label
  1070.      * @return {boolean}
  1071.      */
  1072.     getSettingsInputCheckedStatus (label)
  1073.     {
  1074.         return this.getSettingsInput(label).checked
  1075.     }
  1076.  
  1077.     /**
  1078.      * @param {string} label
  1079.      * @return {*}
  1080.      */
  1081.     getSettingsInputValue (label)
  1082.     {
  1083.         return this.getSettingsInput(label).value
  1084.     }
  1085.  
  1086.     /**
  1087.      * @param {string} label
  1088.      * @param {boolean} getMinInput
  1089.      * @return {HTMLElement}
  1090.      */
  1091.     getSettingsRangeInput (label, getMinInput)
  1092.     {
  1093.         return document.getElementById(this._selectorGenerator.getSettingsRangeInputSelector(label, getMinInput))
  1094.     }
  1095.  
  1096.     /**
  1097.      * @param {string} label
  1098.      * @param {boolean} getMinInputValue
  1099.      * @return {*}
  1100.      */
  1101.     getSettingsRangeInputValue (label, getMinInputValue)
  1102.     {
  1103.         return this.getSettingsRangeInput(label, getMinInputValue).value
  1104.     }
  1105.  
  1106.     resetStatus ()
  1107.     {
  1108.         this._statusLine.textContent = this._statusText
  1109.     }
  1110.  
  1111.     /**
  1112.      * @param {string} label
  1113.      * @param {boolean} bool
  1114.      */
  1115.     setSettingsInputCheckedStatus (label, bool)
  1116.     {
  1117.         this.getSettingsInput(label).checked = bool
  1118.     }
  1119.  
  1120.     /**
  1121.      * @param {string} label
  1122.      * @param {*} value
  1123.      */
  1124.     setSettingsInputValue (label, value)
  1125.     {
  1126.         this.getSettingsInput(label).value = value
  1127.     }
  1128.  
  1129.     /**
  1130.      * @param {string} label
  1131.      * @param {number} lowerBound
  1132.      * @param {number} upperBound
  1133.      */
  1134.     setSettingsRangeInputValue (label, lowerBound, upperBound)
  1135.     {
  1136.         this.getSettingsRangeInput(label, true).value = lowerBound
  1137.         this.getSettingsRangeInput(label, false).value = upperBound
  1138.     }
  1139.  
  1140.     /**
  1141.      * @param {string} status
  1142.      * @param {boolean} transient
  1143.      */
  1144.     updateStatus (status, transient = false)
  1145.     {
  1146.         if (!transient) {
  1147.             this._statusText = status
  1148.         }
  1149.         this._statusLine.textContent = status
  1150.     }
  1151. }
  1152.  
  1153. class Validator
  1154. {
  1155.     static iFramesRemover ()
  1156.     {
  1157.         GM_addStyle(' iframe { display: none !important; } ')
  1158.     }
  1159.  
  1160.     /**
  1161.      * @param {StatisticsRecorder} statisticsRecorder
  1162.      */
  1163.     constructor (statisticsRecorder)
  1164.     {
  1165.         /**
  1166.          * @type {Array}
  1167.          * @private
  1168.          */
  1169.         this._filters = []
  1170.  
  1171.         /**
  1172.          * @type {RegExp|null}
  1173.          * @private
  1174.          */
  1175.         this._optimizedBlacklist = null
  1176.  
  1177.         /**
  1178.          * @type {Object}
  1179.          * @private
  1180.          */
  1181.         this._optimizedSanitizationRules = {}
  1182.  
  1183.         /**
  1184.          * @type {StatisticsRecorder}
  1185.          * @private
  1186.          */
  1187.         this._statisticsRecorder = statisticsRecorder
  1188.     }
  1189.  
  1190.     _buildWholeWordMatchingRegex (words)
  1191.     {
  1192.         let patternedWords = []
  1193.         for (let i = 0; i < words.length; i++) {
  1194.             patternedWords.push('\\b' + words[i] + '\\b')
  1195.         }
  1196.         return new RegExp('(' + patternedWords.join('|') + ')', 'gi')
  1197.     }
  1198.  
  1199.     /**
  1200.      * @param {string} text
  1201.      * @return {string}
  1202.      */
  1203.     sanitize (text)
  1204.     {
  1205.         for (const substitute in this._optimizedSanitizationRules) {
  1206.             text = text.replace(this._optimizedSanitizationRules[substitute], substitute)
  1207.         }
  1208.         return text.trim()
  1209.     }
  1210.  
  1211.     /**
  1212.      * @param {HTMLElement} textNode
  1213.      * @return {Validator}
  1214.      */
  1215.     sanitizeTextNode (textNode)
  1216.     {
  1217.         textNode.textContent = this.sanitize(textNode.textContent)
  1218.         return this
  1219.     }
  1220.  
  1221.     /**
  1222.      * @param {string} selector
  1223.      * @return {Validator}
  1224.      */
  1225.     sanitizeNodeOfSelector (selector)
  1226.     {
  1227.         let node = document.querySelector(selector)
  1228.         if (node) {
  1229.             let sanitizedText = this.sanitize(node.textContent)
  1230.             node.textContent = sanitizedText
  1231.             document.title = sanitizedText
  1232.         }
  1233.         return this
  1234.     }
  1235.  
  1236.     /**
  1237.      * @param {string[]} blacklistedWords
  1238.      * @return {Validator}
  1239.      */
  1240.     setBlacklist (blacklistedWords)
  1241.     {
  1242.         this._optimizedBlacklist = blacklistedWords.length ? this._buildWholeWordMatchingRegex(blacklistedWords) : null
  1243.         return this
  1244.     }
  1245.  
  1246.     /**
  1247.      * @param {Object} sanitizationRules
  1248.      * @return {Validator}
  1249.      */
  1250.     setSanitizationRules (sanitizationRules)
  1251.     {
  1252.         for (const substitute in sanitizationRules) {
  1253.             this._optimizedSanitizationRules[substitute] = this._buildWholeWordMatchingRegex(sanitizationRules[substitute])
  1254.         }
  1255.         return this
  1256.     }
  1257.  
  1258.     /**
  1259.      * @param {string} text
  1260.      * @return {boolean}
  1261.      */
  1262.     validateBlackList (text)
  1263.     {
  1264.         let validationCheck = true
  1265.  
  1266.         if (this._optimizedBlacklist) {
  1267.             validationCheck = text.match(this._optimizedBlacklist) === null
  1268.             this._statisticsRecorder.record('Blacklist', validationCheck)
  1269.         }
  1270.         return validationCheck
  1271.     }
  1272.  
  1273.     /**
  1274.      * @param {string} name
  1275.      * @param {Node|HTMLElement} item
  1276.      * @param {string} selector
  1277.      * @return {boolean}
  1278.      */
  1279.     validateNodeExistence (name, item, selector)
  1280.     {
  1281.         let validationCheck = item.querySelector(selector) !== null
  1282.         this._statisticsRecorder.record(name, validationCheck)
  1283.  
  1284.         return validationCheck
  1285.     }
  1286.  
  1287.     /**
  1288.      * @param {string} name
  1289.      * @param {Node|HTMLElement} item
  1290.      * @param {string} selector
  1291.      * @return {boolean}
  1292.      */
  1293.     validateNodeNonExistence (name, item, selector)
  1294.     {
  1295.         let validationCheck = item.querySelector(selector) === null
  1296.         this._statisticsRecorder.record(name, validationCheck)
  1297.  
  1298.         return validationCheck
  1299.     }
  1300.  
  1301.     /**
  1302.      * @param {string} name
  1303.      * @param {number} value
  1304.      * @param {number[]} bounds
  1305.      * @return {boolean}
  1306.      */
  1307.     validateRange (name, value, bounds)
  1308.     {
  1309.         let validationCheck = true
  1310.  
  1311.         if (bounds[0] > 0 && bounds[1] > 0) {
  1312.             validationCheck = value >= bounds[0] && value <= bounds[1]
  1313.         } else {
  1314.             if (bounds[0] > 0) {
  1315.                 validationCheck = value >= bounds[0]
  1316.             }
  1317.             if (bounds[1] > 0) {
  1318.                 validationCheck = value <= bounds[1]
  1319.             }
  1320.         }
  1321.         this._statisticsRecorder.record(name, validationCheck)
  1322.  
  1323.         return validationCheck
  1324.     }
  1325.  
  1326.     /**
  1327.      * @param {string} name
  1328.      * @param {number} lowerBound
  1329.      * @param {number} upperBound
  1330.      * @param getValueCallback
  1331.      * @return {boolean}
  1332.      */
  1333.     validateRangeFilter (name, lowerBound, upperBound, getValueCallback)
  1334.     {
  1335.         if (lowerBound > 0 || upperBound > 0) {
  1336.             return this.validateRange(name, getValueCallback(), [lowerBound, upperBound])
  1337.         }
  1338.         return true
  1339.     }
  1340. }
  1341.  
  1342. class PresetSwitcher
  1343. {
  1344.     /**
  1345.      * @param {string} scriptPrefix
  1346.      * @param {Object} defaultPreset
  1347.      * @param {Object} globalConfiguration
  1348.      */
  1349.     static create (scriptPrefix, defaultPreset, globalConfiguration)
  1350.     {
  1351.         return new PresetSwitcher(scriptPrefix, defaultPreset, globalConfiguration)
  1352.     }
  1353.  
  1354.     /**
  1355.      * @param {string} scriptPrefix
  1356.      * @param {Object} defaultPreset
  1357.      * @param {Object} globalConfiguration
  1358.      */
  1359.     constructor (scriptPrefix, defaultPreset, globalConfiguration)
  1360.     {
  1361.         /**
  1362.          * @type {Object}
  1363.          * @private
  1364.          */
  1365.         this._appliedPreset = null
  1366.  
  1367.         /**
  1368.          * @type {Object}
  1369.          * @private
  1370.          */
  1371.         this._defaultPreset = defaultPreset
  1372.  
  1373.         /**
  1374.          * {LocalStore}
  1375.          */
  1376.         this._globalConfigurationStore = LocalStore.createGlobalConfigStore(scriptPrefix, globalConfiguration)
  1377.  
  1378.         /**
  1379.          * {Object}
  1380.          */
  1381.         this._globalConfiguration = this._globalConfigurationStore.retrieve().get()
  1382.  
  1383.         /**
  1384.          * @type {LocalStore}
  1385.          * @private
  1386.          */
  1387.         this._presetsStore = LocalStore.createPresetConfigStore(scriptPrefix, defaultPreset)
  1388.  
  1389.         /**
  1390.          * @type {{name: string, config: Object}[]}
  1391.          * @private
  1392.          */
  1393.         this._presets = this._presetsStore.retrieve().get()
  1394.  
  1395.         /**
  1396.          * @type {string}
  1397.          * @private
  1398.          */
  1399.         this._scriptPrefix = scriptPrefix
  1400.     }
  1401.  
  1402.     /**
  1403.      * @param {string} name
  1404.      * @param {Object} config
  1405.      * @return {this}
  1406.      */
  1407.     createPreset (name, config)
  1408.     {
  1409.         this._presets.push({
  1410.             name: name,
  1411.             config: config,
  1412.         })
  1413.         this._presetsStore.update(this._presets)
  1414.         return this
  1415.     }
  1416.  
  1417.     /**
  1418.      * @param {string} name
  1419.      * @return {this}
  1420.      */
  1421.     deletePreset (name)
  1422.     {
  1423.         for (let i = 0; i < this._presets.length; i++) {
  1424.             if (this._presets[i].name === name) {
  1425.                 this._presets.splice(i, 1)
  1426.                 this._presetsStore.update(this._presets)
  1427.                 break
  1428.             }
  1429.         }
  1430.         return this
  1431.     }
  1432.  
  1433.     /**
  1434.      * @param name
  1435.      * @return {{name: string, config: Object}|null}
  1436.      */
  1437.     findPreset (name)
  1438.     {
  1439.         for (let preset of this._presets) {
  1440.             if (preset.name === name) {
  1441.                 return preset
  1442.             }
  1443.         }
  1444.         return null
  1445.     }
  1446.  
  1447.     /**
  1448.      * @return {{name: string, config: Object}}
  1449.      */
  1450.     getAppliedPreset ()
  1451.     {
  1452.         return this._appliedPreset
  1453.     }
  1454. }
  1455.  
  1456. class BaseHandler
  1457. {
  1458.     static initialize ()
  1459.     {
  1460.         BaseHandler.throwOverrideError()
  1461.         //return (new XNXXSearchFilters).init()
  1462.     }
  1463.  
  1464.     static throwOverrideError ()
  1465.     {
  1466.         throw new Error('override this method')
  1467.     }
  1468.  
  1469.     /**
  1470.      * @param {string} scriptPrefix
  1471.      * @param {string} itemClass
  1472.      * @param {Object} settingsDefaults
  1473.      */
  1474.     constructor (scriptPrefix, itemClass, settingsDefaults)
  1475.     {
  1476.         settingsDefaults.disableItemComplianceValidation = false
  1477.         settingsDefaults.showUIAlways = false
  1478.  
  1479.         /**
  1480.          * Array of item compliance filters ordered in intended sequence of execution
  1481.          * @type {Function[]}
  1482.          * @protected
  1483.          */
  1484.         this._complianceFilters = []
  1485.  
  1486.         /**
  1487.          * @type {string}
  1488.          * @protected
  1489.          */
  1490.         this._itemClass = itemClass
  1491.  
  1492.         /**
  1493.          * Operations to perform after script initialization
  1494.          * @type {Function}
  1495.          * @protected
  1496.          */
  1497.         this._onAfterInitialization = null
  1498.  
  1499.         /**
  1500.          * Operations to perform after UI generation
  1501.          * @type {Function}
  1502.          * @protected
  1503.          */
  1504.         this._onAfterUIBuild = null
  1505.  
  1506.         /**
  1507.          * Operations to perform before UI generation
  1508.          * @type {Function}
  1509.          * @protected
  1510.          */
  1511.         this._onBeforeUIBuild = null
  1512.  
  1513.         /**
  1514.          * Operations to perform after compliance checks, the first time a item is retrieved
  1515.          * @type {Function}
  1516.          * @protected
  1517.          */
  1518.         this._onFirstHitAfterCompliance = null
  1519.  
  1520.         /**
  1521.          * Operations to perform before compliance checks, the first time a item is retrieved
  1522.          * @type {Function}
  1523.          * @protected
  1524.          */
  1525.         this._onFirstHitBeforeCompliance = null
  1526.  
  1527.         /**
  1528.          * Get item lists from the page
  1529.          * @type {Function}
  1530.          * @protected
  1531.          */
  1532.         this._onGetItemLists = null
  1533.  
  1534.         /**
  1535.          * Logic to hide a non-compliant item
  1536.          * @type {Function}
  1537.          * @protected
  1538.          */
  1539.         this._onItemHide = (item) => {item.style.display = 'none'}
  1540.  
  1541.         /**
  1542.          * Logic to show compliant item
  1543.          * @type {Function}
  1544.          * @protected
  1545.          */
  1546.         this._onItemShow = (item) => {item.style.display = 'inline-block'}
  1547.  
  1548.         /**
  1549.          * Retrieve settings from UI and update settings object
  1550.          * @type {Function}
  1551.          * @private
  1552.          */
  1553.         this._onSettingsApply = null
  1554.  
  1555.         /**
  1556.          * Settings to update in the UI or elsewhere when settings store is updated
  1557.          * @type {Function}
  1558.          * @protected
  1559.          */
  1560.         this._onSettingsStoreUpdate = null
  1561.  
  1562.         /**
  1563.          * Must return the generated settings section node
  1564.          * @type {Function}
  1565.          * @protected
  1566.          */
  1567.         this._onUIBuild = null
  1568.  
  1569.         /**
  1570.          * Validate initiating initialization.
  1571.          * Can be used to stop script init on specific pages or vice versa
  1572.          * @type {Function}
  1573.          * @protected
  1574.          */
  1575.         this._onValidateInit = () => true
  1576.  
  1577.         /**
  1578.          * @type {string}
  1579.          * @private
  1580.          */
  1581.         this._scriptPrefix = scriptPrefix
  1582.  
  1583.         /**
  1584.          * Local storage store with defaults
  1585.          * @type {LocalStore}
  1586.          * @protected
  1587.          */
  1588.         this._settingsStore = new LocalStore(this._scriptPrefix + 'settings', settingsDefaults)
  1589.  
  1590.         /**
  1591.          * @type {Object}
  1592.          * @protected
  1593.          */
  1594.         this._settings = this._settingsStore.retrieve().get()
  1595.  
  1596.         /**
  1597.          * @type {StatisticsRecorder}
  1598.          * @protected
  1599.          */
  1600.         this._statistics = new StatisticsRecorder(this._scriptPrefix)
  1601.  
  1602.         /**
  1603.          * @type {UIGenerator}
  1604.          * @protected
  1605.          */
  1606.         this._uiGen = new UIGenerator(this._settings.showUIAlways, this._scriptPrefix)
  1607.  
  1608.         /**
  1609.          * @type {Validator}
  1610.          * @protected
  1611.          */
  1612.         this._validator = (new Validator(this._statistics))
  1613.     }
  1614.  
  1615.     /**
  1616.      * @param {Function} eventHandler
  1617.      * @param {*} parameters
  1618.      * @return {null|NodeListOf<HTMLElement>|*}
  1619.      * @private
  1620.      */
  1621.     _callEventHandler (eventHandler, ...parameters)
  1622.     {
  1623.         if (eventHandler) {
  1624.             return eventHandler(...parameters)
  1625.         }
  1626.         return null
  1627.     }
  1628.  
  1629.     /**
  1630.      * Filters items as per settings
  1631.      * @param {HTMLElement|NodeList<HTMLElement>} itemsList
  1632.      * @protected
  1633.      */
  1634.     _complyItemsList (itemsList)
  1635.     {
  1636.         for (let item of this._getItemsFromItemsList(itemsList)) {
  1637.  
  1638.             if (typeof item.scriptProcessedOnce === 'undefined') {
  1639.                 item.scriptProcessedOnce = false
  1640.                 this._callEventHandler(this._onFirstHitBeforeCompliance, item)
  1641.             }
  1642.  
  1643.             this._validateItemCompliance(item)
  1644.  
  1645.             if (!item.scriptProcessedOnce) {
  1646.                 this._callEventHandler(this._onFirstHitAfterCompliance, item)
  1647.                 item.scriptProcessedOnce = true
  1648.             }
  1649.  
  1650.             this._statistics.updateUI()
  1651.         }
  1652.     }
  1653.  
  1654.     /**
  1655.      * @protected
  1656.      */
  1657. 	 
  1658.     _createSettingsFormActions ()
  1659.     {
  1660.         return this._uiGen.createSettingsFormActions(this._settingsStore, () => {
  1661.             this._callEventHandler(this._onSettingsApply)
  1662.             this._statistics.reset()
  1663.             for (let itemsList of this._callEventHandler(this._onGetItemLists)) {
  1664.                 this._complyItemsList(itemsList)
  1665.             }
  1666.         })
  1667.     }
  1668.  
  1669.     /**
  1670.      * @param {HTMLElement|null} UISection
  1671.      * @private
  1672.      */
  1673.     _embedUI (UISection)
  1674.     {
  1675.         if (UISection) {
  1676.             this._uiGen.constructor.appendToBody(UISection)
  1677.             this._uiGen.constructor.appendToBody(this._uiGen.createSettingsShowButton('', UISection, true, () => {
  1678.                 if (!this._settings.showUIAlways) {
  1679.                     UISection.style.display = 'none'
  1680.                 }
  1681.             }))
  1682.             this._callEventHandler(this._onSettingsStoreUpdate)
  1683.         }
  1684.     }
  1685.  
  1686.     /**
  1687.      * @param {HTMLElement|NodeList<HTMLElement>} itemsList
  1688.      * @return {NodeListOf<HTMLElement>|HTMLElement[]}
  1689.      * @protected
  1690.      */
  1691.     _getItemsFromItemsList (itemsList)
  1692.     {
  1693.         let items = []
  1694.         if (itemsList instanceof NodeList) {
  1695.             itemsList.forEach((node) => {
  1696.                 if (typeof node.classList !== 'undefined' && node.classList.contains(this._itemClass)) {
  1697.                     items.push(node)
  1698.                 }
  1699.             })
  1700.         } else {
  1701.             items = itemsList.querySelectorAll('.' + this._itemClass)
  1702.         }
  1703.         return items
  1704.     }
  1705.  
  1706.     /**
  1707.      * @param {Object} sanitizationRules
  1708.      * @return {string}
  1709.      * @protected
  1710.      */
  1711.     _transformSanitizationRulesToText (sanitizationRules)
  1712.     {
  1713.         let sanitizationRulesText = []
  1714.         for (let substitute in sanitizationRules) {
  1715.             sanitizationRulesText.push(substitute + '=' + sanitizationRules[substitute].join(','))
  1716.         }
  1717.         return sanitizationRulesText.join('\n')
  1718.     }
  1719.  
  1720.     /**
  1721.      * @param {string[]} strings
  1722.      * @protected
  1723.      */
  1724.     _trimAndKeepNonEmptyStrings (strings)
  1725.     {
  1726.         let nonEmptyStrings = []
  1727.         for (let string of strings) {
  1728.             string = string.trim()
  1729.             if (string !== '') {
  1730.                 nonEmptyStrings.push(string)
  1731.             }
  1732.         }
  1733.         return nonEmptyStrings
  1734.     }
  1735.  
  1736.     /**
  1737.      * @param {string[]} blacklistedWords
  1738.      * @protected
  1739.      */
  1740.     _validateAndSetBlacklistedWords (blacklistedWords)
  1741.     {
  1742.         this._settings.blacklist = this._trimAndKeepNonEmptyStrings(blacklistedWords)
  1743.         this._validator.setBlacklist(this._settings.blacklist)
  1744.     }
  1745.  
  1746.     /**
  1747.      * @param {string[]} sanitizationRules
  1748.      * @protected
  1749.      */
  1750.     _validateAndSetSanitizationRules (sanitizationRules)
  1751.     {
  1752.         let fragments, validatedTargetWords
  1753.         this._settings.sanitize = {}
  1754.  
  1755.         for (let sanitizationRule of sanitizationRules) {
  1756.             if (sanitizationRule.includes('=')) {
  1757.  
  1758.                 fragments = sanitizationRule.split('=')
  1759.                 if (fragments[0] === '') {
  1760.                     fragments[0] = ' '
  1761.                 }
  1762.  
  1763.                 validatedTargetWords = this._trimAndKeepNonEmptyStrings(fragments[1].split(','))
  1764.                 if (validatedTargetWords.length) {
  1765.                     this._settings.sanitize[fragments[0]] = validatedTargetWords
  1766.                 }
  1767.             }
  1768.         }
  1769.         this._validator.setSanitizationRules(this._settings.sanitize)
  1770.     }
  1771.  
  1772.     /**
  1773.      * @param {HTMLElement|Node} item
  1774.      * @protected
  1775.      */
  1776.     _validateItemCompliance (item)
  1777.     {
  1778.         let itemComplies = true
  1779.  
  1780.         if (!this._settings.disableItemComplianceValidation) {
  1781.             for (let complianceFilter of this._complianceFilters) {
  1782.                 if (!complianceFilter(item)) {
  1783.                     itemComplies = false
  1784.                     break
  1785.                 }
  1786.             }
  1787.         }
  1788.         itemComplies ? this._callEventHandler(this._onItemShow, item) : this._callEventHandler(this._onItemHide, item)
  1789.     }
  1790.  
  1791.     /**
  1792.      * Initialize the script and do basic UI removals
  1793.      */
  1794.     init ()
  1795.     {
  1796.         try {
  1797.             if (this._callEventHandler(this._onValidateInit)) {
  1798.  
  1799.                 this._callEventHandler(this._onBeforeUIBuild)
  1800.                 this._embedUI(this._callEventHandler(this._onUIBuild))
  1801.                 this._callEventHandler(this._onAfterUIBuild)
  1802.  
  1803.                 for (let itemsList of this._callEventHandler(this._onGetItemLists)) {
  1804.                     ChildObserver.create().onNodesAdded((itemsAdded) => this._complyItemsList(itemsAdded)).observe(itemsList)
  1805.                     this._complyItemsList(itemsList)
  1806.                 }
  1807.  
  1808.                 this._uiGen.updateStatus('Initial run completed.')
  1809.  
  1810.                 this._callEventHandler(this._onAfterInitialization)
  1811.  
  1812.                 this._settingsStore.onChange(() => this._callEventHandler(this._onSettingsStoreUpdate))
  1813.             }
  1814.         } catch (error) {
  1815.             console.error(this._scriptPrefix + 'script encountered an error: ' + error)
  1816.         }
  1817.     }
  1818. }