urluntrackify 0.1.0__py3-none-any.whl

urluntrackify/__init__.py

@@ -0,0 +1 @@
+from .untrackify import sanitize

urluntrackify/arguments.py

@@ -0,0 +1,457 @@
+arguments = [ #{{{1
+    {
+        'type':    'tracker',
+        'company': 'Generic/Unknown',
+        'service': 'Campaign identifier',
+        'arg':     'CMP'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Generic/Unknown',
+        'service': 'Campaign identifier',
+        'arg':    r'c(?:a|a?mp)(?:id)?'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Generic/Unknown',
+        'service': 'Campaign identifier',
+        'arg':    r'(?:source|campaign_)id'
+    },
+#   {
+#       'type':    'unknown',
+#       'arg':     'cd-origin'
+#   },
+#   {
+#       'type':    'unknown',
+#       'arg':     'ncid'
+#       'comment': 'may have legitimate use in CiNii-based databases'
+#   },
+    {
+        'type':    'misc',
+        'company': 'Generic',
+        'service': 'Accelerated mobile pages',
+        'arg':    r'amp(?:_action|_ts)',
+        'comment': 'https://amp.dev/documentation/guides-and-tutorials/'
+    },
+    {
+        'type':    'ads',
+        'company': 'Adobe',
+        'service': 'Advertising',
+        'arg':    r'(?:ef_|s_kwc)id'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Adobe',
+        'service': 'Marketo',
+        'arg':     'mkt_tok'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Adobe',
+        'service': 'SiteCatalyst',
+        'arg':     's_cid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Branch',
+        'service': 'branch.io',
+        'arg':     '_branch_match_id'
+    },
+    {
+        'type':    'bulkmailer',
+        'service': 'dotdigital',
+        'arg':     'dm_i'
+    },
+    {
+        'type':    'bulkmailer',
+        'service': 'drip.com',
+        'arg':     '__s'
+    },
+    {
+        'type':    'internal',
+        'company': 'eBay',
+        'dom':    r'[./]ebay\.',
+        'arg':    r'(?:c(?:amp|ustom)|mk[cr]|site|tool)id|mkevt|_trkparms|_from'
+    },
+    {
+        'type':    'tracker',
+        'company': 'EMCI media',
+        'arg':     'emci'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Unknown, possibly EMCI media as well',
+        'arg':     'emdi'
+    },
+    {
+        'type':    'ads',
+        'company': 'Meta, formerly Facebook',
+        'arg':     'fbclid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'GoDataFeed',
+        'arg':    r'gdf(?:fi|ms|trk)'
+    },
+    {
+        'type':    'ads',
+        'company': 'Google',
+        'service': 'Ads',
+        'arg':     'gad_source'
+    },
+    {
+        'type':    'ads',
+        'company': 'Google',
+        'service': 'Marketing Platform, formerly DoubleClick',
+        'arg':     'dclid'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Google',
+        'service': 'Analytics',
+        'arg':    r'_g[al]|gcl(?:id|src)|[gw]braid|_gac|_gid'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Google',
+        'service': 'Analytics, formerly Urchin',
+        'arg':    r'utm_(?:campaign|content|creative_format|marketing_tactic|medium|source(?:_platform)?|term)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Hootsuite',
+        'arg':     'hootPostID'
+    },
+    {
+        'type':    'tracker',
+        'company': 'HubSpot',
+        'arg':    r'hsa_(?:a(?:cc|d)|grp|kw|mt|net|src|tgt|ver)|__hs(?:fp|[st]c)|_hsenc|hsCtaTracking'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Meta, formerly Instagram',
+        'arg':     'igshid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Impact, formerly Impact Radius',
+        'arg':     'irclickid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Klaviyo',
+        'arg':    r'_k[ex]'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Listrak',
+        'arg':    r'trk_(?:contact|m(?:sg|odule)|sid)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Microsoft (LinkedIn)',
+        'arg':     'li_fat_id'
+    },
+    {
+        'type':    'bulkmailer',
+        'company': 'MailChimp',
+        'arg':    r'mc_[ce]id'
+    },
+    {
+        'type':    'bulkmailer',
+        'company': 'MailerLite',
+        'arg':    r'ml_subscriber(?:_hash)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Marin',
+        'arg':    r'(?:mkw|pcr)id'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Matomo',
+        'arg':    r'(?:mtm|matomo)_(?:c(?:ampaign|ontent|id)|group|keyword|medium|placement|source)'
+    },
+    {
+        'type':    'ads',
+        'company': 'Microsoft',
+        'arg':     'msclkid'
+    },
+    {
+        'type':    'ads',
+        'company': 'NextDoor',
+        'arg':     'ndclid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Omeda',
+        'arg':    r'oly_(?:anon|enc)_id'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Dialog Insight',
+        'arg':    r'oft_(?:ck?|d|ids?|s?k)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Openstat',
+        'arg':     '_openstat',
+        'comment': 'frequently seen on Yandex'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Oracle',
+        'service': 'Bronto',
+        'arg':    r'_bta_(?:c|tid)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Pinterest',
+        'arg':     'epik'
+    },
+    {
+        'type':    'tracker',
+        'company': 'possibly Mapp, formerly WebTrekk',
+        'arg':     'ceid'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Matomo, formerly Piwik',
+        'arg':    r'p(?:iwi)k_(?:campaign|k(?:eywor|w)d)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Rokt',
+        'arg':     'rtid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Snap Inc. (SnapChat)',
+        'arg':     'ScCid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Seznam',
+        'service': 'Sklik',
+        'arg':     'sznclid'
+    },
+    {
+        'type':    'internal',
+        'company': 'Spotify, Google (YouTube)',
+        'dom':     r'(?:(?:.*\.)?spotify\.com|youtube\.com|youtu\.be)(?=/)',
+        'arg':     'si',
+        'comment': "possibly 'share identifer'"
+    },
+    {
+        'type':    'bulkmailer',
+        'company': 'SpringBot',
+        'arg':     r'redirect(?:_log)?_mongo_id|sb_referer_host'
+    },
+    {
+        'type':    'tracker',
+        'company': 'TikTok',
+        'arg':     'ttclid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'X, formerly Twitter',
+        'arg':     'twclid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Unknown, possible russsian origin',
+        'arg':     'rb_clickid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Vero',
+        'arg':     r'vero_(?:conv|id)'
+    },
+    {
+        'type':    'analytics',
+        'company': 'WebTrends',
+        'arg':     r'WT\.(?:mc_id|nav)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Wicked Reports',
+        'arg':     'wickedid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Wikimedia',
+        'service': 'Provenance',
+        'arg':     'wprov'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Wunderkind',
+        'arg':     r'sms_(?:click|source|uph)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'both Yahoo! and Yandex',
+        'service': 'Yahoo! Japan ads and Yandex Direct respectively',
+        'arg':     'yclid'
+    },
+#   {
+#       'type':    'tracker',
+#       'company': 'Yahoo!',
+#       'service': 'Mail consent tracking',
+#       'arg':     'guccounter',
+#       'comment': 'breaks login sessions when removed'
+#   },
+    {
+        'type':    'tracker',
+        'service': 'Awin, formerly Zanox',
+        'arg':     'zanpid'
+    },
+    {
+        'type':    'tracker',
+        'service': 'Awin',
+        'arg':     'awinaffid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'CJ Affiliate',
+        'arg':     'cje'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Disney+',
+        'arg':     'tgclid'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Generic',
+        'service': 'Google News Showcase entitlement',
+        'arg':    r'gaa_(?:at|n|ts|sig)'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Google',
+        'service': 'Shopping tracking',
+        'arg':     'srsltid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Generic',
+        'service': 'Campaign (itm variant)',
+        'arg':    r'itm_(?:campaign|medium|source)'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Meta, formerly Facebook',
+        'arg':    r'fb_action_(?:types|ids)|fb_(?:source|ref)|action_(?:object|type|ref)_map'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Meta (cross-platform share identifier)',
+        'arg':     'mibextid'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Meta, formerly Facebook',
+        'dom':    r'[./]facebook\.com',
+        'arg':    r'hc_[a-z_%\[\]0-9]*|__tn__|sfnsn|paipv|_rdr'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Meta, formerly Instagram',
+        'dom':    r'[./]instagram\.com',
+        'arg':     'igsh'
+    },
+    {
+        'type':    'tracker',
+        'company': 'X, formerly Twitter',
+        'arg':     '__twitter_impression'
+    },
+    {
+        'type':    'tracker',
+        'company': 'X, formerly Twitter',
+        'dom':    r'[./](?:twitter|x)\.com',
+        'arg':    r's|cn'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Google (YouTube)',
+        'dom':    r'(?:youtube\.com|youtu\.be)(?=/)',
+        'arg':    r'feature|pp'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Microsoft (LinkedIn)',
+        'dom':    r'[./]linkedin\.com',
+        'arg':    r'refId|trk|li[a-z]{2}|trackingId'
+    },
+    {
+        'type':    'internal',
+        'company': 'Netflix',
+        'dom':    r'[./]netflix\.com',
+        'arg':    r'trackId|tctx|jb[a-z]*'
+    },
+    {
+        'type':    'internal',
+        'company': 'Steam (Valve)',
+        'dom':    r'[./]steam(?:powered|community)\.com',
+        'arg':     'snr'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Mindbox',
+        'arg':     'mindbox-click-id'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Omnisend',
+        'arg':     'omnisendContactID'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Echobox',
+        'arg':     'Echobox'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Ceneo',
+        'arg':     'ceneo_spo'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Canva',
+        'arg':     'analyticsCorrelationId'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Vero',
+        'arg':     'vgo_ee'
+    },
+    {
+        'type':    'tracker',
+        'company': 'Spotify',
+        'service': 'Deep link share identifier',
+        'arg':     'dlsi'
+    },
+    {
+        'type':    'analytics',
+        'company': 'Generic',
+        'arg':     'tracking_source'
+    },
+    {
+        #       'type':    'unknown|tracker|analytics|ads|bulkmailer|internal|misc',
+        #           tracker    - tracks users across sites
+        #           analytics  - external service to track users' behavior on site
+        #           ads        - ad provider's own metrics, tracks ad interaction behavior
+        #           bulkmailer - tracks email link behavior
+        #           internal   - site's own tracking/analytics features, no cross-site usage
+        #           misc       - miscellaneous potentially unwanted features like AMP developed by Google
+        #       'company': 'Generic|<OrganizationName>|<OmitIfUnknown>',
+        #       'service': '<ServiceName>',                               #use if company has more than one service
+        #       'comment': 'this terminator element is intentionally left blank so you don't have to worry about commas'
+        #
+        #       'dom':    r'domain',                                      #only apply the filter on these domains
+        #       'arg':     'ncid',                                        #string or regex, the key of the url parameter to remove
+    }
+] #1}}}
+
+# vim: ts=2 sw=2 et fdm=marker

