msplit public url database API out for frontends

This commit is contained in:
Vincent Sanders 2016-06-13 23:34:45 +01:00
parent 22d84a587b
commit 976eca9958
28 changed files with 296 additions and 218 deletions

View File

@ -23,7 +23,8 @@
#include "utils/nsoption.h"
#include "utils/corestrings.h"
#include "utils/log.h"
#include "content/urldb.h"
#include "utils/nsurl.h"
#include "netsurf/url_db.h"
#include "desktop/system_colour.h"
#include "css/internal.h"

View File

@ -104,6 +104,7 @@
#include "utils/utils.h"
#include "utils/bloom.h"
#include "utils/time.h"
#include "utils/nsurl.h"
#include "netsurf/bitmap.h"
#include "desktop/cookie_manager.h"
#include "desktop/gui_internal.h"
@ -112,6 +113,9 @@
#include "content/urldb.h"
struct cookie_internal_data {
struct cookie_internal_data *prev; /**< Previous in list */
struct cookie_internal_data *next; /**< Next in list */
char *name; /**< Cookie name */
char *value; /**< Cookie value */
bool value_was_quoted; /**< Value was quoted in Set-Cookie: */
@ -124,12 +128,10 @@ struct cookie_internal_data {
time_t last_used; /**< Last used time */
bool secure; /**< Only send for HTTPS requests */
bool http_only; /**< Only expose to HTTP(S) requests */
cookie_version version; /**< Specification compliance */
enum cookie_version version; /**< Specification compliance */
bool no_destroy; /**< Never destroy this cookie,
* unless it's expired */
struct cookie_internal_data *prev; /**< Previous in list */
struct cookie_internal_data *next; /**< Next in list */
};
/* A protection space is defined as a tuple canonical_root_url and realm.

View File

@ -16,54 +16,18 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \file
* Unified URL information database (interface)
/**
* \file
* Unified URL information database internal interface.
*/
#ifndef _NETSURF_CONTENT_URLDB_H_
#define _NETSURF_CONTENT_URLDB_H_
#include <stdbool.h>
#include <time.h>
#include <libwapcaplet/libwapcaplet.h>
#include "utils/nsurl.h"
#include "netsurf/content_type.h"
typedef enum {
COOKIE_NETSCAPE = 0,
COOKIE_RFC2109 = 1,
COOKIE_RFC2965 = 2
} cookie_version;
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 */
};
struct cookie_data {
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 */
cookie_version version; /**< Specification compliance */
const bool no_destroy; /**< Never destroy this cookie,
* unless it's expired */
const struct cookie_data *prev; /**< Previous in list */
const struct cookie_data *next; /**< Next in list */
};
struct bitmap;
#include "netsurf/url_db.h"
#include "netsurf/cookie_db.h"
/**
* Destroy urldb
@ -71,51 +35,32 @@ struct bitmap;
void urldb_destroy(void);
/* Persistence support */
/**
* 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 the cross-session persistence of the entry for an URL
*
* \param url Absolute URL to persist
* \param persist True to persist, false otherwise
*/
void urldb_set_url_persistence(nsurl *url, bool persist);
void urldb_set_url_persistence(struct nsurl *url, bool persist);
/* URL insertion */
/**
* Insert an URL into the database
*
* \param url Absolute URL to insert
* \return true on success, false otherwise
*/
bool urldb_add_url(nsurl *url);
bool urldb_add_url(struct nsurl *url);
/* URL data modification / lookup */
/**
* Set an URL's title string, replacing any existing one
*
* \param url The URL to look for
* \param title The title string to use (copied)
*/
void urldb_set_url_title(nsurl *url, const char *title);
void urldb_set_url_title(struct nsurl *url, const char *title);
/**
* Set an URL's content type
@ -123,29 +68,24 @@ void urldb_set_url_title(nsurl *url, const char *title);
* \param url The URL to look for
* \param type The type to set
*/
void urldb_set_url_content_type(nsurl *url, content_type type);
void urldb_set_url_content_type(struct nsurl *url, content_type type);
/**
* Update an URL's visit data
*
* \param url The URL to update
*/
void urldb_update_url_visit_data(nsurl *url);
void urldb_update_url_visit_data(struct nsurl *url);
/**
* Reset an URL's visit statistics
*
* \param url The URL to reset
*/
void urldb_reset_url_visit_data(nsurl *url);
void urldb_reset_url_visit_data(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(nsurl *url);
/**
* Extract an URL from the db
@ -153,41 +93,9 @@ const struct url_data *urldb_get_url_data(nsurl *url);
* \param url URL to extract
* \return Pointer to database's copy of URL or NULL if not found
*/
nsurl *urldb_get_url(nsurl *url);
struct nsurl *urldb_get_url(struct nsurl *url);
/* Authentication modification / lookup */
/**
* 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(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(nsurl *url, const char *realm);
/* SSL certificate permissions */
/**
* Set certificate verification permissions
*
* \param url URL to consider
* \param permit Set to true to allow invalid certificates
*/
void urldb_set_cert_permissions(nsurl *url, bool permit);
/**
* Retrieve certificate verification permissions from database
*
@ -195,59 +103,17 @@ void urldb_set_cert_permissions(nsurl *url, bool permit);
* \return true to permit connections to hosts with invalid certificates,
* false otherwise.
*/
bool urldb_get_cert_permissions(nsurl *url);
bool urldb_get_cert_permissions(struct nsurl *url);
/* Thumbnail handling */
/**
* Set thumbnail for url, replacing any existing thumbnail
*
* \param url Absolute URL to consider
* \param bitmap Opaque pointer to thumbnail data, or NULL to invalidate
*/
void urldb_set_thumbnail(nsurl *url, struct bitmap *bitmap);
void urldb_set_thumbnail(struct nsurl *url, struct bitmap *bitmap);
/**
* 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(nsurl *url);
/* URL completion */
/**
* 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)(nsurl *url, const struct url_data *data));
/* Iteration */
/**
* Iterate over all entries in database
*
* \param callback Function to callback for each entry
*/
void urldb_iterate_entries(bool (*callback)(nsurl *url,
const struct url_data *data));
/**
* 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));
/* Cookies */
/**
* Parse Set-Cookie header and insert cookie(s) into database
@ -257,7 +123,8 @@ void urldb_iterate_cookies(bool (*callback)(const struct cookie_data *cookie));
* \param referer Referring resource, or 0 for verifiable transaction
* \return true on success, false otherwise
*/
bool urldb_set_cookie(const char *header, nsurl *url, nsurl *referer);
bool urldb_set_cookie(const char *header, struct nsurl *url, struct nsurl *referer);
/**
* Retrieve cookies for an URL
@ -266,41 +133,8 @@ bool urldb_set_cookie(const char *header, nsurl *url, nsurl *referer);
* \param include_http_only Whether to include HTTP(S) only cookies.
* \return Cookies string for libcurl (on heap), or NULL on error/no cookies
*/
char *urldb_get_cookie(nsurl *url, bool include_http_only);
char *urldb_get_cookie(struct nsurl *url, bool include_http_only);
/**
* 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);
/* Debug */
/**
* Dump URL database to stderr
*/
void urldb_dump(void);
/* test harness only */
/**
* Add a host to the database, creating any intermediate entries
@ -310,6 +144,7 @@ void urldb_dump(void);
*/
struct host_part *urldb_add_host(const char *host);
/**
* Add a path to the database, creating any intermediate entries
*
@ -323,6 +158,7 @@ struct host_part *urldb_add_host(const char *host);
*/
struct path_data *urldb_add_path(lwc_string *scheme, unsigned int port,
const struct host_part *host, char *path_query,
lwc_string *fragment, nsurl *url);
lwc_string *fragment, struct nsurl *url);
#endif

