ClearURLs Module Configuration

Place this in your unrealircd.conf or include it via: include 'clearurls.conf';

clearurls {

Strip tracking parameters from NOTICE messages (default: yes)

strip-notices yes;

# Enable debug logging (default: no)
debug-logging yes;

# Exempt specific channels from URL cleaning (supports wildcards)
exempt-channels '#help,#chan2,#chan*';

# ========================================================================
# URL Pattern Definitions
# Each pattern defines:
#   - name: Descriptive name for the pattern
#   - domain: Regex to match
#   - params: Comma-separated list of parameters to strip
# ========================================================================

# pattern {
#     name 'My Custom Site';
#     domain 'https?://([^/]*\\.)?mycustomsite\\.com';
#     params 'trackid,sessionid,refid,campaign';
# }

pattern {
    name 'Google';
    domain 'https?://(?:[a-z0-9-]+\\.)*?google(?:\\.[a-z]{2,}){1,}';
    params 'gclid,gclsrc,dclid,gbraid,wbraid,gad_source,gad_campaignid,ved,ei,sei,sa,usg,cd,cad,uact,ved,sourceid,_ga,gs_lcp';
}

pattern {
    name 'Facebook';
    domain 'https?://([^/]*\\.)?(facebook\\.com|fb\\.com|fbcdn\\.net|messenger\\.com)';
    params 'fbclid,fb_action_ids,fb_action_types,fb_source,fb_ref,action_object_map,action_type_map,action_ref_map,fb_comment_id,notif_id,notif_t,ref,fref,hc_location,refsrc,_rdr';
}

pattern {
    name 'Amazon';
    domain 'https?://([^/]*\\.)?amazon\\.';
    params 'pd_rd_i,pd_rd_r,pd_rd_w,pd_rd_wg,pf_rd_i,pf_rd_m,pf_rd_p,pf_rd_r,pf_rd_s,pf_rd_t,psc,qid,ref_,tag,linkCode,creative,creativeASIN,ascsubtag,aaxitk,hsa_cr_id,sb-ci-n,sb-ci-v,sb-ci-a,th,psc,smid,language,crid,sprefix,keywords,ie';
}

pattern {
    name 'YouTube';
    domain 'https?://([^/]*\\.)?(youtube\\.com|youtu\\.be|youtube-nocookie\\.com)';
    params 'feature,gclid,kw,si,pp,ab_channel,app,attribution_link,gl,hl,persist_gl,persist_hl';
}

pattern {
    name 'Twitter/X';
    domain 'https?://([^/]*\\.)?(twitter\\.com|x\\.com|t\\.co)';
    params 's,t,cn,ref_src,ref_url,twclid,tw_doc,tw_i,tw_p';
}

pattern {
    name 'Instagram';
    domain 'https?://([^/]*\\.)?instagram\\.com';
    params 'igshid,igsh,img_index';
}

pattern {
    name 'TikTok';
    domain 'https?://([^/]*\\.)?(tiktok\\.com|vm\\.tiktok\\.com)';
    params 'is_copy_url,is_from_webapp,sender_device,sender_web_id,_r,referer_url,referer_video_id';
}

pattern {
    name 'LinkedIn';
    domain 'https?://([^/]*\\.)?linkedin\\.com';
    params 'trk,trkInfo,trackingId,refId,originalReferer,originalSubdomain,lipi';
}

pattern {
    name 'Reddit';
    domain 'https?://([^/]*\\.)?reddit\\.com';
    params 'ref,ref_source,rdt_cid,utm_name,share_id,$deep_link,$android_deeplink_path';
}

pattern {
    name 'Spotify';
    domain 'https?://([^/]*\\.)?spotify\\.com';
    params 'si,context,dl_branch,nd,_branch_match_id,_branch_referrer,feature';
}

pattern {
    name 'Pinterest';
    domain 'https?://([^/]*\\.)?pinterest\\.';
    params 'source,campaign,mt,vt,orig,eq';
}

pattern {
    name 'eBay';
    domain 'https?://([^/]*\\.)?ebay\\.';
    params 'hash,_trksid,_trkparms,amdata,var,mkevt,mkcid,mkrid,campid,toolid,customid';
}

pattern {
    name 'AliExpress';
    domain 'https?://([^/]*\\.)?aliexpress\\.';
    params 'spm,scm,algo_pvid,algo_exp_id,btsid,ws_ab_test,pdp_ext_f,pdp_npi,businessType,gatewayAdapt,isfdp,trackKey,shortkey,aff_fcid,aff_fsk,aff_platform,aff_trace_key,terminal_id';
}

pattern {
    name 'Microsoft/Bing';
    domain 'https?://([^/]*\\.)?(bing\\.com|microsoft\\.com|msn\\.com)';
    params 'msclkid,cvid,form,ocid,pc,sp,sc,qs,sk,FORM,pq,form,ck,ts';
}

pattern {
    name 'Apple';
    domain 'https?://([^/]*\\.)?apple\\.com';
    params 'afid,cid,src,at,ct,itscg,itsct,ign-mpt,ign-itsct,ign-itscg';
}

pattern {
    name 'Etsy';
    domain 'https?://([^/]*\\.)?etsy\\.com';
    params 'ref,pro,frs,sts,plkey,ga_order,ga_search_type,ga_view_type,ga_search_query,click_key,click_sum,ref,rec_type,organic_search_click';
}

pattern {
    name 'Shopify';
    domain 'https?://([^/]*\\.)?myshopify\\.com';
    params 'variant,currency,a,ls,mc_cid,mc_eid,_ke,_kx,funnel,funnelStep';
}

pattern {
    name 'Bloomberg';
    domain 'https?://([^/]*\\.)?bloomberg\\.com';
    params 'leadSource,sref,srnd';
}

pattern {
    name 'New York Times';
    domain 'https?://([^/]*\\.)?nytimes\\.com';
    params 'smid,smtyp,partner,module,action,region,pgtype,te,nl';
}

pattern {
    name 'Washington Post';
    domain 'https?://([^/]*\\.)?washingtonpost\\.com';
    params 'tid,itid,hpid';
}

pattern {
    name 'Reuters';
    domain 'https?://([^/]*\\.)?reuters\\.com';
    params 'taid,rpc';
}

pattern {
    name 'BBC';
    domain 'https?://([^/]*\\.)?bbc\\.';
    params 'ns_mchannel,ns_source,ns_campaign,ns_linkname,ns_fee,pinned_post_locator,pinned_post_asset_id,pinned_post_type,at_medium,at_campaign';
}

pattern {
    name 'CNN';
    domain 'https?://([^/]*\\.)?cnn\\.com';
    params 'iid,hpt';
}

pattern {
    name 'Medium';
    domain 'https?://([^/]*\\.)?medium\\.com';
    params 'source,sk';
}

pattern {
    name 'Twitch';
    domain 'https?://([^/]*\\.)?twitch\\.tv';
    params 'tt_medium,tt_content';
}

pattern {
    name 'Steam';
    domain 'https?://([^/]*\\.)?steampowered\\.com';
    params 'snr,curator_clanid';
}

pattern {
    name 'IMDb';
    domain 'https?://([^/]*\\.)?imdb\\.com';
    params 'ref_,pf_rd_m,pf_rd_p,pf_rd_r,pf_rd_s,pf_rd_t,pf_rd_i';
}

pattern {
    name 'Walmart';
    domain 'https?://([^/]*\\.)?walmart\\.com';
    params 'athcpid,athpgid,athcgid,athznid,athieid,athstid,athena,affcampaignid,afcid,veh,wmlspartner,affiliates_ad_id,campaign_id';
}

pattern {
    name 'Target';
    domain 'https?://([^/]*\\.)?target\\.com';
    params 'lnk,afid,cpng,ref,preselect,clkid';
}

pattern {
    name 'Best Buy';
    domain 'https?://([^/]*\\.)?bestbuy\\.com';
    params 'irclickid,irgwc,loc,ref,acampID,cmp,sku,intl';
}

pattern {
    name 'Newegg';
    domain 'https?://([^/]*\\.)?newegg\\.';
    params 'cm_mmc,ignorebbr,nm_mc,icid';
}

pattern {
    name 'GitHub';
    domain 'https?://([^/]*\\.)?github\\.com';
    params 'ref_cta,ref_loc,ref_page,source,email_source,email_token';
}

pattern {
    name 'Stack Overflow';
    domain 'https?://([^/]*\\.)?stackoverflow\\.com';
    params 'cb,lq,sq,so_medium,so_source';
}

pattern {
    name 'Wikipedia';
    domain 'https?://([^/]*\\.)?wikipedia\\.org';
    params 'wprov';
}

pattern {
    name 'Telegram';
    domain 'https?://([^/]*\\.)?(t\\.me|telegram\\.me|telegram\\.org)';
    params 'source';
}

pattern {
    name 'WhatsApp';
    domain 'https?://([^/]*\\.)?whatsapp\\.com';
    params 'text,app_absent';
}

pattern {
    name 'Slack';
    domain 'https?://([^/]*\\.)?slack\\.com';
    params 'redir,geocode,cid';
}

pattern {
    name 'Discord';
    domain 'https?://([^/]*\\.)?discord\\.';
    params 'ref,referer,redirect';
}

pattern {
    name 'Zoom';
    domain 'https?://([^/]*\\.)?zoom\\.';
    params 'zcid,zc_t';
}

# catch-all
pattern {
    name 'Generic Tracking';
    domain 'https?://';
    params 'gclid,gbraid,gad_campaignid,gad_source,utm_source,utm_medium,utm_campaign,utm_term,utm_content,utm_id,utm_source_platform,utm_creative_format,utm_marketing_tactic,_hsenc,_hsmi,mc_cid,mc_eid,mkt_tok,oly_anon_id,oly_enc_id,rb_clickid,s_cid,vero_id,wickedid,yclid,msclkid,igshid,zanpid,ncid,nr_email_referer,itm_source,itm_medium,itm_campaign,itm_content,pfm_caref,pfm_page,pfm_pos,at_custom1,at_custom2,at_custom3,at_custom4,ICID,soc_src,soc_trk,_openstat,mb_ck,fromModule,algopvid,campaignId,adGroupId,feedbackId,trafficChannel,bxid';
}

}