urluntrackify/untrackify.py

@@ -0,0 +1,40 @@
+from re import search, sub, subn
+
+from .arguments import arguments
+
+def filter_url(url, pattern, verbose=False):
+    dom = pattern.get('dom', None)
+    arg = pattern.get('arg', None)
+    if arg is None:
+        return url
+
+    if dom is not None and not search(dom, url):
+        if verbose:
+            print(f'DOM /{dom}/ did not match')
+        return url
+
+    if verbose:
+        print(f'DOM /{dom}/ matched' if dom else 'DOM any')
+
+    def _remove(m):
+        # preserve the leading ? so the query string stays valid; drop & separators
+        return '?' if m.group(1) == '?' else ''
+
+    new_url, n = subn(r'([?&])(?:' + arg + r')(?:=[^&#]*)?(?=[&#]|$)', _remove, url)
+
+    if n:
+        if verbose:
+            print(f'ARG /{arg}/ matched, removing')
+        return new_url
+    if verbose:
+        print(f'ARG /{arg}/ did not match')
+    return url
+
+def sanitize(url, verbose=False):
+    for a in arguments:
+        url = filter_url(url, a, verbose)
+    url = sub(r'\?&+', '?', url)       # ?& artifact when first param was removed
+    url = sub(r'\?(?=#|$)', '', url)   # trailing ? when all params were removed
+    return url
+
+# vim: ts=2 sw=2 et fdm=marker

