add support for onTagRemoved

leizongmin · Nov 8, 2023 · 6f72b13 · 6f72b13
1 parent 372b929
commit 6f72b13
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/lib/default.js b/lib/default.js
@@ -335,18 +335,26 @@ function onIgnoreTagStripAll() {
   return "";
 }
 
+function onTagRemoved() {
+  // do nothing by default
+}
+
 /**
  * remove tag body
  * specify a `tags` list, if the tag is not in the `tags` list then process by the specify function (optional)
  *
  * @param {array} tags
  * @param {function} next
  */
-function StripTagBody(tags, next) {
+function StripTagBody(tags, next, onTagRemoved) {
   if (typeof next !== "function") {
     next = function () { };
   }
 
+  if (typeof onTagRemoved !== "function") {
+    onTagRemoved = function () { };
+  }
+
   var isRemoveAllTag = !Array.isArray(tags);
   function isRemoveTag(tag) {
     if (isRemoveAllTag) return true;
@@ -359,6 +367,7 @@ function StripTagBody(tags, next) {
   return {
     onIgnoreTag: function (tag, html, options) {
       if (isRemoveTag(tag)) {
+        onTagRemoved(tag)
         if (options.isValidEmpty) {
           // Empty tags have no content to remove so just remove them
           posStart = false;
@@ -444,6 +453,7 @@ exports.whiteList = getDefaultWhiteList();
 exports.getDefaultWhiteList = getDefaultWhiteList;
 exports.onTag = onTag;
 exports.onIgnoreTag = onIgnoreTag;
+exports.onTagRemoved = onTagRemoved;
 exports.onTagAttr = onTagAttr;
 exports.onIgnoreTagAttr = onIgnoreTagAttr;
 exports.safeAttrValue = safeAttrValue;

diff --git a/lib/xss.js b/lib/xss.js
@@ -103,6 +103,7 @@ function FilterXSS(options) {
   options.onTag = options.onTag || DEFAULT.onTag;
   options.onTagAttr = options.onTagAttr || DEFAULT.onTagAttr;
   options.onIgnoreTag = options.onIgnoreTag || DEFAULT.onIgnoreTag;
+  options.onTagRemoved = options.onTagRemoved || DEFAULT.onTagRemoved;
   options.onIgnoreTagAttr = options.onIgnoreTagAttr || DEFAULT.onIgnoreTagAttr;
   options.safeAttrValue = options.safeAttrValue || DEFAULT.safeAttrValue;
   options.escapeHtml = options.escapeHtml || DEFAULT.escapeHtml;
@@ -133,6 +134,7 @@ FilterXSS.prototype.process = function (html) {
   var whiteList = options.whiteList;
   var onTag = options.onTag;
   var onIgnoreTag = options.onIgnoreTag;
+  var onTagRemoved = options.onTagRemoved;
   var onTagAttr = options.onTagAttr;
   var onIgnoreTagAttr = options.onIgnoreTagAttr;
   var safeAttrValue = options.safeAttrValue;
@@ -154,7 +156,8 @@ FilterXSS.prototype.process = function (html) {
   if (options.stripIgnoreTagBody) {
     stripIgnoreTagBody = DEFAULT.StripTagBody(
       options.stripIgnoreTagBody,
-      onIgnoreTag
+      onIgnoreTag,
+      onTagRemoved
     );
     onIgnoreTag = stripIgnoreTagBody.onIgnoreTag;
   }

diff --git a/typings/xss.d.ts b/typings/xss.d.ts
@@ -15,6 +15,7 @@ declare module "xss" {
         onTag?: OnTagHandler;
         onTagAttr?: OnTagAttrHandler;
         onIgnoreTag?: OnTagHandler;
+        onTagRemoved?: OnTagRemovedHandler;
         onIgnoreTagAttr?: OnTagAttrHandler;
         safeAttrValue?: SafeAttrValueHandler;
         escapeHtml?: EscapeHandler;
@@ -95,6 +96,10 @@ declare module "xss" {
         video?: string[];
       }
 
+      type OnTagRemovedHandler = (
+        tag: string
+      ) => void;
+
       type OnTagHandler = (
         tag: string,
         html: string,
@@ -133,6 +138,8 @@ declare module "xss" {
 
   export type OnTagHandler = XSS.OnTagHandler;
 
+  export type OnTagRemovedHandler = XSS.OnTagRemovedHandler;
+
   export type OnTagAttrHandler = XSS.OnTagAttrHandler;
 
   export type SafeAttrValueHandler = XSS.SafeAttrValueHandler;
@@ -143,7 +150,8 @@ declare module "xss" {
 
   export function StripTagBody(
     tags: string[],
-    next: () => void
+    next: () => void,
+    onTagRemoved: () => void
   ): {
     onIgnoreTag(
       tag: string,
@@ -181,6 +189,7 @@ declare module "xss" {
   export function getDefaultWhiteList(): IWhiteList;
   export const onTag: OnTagHandler;
   export const onIgnoreTag: OnTagHandler;
+  export const onTagRemoved: OnTagRemovedHandler;
   export const onTagAttr: OnTagAttrHandler;
   export const onIgnoreTagAttr: OnTagAttrHandler;
   export const safeAttrValue: SafeAttrValueHandler;