// Copyright (C) 2023-2024 Lightpanda (Selecy SAS) // // Francis Bouvier // Pierre Tachoire // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as // published by the Free Software Foundation, either version 3 of the // License, or (at your option) any later version. // // This program 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 Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . const std = @import("std"); const Allocator = std.mem.Allocator; const Notification = @import("../../notification.zig").Notification; const log = @import("../../log.zig"); const CdpStorage = @import("storage.zig"); pub fn processMessage(cmd: anytype) !void { const action = std.meta.stringToEnum(enum { enable, disable, setCacheDisabled, setExtraHTTPHeaders, setUserAgentOverride, deleteCookies, clearBrowserCookies, setCookie, setCookies, getCookies, }, cmd.input.action) orelse return error.UnknownMethod; switch (action) { .enable => return enable(cmd), .disable => return disable(cmd), .setCacheDisabled => return cmd.sendResult(null, .{}), .setUserAgentOverride => return cmd.sendResult(null, .{}), .setExtraHTTPHeaders => return setExtraHTTPHeaders(cmd), .deleteCookies => return deleteCookies(cmd), .clearBrowserCookies => return clearBrowserCookies(cmd), .setCookie => return setCookie(cmd), .setCookies => return setCookies(cmd), .getCookies => return getCookies(cmd), } } fn enable(cmd: anytype) !void { const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; try bc.networkEnable(); return cmd.sendResult(null, .{}); } fn disable(cmd: anytype) !void { const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; bc.networkDisable(); return cmd.sendResult(null, .{}); } fn setExtraHTTPHeaders(cmd: anytype) !void { const params = (try cmd.params(struct { headers: std.json.ArrayHashMap([]const u8), })) orelse return error.InvalidParams; const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; // Copy the headers onto the browser context arena const arena = bc.arena; const extra_headers = &bc.cdp.extra_headers; extra_headers.clearRetainingCapacity(); try extra_headers.ensureTotalCapacity(arena, params.headers.map.count()); var it = params.headers.map.iterator(); while (it.next()) |header| { extra_headers.appendAssumeCapacity(.{ .name = try arena.dupe(u8, header.key_ptr.*), .value = try arena.dupe(u8, header.value_ptr.*) }); } return cmd.sendResult(null, .{}); } const Cookie = @import("../../browser/storage/storage.zig").Cookie; // Only matches the cookie on provided parameters fn cookieMatches(cookie: *const Cookie, name: []const u8, domain: ?[]const u8, path: ?[]const u8) bool { if (!std.mem.eql(u8, cookie.name, name)) return false; if (domain) |domain_| { const c_no_dot = if (std.mem.startsWith(u8, cookie.domain, ".")) cookie.domain[1..] else cookie.domain; const d_no_dot = if (std.mem.startsWith(u8, domain_, ".")) domain_[1..] else domain_; if (!std.mem.eql(u8, c_no_dot, d_no_dot)) return false; } if (path) |path_| { if (!std.mem.eql(u8, cookie.path, path_)) return false; } return true; } fn deleteCookies(cmd: anytype) !void { const params = (try cmd.params(struct { name: []const u8, url: ?[]const u8 = null, domain: ?[]const u8 = null, path: ?[]const u8 = null, partitionKey: ?CdpStorage.CookiePartitionKey = null, })) orelse return error.InvalidParams; if (params.partitionKey != null) return error.NotYetImplementedParams; const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; const cookies = &bc.session.cookie_jar.cookies; const uri = if (params.url) |url| std.Uri.parse(url) catch return error.InvalidParams else null; const uri_ptr = if (uri) |u| &u else null; var index = cookies.items.len; while (index > 0) { index -= 1; const cookie = &cookies.items[index]; const domain = try Cookie.parseDomain(cmd.arena, uri_ptr, params.domain); const path = try Cookie.parsePath(cmd.arena, uri_ptr, params.path); // We do not want to use Cookie.appliesTo here. As a Cookie with a shorter path would match. // Similar to deduplicating with areCookiesEqual, except domain and path are optional. if (cookieMatches(cookie, params.name, domain, path)) { cookies.swapRemove(index).deinit(); } } return cmd.sendResult(null, .{}); } fn clearBrowserCookies(cmd: anytype) !void { if (try cmd.params(struct {}) != null) return error.InvalidParams; const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; bc.session.cookie_jar.clearRetainingCapacity(); return cmd.sendResult(null, .{}); } fn setCookie(cmd: anytype) !void { const params = (try cmd.params( CdpStorage.CdpCookie, )) orelse return error.InvalidParams; const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; try CdpStorage.setCdpCookie(&bc.session.cookie_jar, params); try cmd.sendResult(.{ .success = true }, .{}); } fn setCookies(cmd: anytype) !void { const params = (try cmd.params(struct { cookies: []const CdpStorage.CdpCookie, })) orelse return error.InvalidParams; const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; for (params.cookies) |param| { try CdpStorage.setCdpCookie(&bc.session.cookie_jar, param); } try cmd.sendResult(null, .{}); } const GetCookiesParam = struct { urls: ?[]const []const u8 = null }; fn getCookies(cmd: anytype) !void { const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded; const params = (try cmd.params(GetCookiesParam)) orelse GetCookiesParam{}; // If not specified, use the URLs of the page and all of its subframes. TODO subframes const page_url = if (bc.session.page) |*page| page.url.raw else null; // @speed: avoid repasing the URL const param_urls = params.urls orelse &[_][]const u8{page_url orelse return error.InvalidParams}; var urls = try std.ArrayListUnmanaged(CdpStorage.PreparedUri).initCapacity(cmd.arena, param_urls.len); for (param_urls) |url| { const uri = std.Uri.parse(url) catch return error.InvalidParams; urls.appendAssumeCapacity(.{ .host = try Cookie.parseDomain(cmd.arena, &uri, null), .path = try Cookie.parsePath(cmd.arena, &uri, null), .secure = std.mem.eql(u8, uri.scheme, "https"), }); } var jar = &bc.session.cookie_jar; jar.removeExpired(null); const writer = CdpStorage.CookieWriter{ .cookies = jar.cookies.items, .urls = urls.items }; try cmd.sendResult(.{ .cookies = writer }, .{}); } // Upsert a header into the headers array. // returns true if the header was added, false if it was updated fn putAssumeCapacity(headers: *std.ArrayListUnmanaged(std.http.Header), extra: std.http.Header) bool { for (headers.items) |*header| { if (std.mem.eql(u8, header.name, extra.name)) { header.value = extra.value; return false; } } headers.appendAssumeCapacity(extra); return true; } pub fn httpRequestFail(arena: Allocator, bc: anytype, request: *const Notification.RequestFail) !void { // It's possible that the request failed because we aborted when the client // sent Target.closeTarget. In that case, bc.session_id will be cleared // already, and we can skip sending these messages to the client. const session_id = bc.session_id orelse return; // Isn't possible to do a network request within a Browser (which our // notification is tied to), without a page. std.debug.assert(bc.session.page != null); // We're missing a bunch of fields, but, for now, this seems like enough try bc.cdp.sendEvent("Network.loadingFailed", .{ .requestId = try std.fmt.allocPrint(arena, "REQ-{d}", .{request.id}), // Seems to be what chrome answers with. I assume it depends on the type of error? .type = "Ping", .errorText = request.err, .canceled = false, }, .{ .session_id = session_id }); } pub fn httpRequestStart(arena: Allocator, bc: anytype, request: *const Notification.RequestStart) !void { // Isn't possible to do a network request within a Browser (which our // notification is tied to), without a page. std.debug.assert(bc.session.page != null); var cdp = bc.cdp; // all unreachable because we _have_ to have a page. const session_id = bc.session_id orelse unreachable; const target_id = bc.target_id orelse unreachable; const page = bc.session.currentPage() orelse unreachable; // Modify request with extra CDP headers try request.headers.ensureTotalCapacity(request.arena, request.headers.items.len + cdp.extra_headers.items.len); for (cdp.extra_headers.items) |extra| { const new = putAssumeCapacity(request.headers, extra); if (!new) log.debug(.cdp, "request header overwritten", .{ .name = extra.name }); } const document_url = try urlToString(arena, &page.url.uri, .{ .scheme = true, .authentication = true, .authority = true, .path = true, .query = true, }); const request_url = try urlToString(arena, request.url, .{ .scheme = true, .authentication = true, .authority = true, .path = true, .query = true, }); const request_fragment = try urlToString(arena, request.url, .{ .fragment = true, }); var headers: std.StringArrayHashMapUnmanaged([]const u8) = .empty; try headers.ensureTotalCapacity(arena, request.headers.items.len); for (request.headers.items) |header| { headers.putAssumeCapacity(header.name, header.value); } // We're missing a bunch of fields, but, for now, this seems like enough try cdp.sendEvent("Network.requestWillBeSent", .{ .requestId = try std.fmt.allocPrint(arena, "REQ-{d}", .{request.id}), .frameId = target_id, .loaderId = bc.loader_id, .documentUrl = document_url, .request = .{ .url = request_url, .urlFragment = request_fragment, .method = @tagName(request.method), .hasPostData = request.has_body, .headers = std.json.ArrayHashMap([]const u8){ .map = headers }, }, }, .{ .session_id = session_id }); } pub fn httpRequestComplete(arena: Allocator, bc: anytype, request: *const Notification.RequestComplete) !void { // Isn't possible to do a network request within a Browser (which our // notification is tied to), without a page. std.debug.assert(bc.session.page != null); var cdp = bc.cdp; // all unreachable because we _have_ to have a page. const session_id = bc.session_id orelse unreachable; const target_id = bc.target_id orelse unreachable; const url = try urlToString(arena, request.url, .{ .scheme = true, .authentication = true, .authority = true, .path = true, .query = true, }); var headers: std.StringArrayHashMapUnmanaged([]const u8) = .empty; try headers.ensureTotalCapacity(arena, request.headers.len); for (request.headers) |header| { headers.putAssumeCapacity(header.name, header.value); } // We're missing a bunch of fields, but, for now, this seems like enough try cdp.sendEvent("Network.responseReceived", .{ .requestId = try std.fmt.allocPrint(arena, "REQ-{d}", .{request.id}), .loaderId = bc.loader_id, .response = .{ .url = url, .status = request.status, .headers = std.json.ArrayHashMap([]const u8){ .map = headers }, }, .frameId = target_id, }, .{ .session_id = session_id }); } fn urlToString(arena: Allocator, url: *const std.Uri, opts: std.Uri.WriteToStreamOptions) ![]const u8 { var buf: std.ArrayListUnmanaged(u8) = .empty; try url.writeToStream(opts, buf.writer(arena)); return buf.items; } const testing = @import("../testing.zig"); test "cdp.network setExtraHTTPHeaders" { var ctx = testing.context(); defer ctx.deinit(); // _ = try ctx.loadBrowserContext(.{ .id = "NID-A", .session_id = "NESI-A" }); try ctx.processMessage(.{ .id = 10, .method = "Target.createTarget", .params = .{ .url = "about/blank" } }); try ctx.processMessage(.{ .id = 3, .method = "Network.setExtraHTTPHeaders", .params = .{ .headers = .{ .foo = "bar" } }, }); try ctx.processMessage(.{ .id = 4, .method = "Network.setExtraHTTPHeaders", .params = .{ .headers = .{ .food = "bars" } }, }); const bc = ctx.cdp().browser_context.?; try testing.expectEqual(bc.cdp.extra_headers.items.len, 1); try ctx.processMessage(.{ .id = 5, .method = "Target.attachToTarget", .params = .{ .targetId = bc.target_id.? } }); try testing.expectEqual(bc.cdp.extra_headers.items.len, 0); } test "cdp.Network: cookies" { const ResCookie = CdpStorage.ResCookie; const CdpCookie = CdpStorage.CdpCookie; var ctx = testing.context(); defer ctx.deinit(); _ = try ctx.loadBrowserContext(.{ .id = "BID-S" }); // Initially empty try ctx.processMessage(.{ .id = 3, .method = "Network.getCookies", .params = .{ .urls = &[_][]const u8{"https://example.com/pancakes"} }, }); try ctx.expectSentResult(.{ .cookies = &[_]ResCookie{} }, .{ .id = 3 }); // Has cookies after setting them try ctx.processMessage(.{ .id = 4, .method = "Network.setCookie", .params = CdpCookie{ .name = "test3", .value = "valuenot3", .url = "https://car.example.com/defnotpancakes" }, }); try ctx.expectSentResult(null, .{ .id = 4 }); try ctx.processMessage(.{ .id = 5, .method = "Network.setCookies", .params = .{ .cookies = &[_]CdpCookie{ .{ .name = "test3", .value = "value3", .url = "https://car.example.com/pan/cakes" }, .{ .name = "test4", .value = "value4", .domain = "example.com", .path = "/mango" }, }, }, }); try ctx.expectSentResult(null, .{ .id = 5 }); try ctx.processMessage(.{ .id = 6, .method = "Network.getCookies", .params = .{ .urls = &[_][]const u8{"https://car.example.com/pan/cakes"} }, }); try ctx.expectSentResult(.{ .cookies = &[_]ResCookie{ .{ .name = "test3", .value = "value3", .domain = "car.example.com", .path = "/", .secure = true }, // No Pancakes! }, }, .{ .id = 6 }); // deleteCookies try ctx.processMessage(.{ .id = 7, .method = "Network.deleteCookies", .params = .{ .name = "test3", .domain = "car.example.com" }, }); try ctx.expectSentResult(null, .{ .id = 7 }); try ctx.processMessage(.{ .id = 8, .method = "Storage.getCookies", .params = .{ .browserContextId = "BID-S" }, }); // Just the untouched test4 should be in the result try ctx.expectSentResult(.{ .cookies = &[_]ResCookie{.{ .name = "test4", .value = "value4", .domain = ".example.com", .path = "/mango" }} }, .{ .id = 8 }); // Empty after clearBrowserCookies try ctx.processMessage(.{ .id = 9, .method = "Network.clearBrowserCookies", }); try ctx.expectSentResult(null, .{ .id = 9 }); try ctx.processMessage(.{ .id = 10, .method = "Storage.getCookies", .params = .{ .browserContextId = "BID-S" }, }); try ctx.expectSentResult(.{ .cookies = &[_]ResCookie{} }, .{ .id = 10 }); }