/* * Copyright 2011 Vincent Sanders * * This file is part of NetSurf. * * 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 . */ /* about: URL handling. * * Based on the data fetcher by Rob Kendrick * This fetcher provides a simple scheme for the user to access * information from the browser from a known, fixed URL. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "utils/config.h" #include "content/dirlist.h" #include "content/fetch.h" #include "content/fetchers/about.h" #include "content/urldb.h" #include "desktop/netsurf.h" #include "desktop/options.h" #include "utils/log.h" #include "utils/messages.h" #include "utils/url.h" #include "utils/utils.h" #include "utils/ring.h" #include "utils/testament.h" #include "image/image_cache.h" struct fetch_about_context; typedef bool (*fetch_about_handler)(struct fetch_about_context *); /** Context for an about fetch */ struct fetch_about_context { struct fetch_about_context *r_next, *r_prev; struct fetch *fetchh; /**< Handle for this fetch */ bool aborted; /**< Flag indicating fetch has been aborted */ bool locked; /**< Flag indicating entry is already entered */ nsurl *url; /**< The full url the fetch refers to */ fetch_about_handler handler; }; static struct fetch_about_context *ring = NULL; /** issue fetch callbacks with locking */ static inline bool fetch_about_send_callback(const fetch_msg *msg, struct fetch_about_context *ctx) { ctx->locked = true; fetch_send_callback(msg, ctx->fetchh); ctx->locked = false; return ctx->aborted; } static bool fetch_about_send_header(struct fetch_about_context *ctx, const char *fmt, ...) { char header[64]; fetch_msg msg; va_list ap; va_start(ap, fmt); vsnprintf(header, sizeof header, fmt, ap); va_end(ap); msg.type = FETCH_HEADER; msg.data.header_or_data.buf = (const uint8_t *) header; msg.data.header_or_data.len = strlen(header); fetch_about_send_callback(&msg, ctx); return ctx->aborted; } static bool fetch_about_blank_handler(struct fetch_about_context *ctx) { fetch_msg msg; const char buffer[2] = { ' ', '\0' }; /* content is going to return ok */ fetch_set_http_code(ctx->fetchh, 200); /* content type */ if (fetch_about_send_header(ctx, "Content-Type: text/html")) goto fetch_about_blank_handler_aborted; msg.type = FETCH_DATA; msg.data.header_or_data.buf = (const uint8_t *) buffer; msg.data.header_or_data.len = strlen(buffer); if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_blank_handler_aborted; msg.type = FETCH_FINISHED; fetch_about_send_callback(&msg, ctx); return true; fetch_about_blank_handler_aborted: return false; } static bool fetch_about_credits_handler(struct fetch_about_context *ctx) { fetch_msg msg; /* content is going to return redirect */ fetch_set_http_code(ctx->fetchh, 302); msg.type = FETCH_REDIRECT; msg.data.redirect = "resource:credits.html"; fetch_about_send_callback(&msg, ctx); return true; } static bool fetch_about_licence_handler(struct fetch_about_context *ctx) { fetch_msg msg; /* content is going to return redirect */ fetch_set_http_code(ctx->fetchh, 302); msg.type = FETCH_REDIRECT; msg.data.redirect = "resource:licence.html"; fetch_about_send_callback(&msg, ctx); return true; } /** Handler to generate about:cache page. * * Shows details of current iamge cache * */ static bool fetch_about_imagecache_handler(struct fetch_about_context *ctx) { fetch_msg msg; char buffer[2048]; /* output buffer */ int code = 200; int slen; unsigned int cent_loop = 0; int res = 0; /* content is going to return ok */ fetch_set_http_code(ctx->fetchh, code); /* content type */ if (fetch_about_send_header(ctx, "Content-Type: text/html")) goto fetch_about_imagecache_handler_aborted; msg.type = FETCH_DATA; msg.data.header_or_data.buf = (const uint8_t *) buffer; /* page head */ slen = snprintf(buffer, sizeof buffer, "\n\n" "NetSurf Browser Image Cache Status\n" "\n" "\n" "\n" "

" "" "\"NetSurf\"" "

\n" "

NetSurf Browser Image Cache Status

\n" ); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_imagecache_handler_aborted; /* image cache summary */ slen = image_cache_snsummaryf(buffer, sizeof(buffer), "

Configured limit of %a hysteresis of %b" "

Total bitmap size in use %c (in %d)" "

Age %es" "

Peak size %f (in %g)" "

Peak image count %h (size %i)" "

Cache total/hit/miss/fail (counts) %j/%k/%l/%m " "(%pj%%/%pk%%/%pl%%/%pm%%)" "

Cache total/hit/miss/fail (size) %n/%o/%q/%r " "(%pn%%/%po%%/%pq%%/%pr%%)" "

Total images never rendered: %s " "(includes %t that were converted)" "

Total number of excessive conversions: %u " "(from %v images converted more than once)" "

Bitmap of size %w had most (%x) conversions"); if (slen >= (int) (sizeof(buffer))) goto fetch_about_imagecache_handler_aborted; /* overflow */ msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_imagecache_handler_aborted; /* image cache entry table */ slen = snprintf(buffer, sizeof buffer, "\n" "" "" "" "" "" "" "" "\n"); do { res = image_cache_snentryf(buffer + slen, sizeof buffer - slen, cent_loop, "\n"); if (res <= 0) break; /* last option */ if (res >= (int) (sizeof buffer - slen)) { /* last entry would not fit in buffer, submit buffer */ msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_imagecache_handler_aborted; slen = 0; } else { /* normal addition */ slen += res; cent_loop++; } } while (res > 0); slen += snprintf(buffer + slen, sizeof buffer - slen, "
EntryContent KeyRedraw CountConversion CountLast RedrawBitmap AgeBitmap SizeSource URL
%e%k%r%c%a%g%s%U
\n\n\n"); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_imagecache_handler_aborted; msg.type = FETCH_FINISHED; fetch_about_send_callback(&msg, ctx); return true; fetch_about_imagecache_handler_aborted: return false; } /** Handler to generate about:config page */ static bool fetch_about_config_handler(struct fetch_about_context *ctx) { fetch_msg msg; char buffer[1024]; int code = 200; int slen; unsigned int opt_loop = 0; int res = 0; /* content is going to return ok */ fetch_set_http_code(ctx->fetchh, code); /* content type */ if (fetch_about_send_header(ctx, "Content-Type: text/html")) goto fetch_about_config_handler_aborted; msg.type = FETCH_DATA; msg.data.header_or_data.buf = (const uint8_t *) buffer; slen = snprintf(buffer, sizeof buffer, "\n\n" "NetSurf Browser Config\n" "\n" "\n" "\n" "

" "" "\"NetSurf\"" "

\n" "

NetSurf Browser Config

\n" "\n" "\n"); do { res = nsoption_snoptionf(buffer + slen, sizeof buffer - slen, opt_loop, "\n"); if (res <= 0) break; /* last option */ if (res >= (int) (sizeof buffer - slen)) { /* last entry would not fit in buffer, submit buffer */ msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_config_handler_aborted; slen = 0; } else { /* normal addition */ slen += res; opt_loop++; } } while (res > 0); slen += snprintf(buffer + slen, sizeof buffer - slen, "
%k%t%V
\n\n\n"); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_config_handler_aborted; msg.type = FETCH_FINISHED; fetch_about_send_callback(&msg, ctx); return true; fetch_about_config_handler_aborted: return false; } /** Generate the text of a Choices file which represents the current * in use options. */ static bool fetch_about_choices_handler(struct fetch_about_context *ctx) { fetch_msg msg; char buffer[1024]; int code = 200; int slen; unsigned int opt_loop = 0; int res = 0; /* content is going to return ok */ fetch_set_http_code(ctx->fetchh, code); /* content type */ if (fetch_about_send_header(ctx, "Content-Type: text/plain")) goto fetch_about_choices_handler_aborted; msg.type = FETCH_DATA; msg.data.header_or_data.buf = (const uint8_t *) buffer; slen = snprintf(buffer, sizeof buffer, "# Automatically generated current NetSurf browser Choices\n"); do { res = nsoption_snoptionf(buffer + slen, sizeof buffer - slen, opt_loop, "%k:%v\n"); if (res <= 0) break; /* last option */ if (res >= (int) (sizeof buffer - slen)) { /* last entry would not fit in buffer, submit buffer */ msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_choices_handler_aborted; slen = 0; } else { /* normal addition */ slen += res; opt_loop++; } } while (res > 0); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_choices_handler_aborted; msg.type = FETCH_FINISHED; fetch_about_send_callback(&msg, ctx); return true; fetch_about_choices_handler_aborted: return false; } /** Generate the text of an svn testament which represents the current * build-tree status */ typedef struct { const char *leaf; const char modtype; } modification_t; static bool fetch_about_testament_handler(struct fetch_about_context *ctx) { static modification_t modifications[] = WT_MODIFICATIONS; fetch_msg msg; char buffer[1024]; int code = 200; int slen; int i; /* content is going to return ok */ fetch_set_http_code(ctx->fetchh, code); /* content type */ if (fetch_about_send_header(ctx, "Content-Type: text/plain")) goto fetch_about_testament_handler_aborted; msg.type = FETCH_DATA; msg.data.header_or_data.buf = (const uint8_t *) buffer; slen = snprintf(buffer, sizeof buffer, "# Automatically generated by NetSurf build system\n\n"); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_testament_handler_aborted; slen = snprintf(buffer, sizeof buffer, #if defined(WT_BRANCHISTRUNK) "# This is a *DEVELOPMENT* build from the trunk.\n\n" #elif defined(WT_BRANCHISRELEASE) "# This is a release build of NetSurf\n\n" #elif defined(WT_NO_SVN) "# This NetSurf was built outside of our revision " "control environment.\n" "# This testament is therefore very useful.\n\n" #else "# This NetSurf was built from a branch.\n\n" #endif ); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_testament_handler_aborted; slen = snprintf(buffer, sizeof buffer, "Built by %s (%s) from %s at revision %s\n\n", GECOS, USERNAME, WT_BRANCHPATH, WT_REVID); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_testament_handler_aborted; slen = snprintf(buffer, sizeof buffer, "Built on %s in %s\n\n", WT_HOSTNAME, WT_ROOT); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_testament_handler_aborted; if (WT_MODIFIED > 0) { slen = snprintf(buffer, sizeof buffer, "Working tree has %d modification%s\n\n", WT_MODIFIED, WT_MODIFIED == 1 ? "" : "s"); } else { slen = snprintf(buffer, sizeof buffer, "Working tree is not modified.\n"); } msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_testament_handler_aborted; for (i = 0; i < WT_MODIFIED; ++i) { slen = snprintf(buffer, sizeof buffer, " %c %s\n", modifications[i].modtype, modifications[i].leaf); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_testament_handler_aborted; } msg.type = FETCH_FINISHED; fetch_about_send_callback(&msg, ctx); return true; fetch_about_testament_handler_aborted: return false; } static bool fetch_about_logo_handler(struct fetch_about_context *ctx) { fetch_msg msg; /* content is going to return redirect */ fetch_set_http_code(ctx->fetchh, 302); msg.type = FETCH_REDIRECT; msg.data.redirect = "resource:netsurf.png"; fetch_about_send_callback(&msg, ctx); return true; } /* Forward declaration because this handler requires the handler table. */ static bool fetch_about_about_handler(struct fetch_about_context *ctx); struct about_handlers { const char *name; /**< name to match in url */ int name_len; lwc_string *lname; /**< Interned name */ fetch_about_handler handler; /* handler for the url */ bool hidden; /* Flag indicating if entry should be show in listing */ }; /** List of about paths and their handlers */ struct about_handlers about_handler_list[] = { { "credits", SLEN("credits"), NULL, fetch_about_credits_handler, false }, { "licence", SLEN("licence"), NULL, fetch_about_licence_handler, false }, { "license", SLEN("license"), NULL, fetch_about_licence_handler, true }, { "config", SLEN("config"), NULL, fetch_about_config_handler, false }, { "Choices", SLEN("Choices"), NULL, fetch_about_choices_handler, false }, { "testament", SLEN("testament"), NULL, fetch_about_testament_handler, false }, { "about", SLEN("about"), NULL, fetch_about_about_handler, true }, { "logo", SLEN("logo"), NULL, fetch_about_logo_handler, true }, /* details about the cache */ { "imagecache", SLEN("imagecache"), NULL, fetch_about_imagecache_handler, false }, /* The default blank page */ { "blank", SLEN("blank"), NULL, fetch_about_blank_handler, true } }; #define about_handler_list_len (sizeof(about_handler_list) / sizeof(struct about_handlers)) /** * List all the valid about: paths available * * \param ctx The fetch context. * \return true for sucess or false to generate an error. */ static bool fetch_about_about_handler(struct fetch_about_context *ctx) { fetch_msg msg; char buffer[1024]; int code = 200; int slen; unsigned int abt_loop = 0; int res = 0; /* content is going to return ok */ fetch_set_http_code(ctx->fetchh, code); /* content type */ if (fetch_about_send_header(ctx, "Content-Type: text/html")) goto fetch_about_config_handler_aborted; msg.type = FETCH_DATA; msg.data.header_or_data.buf = (const uint8_t *) buffer; slen = snprintf(buffer, sizeof buffer, "\n\n" "NetSurf List of About pages\n" "\n" "\n" "\n" "

" "" "\"NetSurf\"" "

\n" "

NetSurf List of About pages

\n" "
    \n"); for (abt_loop = 0; abt_loop < about_handler_list_len; abt_loop++) { /* Skip over hidden entries */ if (about_handler_list[abt_loop].hidden) continue; res = snprintf(buffer + slen, sizeof buffer - slen, "
  • about:%s
    • \n", about_handler_list[abt_loop].name, about_handler_list[abt_loop].name); if (res <= 0) break; /* last option */ if (res >= (int)(sizeof buffer - slen)) { /* last entry would not fit in buffer, submit buffer */ msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_config_handler_aborted; slen = 0; } else { /* normal addition */ slen += res; } } slen += snprintf(buffer + slen, sizeof buffer - slen, "
\n\n\n"); msg.data.header_or_data.len = slen; if (fetch_about_send_callback(&msg, ctx)) goto fetch_about_config_handler_aborted; msg.type = FETCH_FINISHED; fetch_about_send_callback(&msg, ctx); return true; fetch_about_config_handler_aborted: return false; } /** callback to initialise the about fetcher. */ static bool fetch_about_initialise(lwc_string *scheme) { unsigned int abt_loop = 0; lwc_error error; for (abt_loop = 0; abt_loop < about_handler_list_len; abt_loop++) { error = lwc_intern_string(about_handler_list[abt_loop].name, about_handler_list[abt_loop].name_len, &about_handler_list[abt_loop].lname); if (error != lwc_error_ok) { while (abt_loop-- != 0) { lwc_string_unref(about_handler_list[abt_loop].lname); } return false; } } return true; } /** callback to finalise the about fetcher. */ static void fetch_about_finalise(lwc_string *scheme) { unsigned int abt_loop = 0; for (abt_loop = 0; abt_loop < about_handler_list_len; abt_loop++) { lwc_string_unref(about_handler_list[abt_loop].lname); } } static bool fetch_about_can_fetch(const nsurl *url) { return true; } /** callback to set up a about fetch context. */ static void * fetch_about_setup(struct fetch *fetchh, nsurl *url, bool only_2xx, const char *post_urlenc, const struct fetch_multipart_data *post_multipart, const char **headers) { struct fetch_about_context *ctx; unsigned int handler_loop; lwc_string *path; bool match; ctx = calloc(1, sizeof(*ctx)); if (ctx == NULL) return NULL; path = nsurl_get_component(url, NSURL_PATH); for (handler_loop = 0; handler_loop < about_handler_list_len; handler_loop++) { ctx->handler = about_handler_list[handler_loop].handler; if (lwc_string_isequal(path, about_handler_list[handler_loop].lname, &match) == lwc_error_ok && match) { break; } } if (path != NULL) lwc_string_unref(path); ctx->fetchh = fetchh; ctx->url = nsurl_ref(url); RING_INSERT(ring, ctx); return ctx; } /** callback to free a about fetch */ static void fetch_about_free(void *ctx) { struct fetch_about_context *c = ctx; nsurl_unref(c->url); RING_REMOVE(ring, c); free(ctx); } /** callback to start a about fetch */ static bool fetch_about_start(void *ctx) { return true; } /** callback to abort a about fetch */ static void fetch_about_abort(void *ctx) { struct fetch_about_context *c = ctx; /* To avoid the poll loop having to deal with the fetch context * disappearing from under it, we simply flag the abort here. * The poll loop itself will perform the appropriate cleanup. */ c->aborted = true; } /** callback to poll for additional about fetch contents */ static void fetch_about_poll(lwc_string *scheme) { struct fetch_about_context *c, *next; if (ring == NULL) return; /* Iterate over ring, processing each pending fetch */ c = ring; do { /* Ignore fetches that have been flagged as locked. * This allows safe re-entrant calls to this function. * Re-entrancy can occur if, as a result of a callback, * the interested party causes fetch_poll() to be called * again. */ if (c->locked == true) { next = c->r_next; continue; } /* Only process non-aborted fetches */ if (c->aborted == false) { /* about fetches can be processed in one go */ c->handler(c); } /* Compute next fetch item at the last possible moment * as processing this item may have added to the ring */ next = c->r_next; fetch_remove_from_queues(c->fetchh); fetch_free(c->fetchh); /* Advance to next ring entry, exiting if we've reached * the start of the ring or the ring has become empty */ } while ( (c = next) != ring && ring != NULL); } void fetch_about_register(void) { lwc_string *scheme; if (lwc_intern_string("about", SLEN("about"), &scheme) != lwc_error_ok) { die("Failed to initialise the fetch module " "(couldn't intern \"about\")."); } fetch_add_fetcher(scheme, fetch_about_initialise, fetch_about_can_fetch, fetch_about_setup, fetch_about_start, fetch_about_abort, fetch_about_free, fetch_about_poll, fetch_about_finalise); }