Issue 6803 - Implement readd snippet

lib/content/snippets.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 102 matching lines @@
     if (element.style.getPropertyValue("display") != "none" ||
         element.style.getPropertyPriority("display") != "important")
     {
       element.style.setProperty("display", "none", "important");
     }
   })
   .observe(element, {attributes: true, attributeFilter: ["style"]});
 }
 
 /**
+ * Observes changes to a DOM node using a <code>MutationObserver</code>.
+ *
+ * @param {Node} target The DOM node to observe for changes.
+ * @param {MutationObserverInit?} [options] Options that describe what DOM
+ *   mutations should be reported to the callback.
+ * @param {function} callback A function that will be called on each DOM
+ *   mutation, taking a <code>MutationRecord</code> as its parameter.
+ */
+function observe(target, options, callback)
+{
+  new MutationObserver(mutations =>
+  {
+    for (let mutation of mutations)
+      callback(mutation);
+  })
+  .observe(target, options);
+}
+
+/**
  * Logs its arguments to the console. This may be used for testing and
  * debugging.
  *
  * @param {...*} [args] The arguments to log.
  */
 function log(...args)
 {
   console.log(...args);
 }
 
@@ skipping 87 matching lines @@
       // will be removed.
       shadows.set(observer, {host: this, root});
 
       return root;
     }
   });
 }
 
 exports["hide-if-shadow-contains"] = makeInjector(hideIfShadowContains,
                                                   hideElement);
+
+/**
+ * Untrashes a document by readding removed elements that match a CSS selector.
+ *
+ * @param {string} selector The CSS selector that a removed element should
+ *   match for it to be added back.
+ * @param {string?} [parentSelector] The CSS selector that a removed element's
+ *   former parent should match for it to be added back.
+ * @param {string?} [ifContains] The string that should be found in the text
+ *   content of the removed element for it to be added back.
+ * @param {string?} [unlessContains] The string that should not be found in the
+ *   text content of the removed element for it to be added back.
+ */
+function untrash(selector, parentSelector = null, ifContains = null,
+                 unlessContains = null)
+{
+  observe(document, {childList: true, subtree: true}, mutation =>
+  {
+    if (mutation.removedNodes &&
+        (!parentSelector || (mutation.target instanceof Element &&
+                             mutation.target.matches(parentSelector))))
+    {
+      for (let node of mutation.removedNodes)
+      {
+        if (node instanceof HTMLElement && node.matches(selector) &&
+            (!ifContains || node.textContent.includes(ifContains)) &&
+            (!unlessContains || !node.textContent.includes(unlessContains)))
+        {
+          // We don't have the location of the element in its former parent,
+          // but it's usually OK to just add it at the end.
+          mutation.target.appendChild(node);
+        }
+      }
+    }
+  });
+}
+
+exports.untrash = untrash;