Skip to content

fix: metadata @match now for url path plus query string #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ACTCD merged 2 commits into from
Apr 14, 2023
Merged

fix: metadata @match now for url path plus query string #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a41b0c7
fix: `@match` for path plus query string
ACTCD Apr 12, 2023
76478ae
fix: xctest with new cases
ACTCD Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 13 additions & 21 deletions xcode/Mac-Tests/UserscriptsTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
//

import XCTest
@testable import Userscripts_Extension
@testable import Userscripts_Mac_Safari_Extension

class UserscriptsTests: XCTestCase {

Expand Down Expand Up @@ -144,6 +144,10 @@ class UserscriptsTests: XCTestCase {
"http://127.0.0.1/*": [
"http://127.0.0.1/",
"http://127.0.0.1/foo/bar.html"
],
"*://*.example.com/*?a=1*": [
"http://example.com/?a=1",
"https://www.example.com/index?a=1&b=2"
]
]
let patternDictFails = [
Expand All @@ -163,37 +167,25 @@ class UserscriptsTests: XCTestCase {
],
"https://www.example*/*": [
"https://www.example.com/"
],
"*://*.example.com/*?a=1*": [
"http://example.com/",
"https://www.example.com/?a=2"
]
]
for (pattern, urls) in patternDict {
count = count + urls.count
for url in urls {
if
let parts = getUrlProps(url),
let ptcl = parts["protocol"],
let host = parts["host"],
let path = parts["pathname"]
{
if match(ptcl, host, path, pattern) {
result.append("1")
}
if match(url, pattern) {
result.append("1")
}
}
}
for (pattern, urls) in patternDictFails {
// don't increment count since these tests should fail
for url in urls {
if
let parts = getUrlProps(url),
let ptcl = parts["protocol"],
let host = parts["host"],
let path = parts["pathname"]
{
if match(ptcl, host, path, pattern) {
// if these match, results will get an extra element
// and then the test will fail
result.append("1")
}
if match(url, pattern) {
result.removeLast()
}
}
}
Expand Down
62 changes: 37 additions & 25 deletions xcode/Safari-Extension/Functions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1072,7 +1072,17 @@ func getUrlProps(_ url: String) -> [String: String]? {
err("failed to parse url in getUrlProps")
return nil
}
return ["protocol": "\(ptcl):", "host": host, "pathname": parts.path, "href": url]
var search = ""
if let query = parts.query {
search = "?" + query
}
return [
"protocol": "\(ptcl):",
"host": host,
"pathname": parts.path,
"search": search,
"href": url
]
}

func stringToRegex(_ stringPattern: String) -> NSRegularExpression? {
Expand All @@ -1085,7 +1095,23 @@ func stringToRegex(_ stringPattern: String) -> NSRegularExpression? {
return regex
}

func match(_ ptcl: String,_ host: String,_ path: String,_ matchPattern: String) -> Bool {
func match(_ url: String, _ matchPattern: String) -> Bool {
guard
let parts = getUrlProps(url),
let ptcl = parts["protocol"],
let host = parts["host"],
var path = parts["pathname"]
else {
err("invalid url \(url)")
return false
}

// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns#path
// The value for the path matches against the string which is the URL path plus the URL query string
if let search = parts["search"], search.count > 0 {
path += search
}

// matchPattern is the value from metatdata key @match or @exclude-match
if (matchPattern == "<all_urls>") {
return true
Expand Down Expand Up @@ -1156,17 +1182,7 @@ func include(_ url: String,_ pattern: String) -> Bool {
func getMatchedFiles(_ url: String, _ optionalManifest: Manifest?, _ checkBlocklist: Bool) -> [String] {
logText("Getting matched files for \(url)")
let manifest = optionalManifest ?? getManifest()
guard
let parts = getUrlProps(url),
let ptcl = parts["protocol"],
let host = parts["host"],
let path = parts["pathname"],
let href = parts["href"]
else {
err("getMatchedFiles failed at (1) for \(url)")
return [String]()
}


// filenames that should not load for the passed url
// the manifest values from @exclude and @exclude-match populate this set
var excludedFilenames: Set<String> = []
Expand All @@ -1185,7 +1201,7 @@ func getMatchedFiles(_ url: String, _ optionalManifest: Manifest?, _ checkBlockl
// if url matches a pattern in blocklist, no injection for this url
if (checkBlocklist) {
for pattern in manifest.blacklist {
if match(ptcl, host, path, pattern) {
if match(url, pattern) {
// return empty array
return Array(matchedFilenames)
}
Expand All @@ -1195,7 +1211,7 @@ func getMatchedFiles(_ url: String, _ optionalManifest: Manifest?, _ checkBlockl
// loop through all the @exclude-match patterns
// if any match passed url, push all filenames to excludedFilenames set
for pattern in excludeMatchPatterns {
if match(ptcl, host, path, pattern) {
if match(url, pattern) {
guard let filenames = manifest.excludeMatch[pattern] else {
err("getMatchedFiles failed at (2) for \(pattern)")
continue
Expand All @@ -1204,7 +1220,7 @@ func getMatchedFiles(_ url: String, _ optionalManifest: Manifest?, _ checkBlockl
}
}
for exp in excludeExpressions {
if include(href, exp) {
if include(url, exp) {
guard let filenames = manifest.exclude[exp] else {
err("getMatchedFiles failed at (3) for \(exp)")
continue
Expand All @@ -1213,7 +1229,7 @@ func getMatchedFiles(_ url: String, _ optionalManifest: Manifest?, _ checkBlockl
}
}
for pattern in matchPatterns {
if match(ptcl, host, path, pattern) {
if match(url, pattern) {
guard let filenames = manifest.match[pattern] else {
err("getMatchedFiles failed at (4) for \(pattern)")
continue
Expand All @@ -1222,7 +1238,7 @@ func getMatchedFiles(_ url: String, _ optionalManifest: Manifest?, _ checkBlockl
}
}
for exp in includeExpressions {
if include(href, exp) {
if include(url, exp) {
guard let filenames = manifest.include[exp] else {
err("getMatchedFiles failed at (5) for \(exp)")
continue
Expand Down Expand Up @@ -1616,14 +1632,10 @@ func getPopupBadgeCount(_ url: String, _ subframeUrls: [String]) -> Int? {
if showCount == "false" {
return 0
}
if let parts = getUrlProps(url), let ptcl = parts["protocol"], let host = parts["host"], let path = parts["pathname"] {
for pattern in manifest.blacklist {
if match(ptcl, host, path, pattern) {
return 0
}
for pattern in manifest.blacklist {
if match(url, pattern) {
return 0
}
} else {
return 0
}
if active != "true" {
return 0
Expand Down
2 changes: 1 addition & 1 deletion xcode/xcconfig/Mac-Tests.xcconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ MARKETING_VERSION = 1.0
PRODUCT_BUNDLE_IDENTIFIER = $(ORG_IDENTIFIER).UserscriptsTests
PRODUCT_NAME = $(TARGET_NAME)
SWIFT_EMIT_LOC_STRINGS = NO
TEST_HOST = $(BUILT_PRODUCTS_DIR)/Userscripts.app/Contents/MacOS/Userscripts
TEST_HOST = $(BUILT_PRODUCTS_DIR)/Userscripts-Debug.app/Contents/MacOS/Userscripts-Debug

// Override this file
#include? "Mac-Tests.dev.xcconfig"