urluntrackify-0.1.0.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: urluntrackify
+Version: 0.1.0
+Summary: Strip tracking and analytics query parameters from URLs
+Author: sph
+License: [MIT](https://spdx.org/licenses/MIT.html)
+        
+        Copyright 2024 sph
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Source, https://tools.sphnet.in/git/sph/python-urluntrackify
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Dynamic: license-file
+
+# DESCRIPTION
+Python library for stripping tracking and analytics query parameters from URLs.  
+Covers trackers, ad click IDs, bulk mailer tokens, analytics tags (UTM etc.),
+and miscellaneous unwanted parameters from a wide range of vendors.
+
+# USAGE
+```python
+from urluntrackify import sanitize
+
+clean_url = sanitize("https://example.com/page?utm_source=twitter&real=1")
+# => "https://example.com/page?real=1"
+
+clean_url = sanitize(url, verbose=True)   # print matched/unmatched rules to stdout
+```
+
+# INSTALL
+```
+pip install -e /path/to/python-urluntrackify
+```
+
+# DEPENDENCIES
+-
+
+# DETAILS
+Each rule in `arguments` (defined in `untrackify.py`) may contain:
+
+| Field     | Required | Description |
+|-----------|----------|-------------|
+| `arg`     | yes      | Regex matched against query parameter keys (full match) |
+| `dom`     | no       | Regex searched against the full URL; rule only applies on match |
+| `type`    | no       | Category: `tracker`, `analytics`, `ads`, `bulkmailer`, `internal`, `misc` |
+| `company` | no       | Vendor name |
+| `service` | no       | Specific service within vendor |
+| `comment` | no       | Freeform notes |
+
+Currently covers: Adobe (Advertising, Marketo, SiteCatalyst), Branch, dotdigital,
+drip.com, eBay, EMCI, Meta/Facebook, GoDataFeed, Google (Ads, Analytics/UTM,
+DoubleClick), Hootsuite, HubSpot, Instagram, Impact, Klaviyo, Listrak, LinkedIn,
+MailChimp, MailerLite, Marin, Matomo/Piwik, Microsoft, NextDoor, Omeda,
+Dialog Insight, Openstat/Yandex, Oracle/Bronto, Pinterest, Rokt, Snapchat,
+Seznam/Sklik, Spotify/YouTube share IDs, SpringBot, TikTok, X/Twitter,
+Vero, WebTrends, Wicked Reports, Wikimedia, Wunderkind, Yahoo!/Yandex,
+Awin/Zanox, and generic campaign identifiers.
+
+# TECHNICAL INFORMATION
+Query parameters appended to URLs by ad networks, email platforms, and analytics
+services allow cross-site user tracking and campaign attribution without any
+involvement from the target site. They are present purely for the benefit of
+the sender/advertiser and add no information value to the recipient.
+
+Query parameters appended to URLs by ad networks, email platforms, and analytics
+services allow cross-site user tracking and campaign attribution without any
+involvement from the target site. They are present purely for the benefit of
+the sender/advertiser and add no information value to the recipient.
+
+Each URL is processed by running the rule list against the raw URL string using
+`re.subn`. Each rule matches `([?&])key(?:=value)?` at a query parameter
+boundary; domain-restricted rules are pre-checked with `re.search` against the
+full URL. Two cleanup passes handle separator artifacts left by removals at the
+start or end of the query string.
+
+# META
+
+## LICENSE
+[LICENSE.md](LICENSE.md)
+
+## ATTRIBUTION
+- https://en.wikipedia.org/wiki/Click_identifier
+- https://webmasters.stackexchange.com/questions/109914/is-there-a-set-of-well-known-tracking-parameters-besides-utm
+- https://github.com/spekulatius/url-parameter-tracker-list
+- https://maxchadwick.xyz/tracking-query-params-registry/
+- https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/issues/166
+- https://github.com/xojoc/cleanurl
+- https://github.com/DandelionSprout/adfilt (LegitimateURLShortener)
+- https://gitlab.com/ClearURLs/rules (data.json) — not yet integrated

urluntrackify-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+urluntrackify/__init__.py,sha256=AEDwgYBVoerJAMqKeEgrtBn00Eymvw4raRjm7OBcm3s,33
+urluntrackify/arguments.py,sha256=avizTyBOy4bUSwms6PUDWKR8OflSyK3HPWIZTcJ7zUY,12172
+urluntrackify/untrackify.py,sha256=6dfOpkQngn902df3nDJagBkxnimTzmnn5XP4KnvV9pA,1167
+urluntrackify-0.1.0.dist-info/licenses/LICENSE.md,sha256=GUk6aZ-93Hsv-GJsKVsGyt5nVulcQvb-hei-lw4WNFY,1086
+urluntrackify-0.1.0.dist-info/METADATA,sha256=Yu29Bmy5knrxHy27WtaUf6gUFia7qnv2PxMAWP9OnDU,4969
+urluntrackify-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+urluntrackify-0.1.0.dist-info/top_level.txt,sha256=6vd58Nfj-WBTPjM8HEkLDU_yjnFM1bySArqjw28MvTg,14
+urluntrackify-0.1.0.dist-info/RECORD,,

urluntrackify-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

urluntrackify-0.1.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,9 @@
+[MIT](https://spdx.org/licenses/MIT.html)
+
+Copyright 2024 sph
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

urluntrackify-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+urluntrackify