View File

@ -19,12 +19,14 @@
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include "utils/messages.h"
#include "utils/utils.h"
#include "utils/utf8.h"
#include "utils/libdom.h"
#include "utils/log.h"
#include "utils/nsurl.h"
#include "content/urldb.h"
#include "desktop/global_history.h"

View File

@ -31,6 +31,7 @@
#include "utils/utf8.h"
#include "utils/libdom.h"
#include "utils/log.h"
#include "utils/nsurl.h"
#include "content/urldb.h"
#include "netsurf/misc.h"

View File

@ -103,9 +103,10 @@
#include "netsurf/netsurf.h"
#include "netsurf/content.h"
#include "netsurf/browser_window.h"
#include "netsurf/cookie_db.h"
#include "netsurf/url_db.h"
#include "content/backing_store.h"
#include "content/fetchers.h"
#include "content/urldb.h"
#include "desktop/browser_history.h"
#include "desktop/hotlist.h"
#include "desktop/version.h"

View File

@ -39,10 +39,10 @@
#include <reaction/reaction_macros.h>
#include "utils/messages.h"
#include "utils/errors.h"
#include "content/urldb.h"
#include "utils/nsurl.h"
#include "netsurf/mouse.h"
#include "netsurf/window.h"
#include "netsurf/url_db.h"
#include "amiga/gui.h"
#include "amiga/libs.h"

