1.10.0

Expanded decode handler to support more encoding methods. See issue #100 for more information.
Currently supported: hex, base64, url and url2.
url2 is a special case used in issue #72

Author: DrKain

data/tidy.user.js

@@ -1,7 +1,7 @@
 // ==UserScript==
 // @name         Tidy URL
 // @namespace    https://ksir.pw
-// @version      1.9.0
+// @version      1.10.0
 // @description  Cleans/removes garbage or tracking parameters from URLs
 // @author       Kain (ksir.pw)
 // @include      *

lib/index.d.ts

@@ -35,6 +35,7 @@ export declare class TidyCleaner {
     hasParams(url: string): boolean;
     private isJSON;
     private getDiff;
+    private decode;
     /**
      * Clean a URL
      * @param _url Any URL

lib/index.js

@@ -6,6 +6,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clean = exports.TidyURL = exports.TidyCleaner = void 0;
+var interface_1 = require("./interface");
 var $github = 'https://github.com/DrKain/tidy-url';
 var TidyCleaner = /** @class */ (function () {
     function TidyCleaner() {
@@ -111,6 +112,33 @@ var TidyCleaner = /** @class */ (function () {
             reduction: +(100 - (data.url.length / url.length) * 100).toFixed(2)
         };
     };
+    TidyCleaner.prototype.decode = function (str, encoding) {
+        if (encoding === void 0) { encoding = interface_1.EEncoding.base64; }
+        var decoded = str;
+        // Simple base64 decoding
+        if (encoding === interface_1.EEncoding.base64) {
+            decoded = this.atob(str);
+        }
+        // Decode uri when used in URL parameters
+        if (encoding === interface_1.EEncoding.url) {
+            decoded = decodeURI(str);
+        }
+        // This is more of a special case but it may help other rules. See issue #72
+        if (encoding === interface_1.EEncoding.url2) {
+            decoded = decodeURIComponent(str.replace(/-/g, '%')).replace(/_/g, '/').replace(/%2F/g, '/');
+        }
+        // hex decode, not the best method but it works.
+        // Open a PR if you want to improve it
+        if (encoding === interface_1.EEncoding.hex) {
+            var hex = str.toString();
+            var out = '';
+            for (var i = 0; i < hex.length; i += 2) {
+                out += String.fromCharCode(parseInt(hex.substr(i, 2), 16));
+            }
+            decoded = out;
+        }
+        return decoded;
+    };
     /**
      * Clean a URL
      * @param _url Any URL
@@ -260,13 +288,15 @@ var TidyCleaner = /** @class */ (function () {
             try {
                 if (!rule.decode)
                     continue;
+                // Make sure the target parameter exists
                 if (!cleaner.has(rule.decode.param))
                     continue;
                 // These will always be clickjacking links, so use the allow_redirects rule
                 if (!this.allow_redirects)
                     continue;
-                // Decode the base64 string
-                var decoded = this.atob(cleaner.get(rule.decode.param));
+                // Decode the string using selected encoding
+                var encoding = rule.decode.encoding || 'base64';
+                var decoded = this.decode(cleaner.get(rule.decode.param), encoding);
                 var target = '';
                 // If the response is JSON, decode and look for a key
                 if (this.isJSON(decoded)) {

lib/interface.d.ts

@@ -62,3 +62,12 @@ export interface IData {
         full_clean: boolean;
     };
 }
+export declare enum EEncoding {
+    base64 = "b64",
+    base32 = "b32",
+    base45 = "b45",
+    url = "url",
+    url2 = "url2",
+    binary = "binary",
+    hex = "hex"
+}

lib/interface.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EEncoding = void 0;
+var EEncoding;
+(function (EEncoding) {
+    EEncoding["base64"] = "b64";
+    EEncoding["base32"] = "b32";
+    EEncoding["base45"] = "b45";
+    EEncoding["url"] = "url";
+    EEncoding["url2"] = "url2";
+    EEncoding["binary"] = "binary";
+    EEncoding["hex"] = "hex";
+})(EEncoding = exports.EEncoding || (exports.EEncoding = {}));

lib/tidyurl.min.js

@@ -1,6 +1,6 @@
 {
     "name": "tidy-url",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "description": "Cleans/removes tracking or garbage parameters from URLs",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",

package.json

@@ -1,4 +1,4 @@
-import { IRule, IData } from './interface';
+import { IRule, IData, EEncoding } from './interface';
 
 const $github = 'https://github.com/DrKain/tidy-url';
 
@@ -113,6 +113,40 @@ export class TidyCleaner {
         };
     }
 
+    private decode(str: string, encoding: EEncoding = EEncoding.base64): string {
+        let decoded = str;
+
+        // Simple base64 decoding
+        if (encoding === EEncoding.base64) {
+            decoded = this.atob(str);
+        }
+
+        // Decode uri when used in URL parameters
+        if (encoding === EEncoding.url) {
+            decoded = decodeURI(str);
+        }
+
+        // This is more of a special case but it may help other rules. See issue #72
+        if (encoding === EEncoding.url2) {
+            decoded = decodeURIComponent(str.replace(/-/g, '%')).replace(/_/g, '/').replace(/%2F/g, '/');
+        }
+
+        // hex decode, not the best method but it works.
+        // Open a PR if you want to improve it
+        if (encoding === EEncoding.hex) {
+            let hex = str.toString();
+            let out = '';
+
+            for (var i = 0; i < hex.length; i += 2) {
+                out += String.fromCharCode(parseInt(hex.substr(i, 2), 16));
+            }
+
+            decoded = out;
+        }
+
+        return decoded;
+    }
+
     /**
      * Clean a URL
      * @param _url Any URL
@@ -261,11 +295,14 @@ export class TidyCleaner {
         for (const rule of data.info.match) {
             try {
                 if (!rule.decode) continue;
+                // Make sure the target parameter exists
                 if (!cleaner.has(rule.decode.param)) continue;
                 // These will always be clickjacking links, so use the allow_redirects rule
                 if (!this.allow_redirects) continue;
-                // Decode the base64 string
-                const decoded = this.atob(cleaner.get(rule.decode.param) as string);
+                // Decode the string using selected encoding
+
+                const encoding = rule.decode.encoding || 'base64';
+                const decoded = this.decode(cleaner.get(rule.decode.param) as string, encoding);
                 let target = '';
 
                 // If the response is JSON, decode and look for a key

src/index.ts

@@ -58,3 +58,13 @@ export interface IData {
         full_clean: boolean;
     };
 }
+
+export enum EEncoding {
+    base64 = 'b64',
+    base32 = 'b32',
+    base45 = 'b45',
+    url = 'url',
+    url2 = 'url2',
+    binary = 'binary',
+    hex = 'hex'
+}