1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
|
/*
* Copyright (C) 2024 Igalia S.L.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "config.h"
#include "WebKitWebExtensionMatchPattern.h"
#include "WebExtensionMatchPattern.h"
#include "WebKitError.h"
#include "WebKitPrivate.h"
#include <wtf/URLParser.h>
using namespace WebKit;
/**
* WebKitWebExtensionMatchPattern: (ref-func webkit_web_extension_match_pattern_ref) (unref-func webkit_web_extension_match_pattern_unref)
*
* Represents a way to specify a group of URLs for use in WebExtensions.
*
* All match patterns are specified as strings. Apart from the special `<all_urls>` pattern, match patterns
* consist of three parts: scheme, host, and path.
*
* Generally, match patterns are returned from a #WebKitWebExtension.
*
* Since: 2.48
*/
struct _WebKitWebExtensionMatchPattern {
#if ENABLE(WK_WEB_EXTENSIONS)
explicit _WebKitWebExtensionMatchPattern(RefPtr<WebExtensionMatchPattern>&& matchPattern)
: matchPattern(WTFMove(matchPattern))
{
}
RefPtr<WebExtensionMatchPattern> matchPattern;
CString string { matchPattern->string().utf8() };
CString scheme { matchPattern->scheme().utf8() };
CString host { matchPattern->host().utf8() };
CString path { matchPattern->path().utf8() };
bool matchesAllURLs { matchPattern->matchesAllURLs() };
bool matchesAllHosts { matchPattern->matchesAllHosts() };
int referenceCount { 1 };
#else
_WebKitWebExtensionMatchPattern()
{
}
#endif
};
G_DEFINE_BOXED_TYPE(WebKitWebExtensionMatchPattern, webkit_web_extension_match_pattern, webkit_web_extension_match_pattern_ref, webkit_web_extension_match_pattern_unref)
#if ENABLE(WK_WEB_EXTENSIONS)
/**
* webkit_web_extension_match_pattern_register_custom_URL_scheme:
* @urlScheme: The custom URL scheme to register
*
* Registers a custom URL scheme that can be used in match patterns.
*
* This method should be used to register any custom URL schemes used by the app for the extension base URLs,
* other than `webkit-extension`, or if extensions should have access to other supported URL schemes when using `<all_urls>`.
*
* Since: 2.48
*/
void webkit_web_extension_match_pattern_register_custom_URL_scheme(const gchar* urlScheme)
{
g_return_if_fail(WTF::URLParser::maybeCanonicalizeScheme(String::fromUTF8(urlScheme)));
WebKit::WebExtensionMatchPattern::registerCustomURLScheme(String::fromUTF8(urlScheme));
}
WebKitWebExtensionMatchPattern* webkitWebExtensionMatchPatternCreate(const RefPtr<WebExtensionMatchPattern>& apiMatchPattern)
{
if (!apiMatchPattern)
return nullptr;
ASSERT(API::Object::unwrap(static_cast<void*>(apiMatchPattern.get()))->type() == API::Object::Type::WebExtensionMatchPattern);
WebKitWebExtensionMatchPattern* matchPattern = static_cast<WebKitWebExtensionMatchPattern*>(fastMalloc(sizeof(WebKitWebExtensionMatchPattern)));
new (matchPattern) WebKitWebExtensionMatchPattern(static_pointer_cast<WebExtensionMatchPattern>(apiMatchPattern));
return matchPattern;
}
WebKitWebExtensionMatchPattern* webkitWebExtensionMatchPatternCreate(Ref<WebExtensionMatchPattern>& matchPattern)
{
RefPtr<WebExtensionMatchPattern> apiMatchPattern = adoptRef(matchPattern.get());
return webkitWebExtensionMatchPatternCreate(apiMatchPattern);
}
/**
* webkit_web_extension_match_pattern_ref:
* @matchPattern: a #WebKitWebExtensionMatchPattern
*
* Atomically acquires a reference on the given @matchPattern.
*
* This function is MT-safe and may be called from any thread.
*
* Returns: The same @matchPattern with an additional reference.
*
* Since: 2.48
*/
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_ref(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_val_if_fail(matchPattern, nullptr);
g_atomic_int_inc(&matchPattern->referenceCount);
return matchPattern;
}
/**
* webkit_web_extension_match_pattern_unref:
* @matchPattern: a #WebKitWebExtensionMatchPattern
*
* Atomically releases a reference on the given @matchPattern.
*
* If the reference was the last, the resources associated to the
* @matchPattern are freed. This function is MT-safe and may be called from
* any thread.
*
* Since: 2.48
*/
void webkit_web_extension_match_pattern_unref(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_if_fail(matchPattern);
if (g_atomic_int_dec_and_test(&matchPattern->referenceCount)) {
matchPattern->~WebKitWebExtensionMatchPattern();
fastFree(matchPattern);
}
}
/**
* webkit_web_extension_match_pattern_new_all_urls:
*
* Returns a new #WebKitWebExtensionMatchPattern for `<all_urls>`.
*
* Returns: (transfer full): a newly created #WebKitWebExtensionMatchPattern
*
* Since: 2.48
*/
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_all_urls()
{
return webkitWebExtensionMatchPatternCreate(WebExtensionMatchPattern::allURLsMatchPattern());
}
/**
* webkit_web_extension_match_pattern_new_all_hosts_and_schemes:
*
* Returns a new #WebKitWebExtensionMatchPattern that has `*` for scheme, host, and path.
*
* Returns: (transfer full): a newly created #WebKitWebExtensionMatchPattern
*
* Since: 2.48
*/
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_all_hosts_and_schemes()
{
return webkitWebExtensionMatchPatternCreate(WebExtensionMatchPattern::allHostsAndSchemesMatchPattern());
}
/**
* webkit_web_extension_match_pattern_new_with_string:
* @string: A pattern string
* @error: The return location for a recoverable error.
*
* Returns a new #WebKitWebExtensionMatchPattern for the specified @string.
*
* Returns: (transfer full) (nullable): a newly created #WebKitWebExtensionMatchPattern, or %NULL
* if the pattern string is invalid.
*
* Since: 2.48
*/
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_with_string(const gchar* string, GError** error)
{
if (!error)
return webkitWebExtensionMatchPatternCreate(WebExtensionMatchPattern::getOrCreate(String::fromUTF8(string)));
RefPtr<API::Error> internalError;
RefPtr matchPattern = WebKit::WebExtensionMatchPattern::create(String::fromUTF8(string), internalError);
if (error && internalError) {
g_set_error(error, webkit_web_extension_match_pattern_error_quark(),
toWebKitWebExtensionMatchPatternError(internalError->errorCode()), internalError->localizedDescription().utf8().data(), nullptr);
}
return webkitWebExtensionMatchPatternCreate(matchPattern);
}
/**
* webkit_web_extension_match_pattern_new_with_scheme:
* @scheme: A pattern URL scheme
* @host: A pattern URL host
* @path: A pattern URL path
* @error: The return location for a recoverable error.
*
* Returns a new #WebKitWebExtensionMatchPattern for the specified @scheme, @host, and @path strings.
*
* Returns: (transfer full) (nullable): a newly created #WebKitWebExtensionMatchPattern, or %NULL
* if any of the pattern strings are invalid.
*
* Since: 2.48
*/
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_with_scheme(const gchar* scheme, const gchar* host, const gchar* path, GError** error)
{
if (!error)
return webkitWebExtensionMatchPatternCreate(WebExtensionMatchPattern::getOrCreate(String::fromUTF8(scheme), String::fromUTF8(host), String::fromUTF8(path)));
RefPtr<API::Error> internalError;
RefPtr matchPattern = WebKit::WebExtensionMatchPattern::create(String::fromUTF8(scheme), String::fromUTF8(host), String::fromUTF8(path), internalError);
if (error && internalError) {
g_set_error(error, webkit_web_extension_match_pattern_error_quark(),
toWebKitWebExtensionMatchPatternError(internalError->errorCode()), internalError->localizedDescription().utf8().data(), nullptr);
}
return webkitWebExtensionMatchPatternCreate(matchPattern);
}
/**
* webkit_web_extension_match_pattern_get_string:
* @matchPattern: A #WebKitWebExtensionMatchPattern
*
* Gets the original pattern string.
*
* Returns: (transfer none): The original pattern string.
*
* Since: 2.48
*/
const gchar* webkit_web_extension_match_pattern_get_string(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_val_if_fail(matchPattern, nullptr);
return matchPattern->string.data();
}
/**
* webkit_web_extension_match_pattern_get_scheme:
* @matchPattern: A #WebKitWebExtensionMatchPattern
*
* Gets the scheme part of the pattern string, unless `webkit_web_extension_match_pattern_get_matches_all_urls` is %TRUE.
*
* Returns: (transfer none): The scheme string.
*
* Since: 2.48
*/
const gchar* webkit_web_extension_match_pattern_get_scheme(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_val_if_fail(matchPattern, nullptr);
return matchPattern->scheme.data();
}
/**
* webkit_web_extension_match_pattern_get_host:
* @matchPattern: A #WebKitWebExtensionMatchPattern
*
* Gets the host part of the pattern string, unless `webkit_web_extension_match_pattern_get_matches_all_urls` is %TRUE.
*
* Returns: (transfer none): The host string.
*
* Since: 2.48
*/
const gchar* webkit_web_extension_match_pattern_get_host(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_val_if_fail(matchPattern, nullptr);
return matchPattern->host.data();
}
/**
* webkit_web_extension_match_pattern_get_path:
* @matchPattern: A #WebKitWebExtensionMatchPattern
*
* Gets the path part of the pattern string, unless [method@WebExtensionMatchPattern.get_matches_all_urls] is %TRUE.
*
* Returns: (transfer none): The path string.
*
* Since: 2.48
*/
const gchar* webkit_web_extension_match_pattern_get_path(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_val_if_fail(matchPattern, nullptr);
return matchPattern->path.data();
}
/**
* webkit_web_extension_match_pattern_get_matches_all_urls:
* @matchPattern: A #WebKitWebExtensionMatchPattern
*
* Gets whether the match pattern matches all URLs, in other words, whether
* the pattern is `<all_urls>`.
*
* Returns: Whether this match pattern matches all URLs.
*
* Since: 2.48
*/
gboolean webkit_web_extension_match_pattern_get_matches_all_urls(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_val_if_fail(matchPattern, FALSE);
return matchPattern->matchesAllURLs;
}
/**
* webkit_web_extension_match_pattern_get_matches_all_hosts:
* @matchPattern: A #WebKitWebExtensionMatchPattern
*
* Gets whether the match pattern matches all host. This happens when
* the pattern is `<all_urls>`, or if `*` is set as the host string.
*
* Returns: Whether this match pattern matches all hosts.
*
* Since: 2.48
*/
gboolean webkit_web_extension_match_pattern_get_matches_all_hosts(WebKitWebExtensionMatchPattern* matchPattern)
{
g_return_val_if_fail(matchPattern, FALSE);
return matchPattern->matchesAllHosts;
}
static OptionSet<WebExtensionMatchPattern::Options> toImpl(WebKitWebExtensionMatchPatternOptions options)
{
OptionSet<WebExtensionMatchPattern::Options> result;
if (options & WEBKIT_WEB_EXTENSION_MATCH_PATTERN_OPTIONS_IGNORE_SCHEMES)
result.add(WebExtensionMatchPattern::Options::IgnoreSchemes);
if (options & WEBKIT_WEB_EXTENSION_MATCH_PATTERN_OPTIONS_IGNORE_PATHS)
result.add(WebExtensionMatchPattern::Options::IgnorePaths);
if (options & WEBKIT_WEB_EXTENSION_MATCH_PATTERN_OPTIONS_MATCH_BIDIRECTIONALLY)
result.add(WebExtensionMatchPattern::Options::MatchBidirectionally);
return result;
}
/**
* webkit_web_extension_match_pattern_matches_url:
* @matchPattern: A #WebKitWebExtensionMatchPattern
* @url: The URL to match against the pattern.
* @options: The #WebKitWebExtensionMatchPatternOptions use while matching.
*
* Matches the @matchPattern against the specified URL with options.
*
* Returns: Whether the pattern matches the specified URL.
*
* Since: 2.48
*/
gboolean webkit_web_extension_match_pattern_matches_url(WebKitWebExtensionMatchPattern* matchPattern, const gchar* url, WebKitWebExtensionMatchPatternOptions options)
{
g_return_val_if_fail(matchPattern, FALSE);
g_return_val_if_fail(url, FALSE);
if (options & WEBKIT_WEB_EXTENSION_MATCH_PATTERN_OPTIONS_MATCH_BIDIRECTIONALLY)
g_warning("Invalid parameter: WEBKIT_WEB_EXTENSION_MATCH_PATTERN_OPTIONS_MATCH_BIDIRECTIONALLY is not valid when matching a URL");
return matchPattern->matchPattern->matchesURL(URL(String::fromUTF8(url)), toImpl(options));
}
/**
* webkit_web_extension_match_pattern_matches_pattern:
* @matchPattern: A #WebKitWebExtensionMatchPattern to match against.
* @pattern: The #WebKitWebExtensionMatchPattern to match with @matchPattern.
* @options: The #WebKitWebExtensionMatchPatternOptions use while matching.
*
* Matches the @matchPattern against the specified @pattern with options.
*
* Returns: Whether the pattern matches the specified @pattern.
*
* Since: 2.48
*/
gboolean webkit_web_extension_match_pattern_matches_pattern(WebKitWebExtensionMatchPattern* matchPattern, WebKitWebExtensionMatchPattern* pattern, WebKitWebExtensionMatchPatternOptions options)
{
g_return_val_if_fail(matchPattern, FALSE);
g_return_val_if_fail(pattern, FALSE);
return matchPattern->matchPattern->matchesPattern(*(pattern->matchPattern), toImpl(options));
}
#else // ENABLE(WK_WEB_EXTENSIONS)
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_ref(WebKitWebExtensionMatchPattern* matchPattern)
{
return nullptr;
}
void webkit_web_extension_match_pattern_unref(WebKitWebExtensionMatchPattern* matchPattern)
{
return;
}
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_all_urls()
{
return nullptr;
}
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_all_hosts_and_schemes()
{
return nullptr;
}
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_with_string(const gchar* string, GError** error)
{
return nullptr;
}
WebKitWebExtensionMatchPattern* webkit_web_extension_match_pattern_new_with_scheme(const gchar* scheme, const gchar* host, const gchar* path, GError** error)
{
return nullptr;
}
void webkit_web_extension_match_pattern_register_custom_URL_scheme(const gchar* urlScheme)
{
return;
}
const gchar* webkit_web_extension_match_pattern_get_string(WebKitWebExtensionMatchPattern* matchPattern)
{
return "";
}
const gchar* webkit_web_extension_match_pattern_get_scheme(WebKitWebExtensionMatchPattern* matchPattern)
{
return "";
}
const gchar* webkit_web_extension_match_pattern_get_host(WebKitWebExtensionMatchPattern* matchPattern)
{
return "";
}
const gchar* webkit_web_extension_match_pattern_get_path(WebKitWebExtensionMatchPattern* matchPattern)
{
return "";
}
gboolean webkit_web_extension_match_pattern_get_matches_all_urls(WebKitWebExtensionMatchPattern* matchPattern)
{
return 0;
}
gboolean webkit_web_extension_match_pattern_get_matches_all_hosts(WebKitWebExtensionMatchPattern* matchPattern)
{
return 0;
}
gboolean webkit_web_extension_match_pattern_matches_url(WebKitWebExtensionMatchPattern* matchPattern, const gchar* url, WebKitWebExtensionMatchPatternOptions options)
{
return 0;
}
gboolean webkit_web_extension_match_pattern_matches_pattern(WebKitWebExtensionMatchPattern* matchPattern, WebKitWebExtensionMatchPattern* pattern, WebKitWebExtensionMatchPatternOptions options)
{
return 0;
}
#endif // ENABLE(WK_WEB_EXTENSIONS)
|