View File

@ -26,10 +26,11 @@
#include "amiga/os3support.h"
#include "urlhistory.h"
#include "content/urldb.h"
#include "utils/nsoption.h"
#include "utils/nsurl.h"
#include "netsurf/url_db.h"
#include "urlhistory.h"
static struct List PageList;

View File

@ -55,7 +55,6 @@
#include "utils/messages.h"
#include "netsurf/browser_window.h"
#include "netsurf/window.h"
#include "content/urldb.h"
#include "content/llcache.h"
#include "desktop/cookie_manager.h"
#include "desktop/global_history.h"

View File

@ -37,7 +37,8 @@
#include "netsurf/misc.h"
#include "netsurf/netsurf.h"
#include "netsurf/content.h"
#include "content/urldb.h"
#include "netsurf/cookie_db.h"
#include "netsurf/url_db.h"
#include "content/backing_store.h"
#include "desktop/treeview.h"

View File

@ -24,7 +24,7 @@ extern "C" {
#include "utils/log.h"
#include "netsurf/mouse.h"
#include "netsurf/plotters.h"
#include "content/urldb.h"
#include "netsurf/cookie_db.h"
#include "desktop/cookie_manager.h"
#include "desktop/tree.h"
#include "desktop/textinput.h"

View File

@ -54,6 +54,7 @@ extern "C" {
#include "utils/corestrings.h"
#include "utils/utf8.h"
#include "utils/utils.h"
#include "utils/nsurl.h"
#include "netsurf/misc.h"
#include "netsurf/clipboard.h"
#include "netsurf/search.h"
@ -61,8 +62,9 @@ extern "C" {
#include "netsurf/netsurf.h"
#include "netsurf/content.h"
#include "netsurf/browser_window.h"
#include "netsurf/cookie_db.h"
#include "netsurf/url_db.h"
#include "content/fetchers.h"
#include "content/urldb.h"
}

View File

@ -39,13 +39,14 @@ extern "C" {
#include "utils/log.h"
#include "utils/utf8.h"
#include "utils/utils.h"
#include "utils/nsurl.h"
#include "netsurf/content_type.h"
#include "netsurf/browser_window.h"
#include "netsurf/mouse.h"
#include "netsurf/plotters.h"
#include "netsurf/window.h"
#include "netsurf/clipboard.h"
#include "content/urldb.h"
#include "netsurf/url_db.h"
#include "desktop/textinput.h"
}

View File

@ -32,11 +32,13 @@
#import "utils/messages.h"
#import "utils/utils.h"
#import "utils/nsoption.h"
#import "utils/nsurl.h"
#import "netsurf/plotters.h"
#import "netsurf/mouse.h"
#import "netsurf/netsurf.h"
#import "netsurf/browser_window.h"
#import "content/urldb.h"
#import "netsurf/cookie_db.h"
#import "netsurf/url_db.h"
#import "desktop/save_complete.h"
#import "desktop/textinput.h"
#import "desktop/tree.h"

View File

@ -18,7 +18,8 @@
#import "cocoa/URLFieldCell.h"
#import "content/urldb.h"
#import "utils/nsurl.h"
#import "netsurf/url_db.h"
@interface URLFieldCell ()

View File

@ -41,7 +41,7 @@
#include "netsurf/window.h"
#include "netsurf/misc.h"
#include "netsurf/netsurf.h"
#include "content/urldb.h"
#include "netsurf/cookie_db.h"
#include "content/fetch.h"
#include "framebuffer/gui.h"

View File

@ -26,9 +26,10 @@
#include "utils/log.h"
#include "utils/messages.h"
#include "utils/nsoption.h"
#include "content/urldb.h"
#include "desktop/searchweb.h"
#include "utils/nsurl.h"
#include "netsurf/url_db.h"
#include "netsurf/browser_window.h"
#include "desktop/searchweb.h"
#include "gtk/warn.h"
#include "gtk/scaffolding.h"

View File

@ -39,7 +39,8 @@
#include "utils/file.h"
#include "utils/nsoption.h"
#include "content/fetchers.h"
#include "content/urldb.h"
#include "netsurf/url_db.h"
#include "netsurf/cookie_db.h"
#include "content/backing_store.h"
#include "netsurf/browser_window.h"
#include "desktop/save_complete.h"

View File

@ -22,7 +22,7 @@
#include "utils/log.h"
#include "utils/nsurl.h"
#include "content/urldb.h"
#include "netsurf/url_db.h"
#include "gtk/resources.h"
#include "gtk/login.h"

View File

@ -33,7 +33,8 @@
#include "utils/nsurl.h"
#include "netsurf/misc.h"
#include "netsurf/netsurf.h"
#include "content/urldb.h"
#include "netsurf/url_db.h"
#include "netsurf/cookie_db.h"
#include "content/fetchers.h"
#include "monkey/dispatch.h"

View File

@ -26,7 +26,7 @@
#include "utils/log.h"
#include "utils/messages.h"
#include "utils/nsurl.h"
#include "content/urldb.h"
#include "netsurf/url_db.h"
#include "riscos/gui.h"
#include "riscos/dialog.h"

View File

@ -52,9 +52,10 @@
#include "netsurf/content.h"
#include "netsurf/netsurf.h"
#include "netsurf/browser_window.h"
#include "netsurf/cookie_db.h"
#include "netsurf/url_db.h"
#include "desktop/save_complete.h"
#include "desktop/treeview.h"
#include "content/urldb.h"
#include "content/backing_store.h"
#include "riscos/gui.h"

View File

@ -35,10 +35,11 @@
#include "utils/log.h"
#include "utils/messages.h"
#include "utils/nsoption.h"
#include "content/urldb.h"
#include "utils/nsurl.h"
#include "netsurf/url_db.h"
#include "netsurf/window.h"
#include "desktop/hotlist.h"
#include "desktop/tree.h"
#include "netsurf/window.h"
#include "riscos/gui.h"
#include "riscos/dialog.h"

View File

@ -30,7 +30,8 @@
#include "utils/log.h"
#include "utils/nsoption.h"
#include "content/urldb.h"
#include "utils/nsurl.h"
#include "netsurf/url_db.h"
#include "netsurf/browser_window.h"
#include "riscos/global_history.h"

View File

@ -26,7 +26,8 @@
#include <oslib/wimp.h>
#include "utils/messages.h"
#include "content/urldb.h"
#include "utils/nsurl.h"
#include "netsurf/url_db.h"
#include "riscos/menus.h"
#include "riscos/url_suggest.h"

View File

@ -51,12 +51,13 @@
#include "utils/utils.h"
#include "utils/messages.h"
#include "utils/string.h"
#include "utils/nsurl.h"
#include "netsurf/content.h"
#include "netsurf/browser_window.h"
#include "netsurf/plotters.h"
#include "netsurf/window.h"
#include "netsurf/bitmap.h"
#include "content/urldb.h"
#include "netsurf/url_db.h"
#include "desktop/browser_history.h"
#include "desktop/cookie_manager.h"
#include "desktop/scrollbar.h"

View File

@ -0,0 +1,90 @@
/*
* Copyright 2006 John M Bell <jmb202@ecs.soton.ac.uk>
*
* 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 <http://www.gnu.org/licenses/>.
*/
/**
* \file
* Unified cookie database public interface.
*/
#ifndef _NETSURF_COOKIE_DB_H_
#define _NETSURF_COOKIE_DB_H_
#include <stdbool.h>
#include <time.h>
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

130
include/netsurf/url_db.h Normal file
View File

@ -0,0 +1,130 @@
/*
* Copyright 2006 John M Bell <jmb202@ecs.soton.ac.uk>
*
* 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 <http://www.gnu.org/licenses/>.
*/
/**
* \file
* Unified URL information database public interface
*/
#ifndef _NETSURF_URL_DB_H_
#define _NETSURF_URL_DB_H_
#include <stdbool.h>
#include <time.h>
#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