About DotNetUrlPatternMatching

The library allows you to match a URL to a pattern.

How it works

• an url pattern is split into parts
• each non-empty part is matched with a similar one from the URL.

You can specify a Wildcard * or ~
Where * is any character set within the group (scheme, host, port, path, query, fragment)
Where ~ any character set within a group segment (host, path)

Only supply parts of the URL you care about. Parts which are left out will match anything. E.g. if you don’t care about the host, then leave it out.

• Quick Start
  • Installation
  • Simple Examples
• URL parts
  • Scheme
  • Host
  • Port
  • Path
  • Query
  • Fragment
  • Basic Authentication
• Behavior
  • Сombining
  • URL encoding \ decoding
  • Config
  • Exceptions

Quick Start

• supports all .NETStandard versions
• no dependencies

Installation

PM> Install-Package UrlPatternMatching

.NET CLI> dotnet add package UrlPatternMatching

Simple Examples

using UrlPatternMatching;

string pattern = "http*://*.com/*/develop/README.md";
bool isMatch = "https://github.com/DotNetUrlPatternMatching/edit/develop/README.md".IsMatch(pattern);

// Should be - true

To achieve better performance, you can create an UrlPatternMatcher object and reuse it for multiple matches.

using UrlPatternMatching;

var matcher = new UrlPatternMatcher("*:443/~/Dot~Matching");
bool isMatch = matcher.IsMatch(new Uri("https://github.com/org/DotNetUrlPatternMatching"));  

// Should be - true

These objects are thread-safe and stateless, so you can create a global cache with them and reuse from different places.

URL parts

https://user:[email protected]:8081/info/main/base?withParam=one#navigate
\___/   \___________/\_____________/\__/\______________/\___________/ \______/
  |           |             |        |         |              |           |
scheme    base-auth        host     port      path          query      fragment

All parts are optional. If a part is not specified, then an url can contain any value of a similar part.

Scheme

Pattern	Matched	Not matched
http://	http://github.com/	ftp://github.com/
https://github.com/	https://github.com/	http://github.com/
http*://github.com/	https://github.com/	ftp://github.com/

Host

~ any character in domain level
* any character in domain

Pattern	Matched	Not matched
github.com	https://github.com/any	https://sub.github.com/
*.microsoft.com	https://some.any.microsoft.com	https://microsoft.com
~soft.com	https://microsoft.com	https://some.any.microsoft.com
*ozon.com	https://mozon.co	https://mozon.comic.com
ya*.com	https://ya.com	https://ya.co
ya~.com	https://yaz.com	https://www.yaz.com
github*	https://github.com	https://microsoft.com/github
192.168.1.~	https://192.168.1.1/anyPath/	https://192.168.11.11/
192.*	https://192.168.1.1/anyPath/	https://201.192.1.1
[ffff:~:~:ffff:*]	[ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff]:83	[aaa:bbbb:ffff:ffff:ffff:ffff:ffff:ffff]

Port

Pattern	Matched	Not matched
http://github.com:80	http://github.com	https://github.com
http://github.com:2*	http://github.com:23	http://github.com:65
*:6564	http://github.com:6564	http://github.com

Path

~ any character in path
* any character in segment of path

Pattern	Matched	Not matched
/api/user/get	https://github.com/api/user/get?w=1	https://github.com/api/user/get/45/
/api/us~	https://github.com/api/users	https://github.com/api/user/get
/api/us*	https://github.com/api/user/get	https://github.com/svc/api/user
/api/user/~/get	https://github.com/api/user/8787/get	https://github.com/api/user
github.com/*api/users	https://github.com/v3/api/users	https://github.com/v3/api/users/get

Query

To match parameters in the template, you have to specify all of:

• a parameter (or part of it)
• the = sign
• a value (or part of it)

For case sensitive comparison, you can set the parameters: IsCaseSensitiveParamNames or IsCaseSensitiveParamValues in config

Pattern	Matched	Not matched
?cc=33&aa=1*	http://github.com?aa=11&bb=22&cc=33	http://github.com
?cc=33&a*=11	http://github.com?abs=11&bb=22&cc=33	http://github.com?cc=33&bba=11
http://github.com?text=%D0*	http://github.com?text=%D0%BC%D0%BE%D0%BB	http://github.com?text=%BC%D0

Fragment

Pattern	Matched	Not matched
http://github.com#main*	http://github.com#maintable	https://github.com#table
http://github.com#main*page*load	http://github.com#mainAnyPageWillLoad	http://github.com#baseMainAnyPageWillLoad
http://github.com#*load	http://github.com#mainPageLoad	http://github.com#mainPageLoadThen
#main	http://github.com#main	https://main.com

Basic Authentication

You can also check basic authentication, sent via URL (not all browsers are supported)

Pattern	Matched	Not matched
https://myUser:[email protected]	https://myUser:[email protected]	https://github.com
https://myUser:@github.com	https://myUser:[email protected]	https://other:[email protected]
https://mail*:@github.com	https://mail1:[email protected]	https://other:[email protected]

Behavior

Scheme and host are always case insensitive.

Сombining

You can combine different parts in the template and specify several wildcards

Example: *nuget*/~/~/?top=* should be matched with https://www.nuget.org/packages/UrlPatternMatching?top=100

Also, you can skip any part and specify, for example, only a scheme and a fragment

Example: https://#page

URL encoding \ decoding

You can perform matching using URL encoded or URL decoded characters.

Pattern	will match
#молоко	https://github.com#%D0%BC%D0%BE%D0%BB%D0%BE%D0%BA%D0%BE
github.com#молоко	https://github.com#молоко
#%D0%BC%D0%BE%D0%BB%D0%BE%D0%BA%D0%BE	https://github.com#молоко
#%D0*	https://github.com#D0%BC%D0%BE%D0%BB%D0%BE%D0%BA%D0%BE

Config

For global settings use Config.Default. For local settings create a new Config(). If a config is not specified, then the default config will be applied.

Config class contains case sensitivity settings for most parts (by default, match is case sensitive).

public class Config
{
	public bool IsCaseSensitivePathMatch { get; set; } = false;
	public bool IsCaseSensitiveFragmentMatch { get; set; } = false;
	public bool IsCaseSensitiveParamNames { get; set; } = false;
	public bool IsCaseSensitiveParamValues { get; set; } = false;
	public bool IsCaseSensitiveUserAndPassword { get; set; } = true;
}

Example:

Config.Default.IsCaseSensitiveParamValues = true; 

Example:

var config = new Config { IsCaseSensitivePathMatch = true };
var matcher = new UrlPatternMatcher("/atlassian.net/jira/your-work/", config);
bool result = matcher.IsMatch("https://any.atlassian.net/jira/Your-Work");

A config can be passed as a parameter for UrlExtensions.IsMatch Example:

var config = new Config();
bool isMatch = "https://github.com".IsMatch("*.com", config);

Exceptions

The library may throw exceptions of type InvalidPatternException or UriFormatException