From 976eca99580339c8cbb81819b54134de9ac8b97e Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Mon, 13 Jun 2016 23:34:45 +0100 Subject: msplit public url database API out for frontends --- include/netsurf/cookie_db.h | 90 ++++++++++++++++++++++++++++++ include/netsurf/url_db.h | 130 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 220 insertions(+) create mode 100644 include/netsurf/cookie_db.h create mode 100644 include/netsurf/url_db.h (limited to 'include') diff --git a/include/netsurf/cookie_db.h b/include/netsurf/cookie_db.h new file mode 100644 index 000000000..54d014508 --- /dev/null +++ b/include/netsurf/cookie_db.h @@ -0,0 +1,90 @@ +/* + * Copyright 2006 John M Bell + * + * This file is part of NetSurf, http://www.netsurf-browser.org/ + * + * NetSurf is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * NetSurf 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file + * Unified cookie database public interface. + */ + +#ifndef _NETSURF_COOKIE_DB_H_ +#define _NETSURF_COOKIE_DB_H_ + +#include +#include + +enum cookie_version { + COOKIE_NETSCAPE = 0, + COOKIE_RFC2109 = 1, + COOKIE_RFC2965 = 2 +}; + +struct cookie_data { + const struct cookie_data *prev; /**< Previous in list */ + const struct cookie_data *next; /**< Next in list */ + + const char *name; /**< Cookie name */ + const char *value; /**< Cookie value */ + const bool value_was_quoted; /**< Value was quoted in Set-Cookie: */ + const char *comment; /**< Cookie comment */ + const bool domain_from_set; /**< Domain came from Set-Cookie: header */ + const char *domain; /**< Domain */ + const bool path_from_set; /**< Path came from Set-Cookie: header */ + const char *path; /**< Path */ + const time_t expires; /**< Expiry timestamp, or 1 for session */ + const time_t last_used; /**< Last used time */ + const bool secure; /**< Only send for HTTPS requests */ + const bool http_only; /**< Only expose to HTTP(S) requests */ + enum cookie_version version; /**< Specification compliance */ + + /** Never destroy this cookie, unless it's expired */ + const bool no_destroy; +}; + +/** + * Iterate over all cookies in database + * + * \param callback Function to callback for each entry + */ +void urldb_iterate_cookies(bool (*callback)(const struct cookie_data *cookie)); + +/** + * Delete a cookie + * + * \param domain The cookie's domain + * \param path The cookie's path + * \param name The cookie's name + */ +void urldb_delete_cookie(const char *domain, const char *path, const char *name); + +/** + * Load a cookie file into the database + * + * \param filename File to load + */ +void urldb_load_cookies(const char *filename); + +/** + * Save persistent cookies to file + * + * \param filename Path to save to + */ +void urldb_save_cookies(const char *filename); + + + +#endif diff --git a/include/netsurf/url_db.h b/include/netsurf/url_db.h new file mode 100644 index 000000000..be2c656ff --- /dev/null +++ b/include/netsurf/url_db.h @@ -0,0 +1,130 @@ +/* + * Copyright 2006 John M Bell + * + * This file is part of NetSurf, http://www.netsurf-browser.org/ + * + * NetSurf is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * NetSurf 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file + * Unified URL information database public interface + */ + +#ifndef _NETSURF_URL_DB_H_ +#define _NETSURF_URL_DB_H_ + +#include +#include + +#include "utils/errors.h" +#include "netsurf/content_type.h" + +struct nsurl; +struct bitmap; + +struct url_data { + const char *title; /**< Resource title */ + unsigned int visits; /**< Visit count */ + time_t last_visit; /**< Last visit time */ + content_type type; /**< Type of resource */ +}; + + +/** + * Import an URL database from file, replacing any existing database + * + * \param filename Name of file containing data + */ +nserror urldb_load(const char *filename); + + +/** + * Export the current database to file + * + * \param filename Name of file to export to + */ +nserror urldb_save(const char *filename); + + +/** + * Set authentication data for an URL + * + * \param url The URL to consider + * \param realm The authentication realm + * \param auth The authentication details (in form username:password) + */ +void urldb_set_auth_details(struct nsurl *url, const char *realm, const char *auth); + + +/** + * Look up authentication details in database + * + * \param url Absolute URL to search for + * \param realm When non-NULL, it is realm which can be used to determine + * the protection space when that's not been done before for given URL. + * \return Pointer to authentication details, or NULL if not found + */ +const char *urldb_get_auth_details(struct nsurl *url, const char *realm); + + +/** + * Iterate over entries in the database which match the given prefix + * + * \param prefix Prefix to match + * \param callback Callback function + */ +void urldb_iterate_partial(const char *prefix, bool (*callback)(struct nsurl *url, const struct url_data *data)); + + +/** + * Iterate over all entries in database + * + * \param callback Function to callback for each entry + */ +void urldb_iterate_entries(bool (*callback)(struct nsurl *url, const struct url_data *data)); + + +/** + * Retrieve thumbnail data for given URL + * + * \param url Absolute URL to search for + * \return Pointer to thumbnail data, or NULL if not found. + */ +struct bitmap *urldb_get_thumbnail(struct nsurl *url); + + +/** + * Find data for an URL. + * + * \param url Absolute URL to look for + * \return Pointer to result struct, or NULL + */ +const struct url_data *urldb_get_url_data(struct nsurl *url); + + +/** + * Set certificate verification permissions + * + * \param url URL to consider + * \param permit Set to true to allow invalid certificates + */ +void urldb_set_cert_permissions(struct nsurl *url, bool permit); + + +/** + * Dump URL database to stderr + */ +void urldb_dump(void); + +#endif -- cgit v1.2.3