1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
elinks/src/session/download.c

1231 lines
30 KiB
C
Raw Normal View History

/* Downloads managment */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifdef HAVE_SYS_CYGWIN_H
#include <sys/cygwin.h>
#endif
#include <sys/types.h>
#ifdef HAVE_FCNTL_H
#include <fcntl.h> /* OS/2 needs this after sys/types.h */
#endif
#include <sys/stat.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <utime.h>
#include "elinks.h"
#include "bfu/dialog.h"
#include "cache/cache.h"
#include "config/options.h"
#include "dialogs/document.h"
#include "dialogs/download.h"
#include "dialogs/menu.h"
#include "intl/gettext/libintl.h"
#include "main/object.h"
#include "mime/mime.h"
#include "network/connection.h"
#include "network/progress.h"
#include "network/state.h"
#include "osdep/osdep.h"
#include "protocol/bittorrent/dialogs.h"
#include "protocol/date.h"
#include "protocol/protocol.h"
#include "protocol/uri.h"
#include "session/download.h"
#include "session/history.h"
#include "session/location.h"
#include "session/session.h"
#include "session/task.h"
#include "terminal/draw.h"
#include "terminal/screen.h"
#include "terminal/terminal.h"
#include "util/conv.h"
#include "util/error.h"
#include "util/file.h"
#include "util/lists.h"
#include "util/memlist.h"
#include "util/memory.h"
#include "util/string.h"
#include "util/time.h"
/* TODO: tp_*() should be in separate file, I guess? --pasky */
INIT_LIST_HEAD(downloads);
int
download_is_progressing(struct download *download)
{
return download
&& download->state == S_TRANS
&& has_progress(download->progress);
}
int
are_there_downloads(void)
{
struct file_download *file_download;
foreach (file_download, downloads)
if (!file_download->external_handler)
return 1;
return 0;
}
static void download_data(struct download *download, struct file_download *file_download);
struct file_download *
init_file_download(struct uri *uri, struct session *ses, unsigned char *file, int fd)
{
struct file_download *file_download;
file_download = mem_calloc(1, sizeof(*file_download));
if (!file_download) return NULL;
/* Actually we could allow fragments in the URI and just change all the
* places that compares and shows the URI, but for now it is much
* easier this way. */
file_download->uri = get_composed_uri(uri, URI_BASE);
if (!file_download->uri) {
mem_free(file_download);
return NULL;
}
init_download_display(file_download);
file_download->file = file;
file_download->handle = fd;
file_download->download.callback = (download_callback_T *) download_data;
file_download->download.data = file_download;
file_download->ses = ses;
/* The tab may be closed, but we will still want to ie. open the
* handler on that terminal. */
file_download->term = ses->tab->term;
object_nolock(file_download, "file_download"); /* Debugging purpose. */
add_to_list(downloads, file_download);
return file_download;
}
void
abort_download(struct file_download *file_download)
{
#if 0
/* When hacking to cleanup the download code, remove lots of duplicated
* code and implement stuff from bug 435 we should reintroduce this
* assertion. Currently it will trigger often and shows that the
* download dialog code potentially could access free()d memory. */
assert(!is_object_used(file_download));
#endif
done_download_display(file_download);
if (file_download->ses)
check_questions_queue(file_download->ses);
if (file_download->dlg_data)
cancel_dialog(file_download->dlg_data, NULL);
cancel_download(&file_download->download, file_download->stop);
if (file_download->uri) done_uri(file_download->uri);
if (file_download->handle != -1) {
prealloc_truncate(file_download->handle, file_download->seek);
close(file_download->handle);
}
mem_free_if(file_download->external_handler);
if (file_download->file) {
if (file_download->delete) unlink(file_download->file);
mem_free(file_download->file);
}
del_from_list(file_download);
mem_free(file_download);
}
static void
kill_downloads_to_file(unsigned char *file)
{
struct file_download *file_download;
foreach (file_download, downloads) {
if (strcmp(file_download->file, file))
continue;
file_download = file_download->prev;
abort_download(file_download->next);
}
}
void
abort_all_downloads(void)
{
while (!list_empty(downloads))
abort_download(downloads.next);
}
void
destroy_downloads(struct session *ses)
{
struct file_download *file_download, *next;
struct session *s;
/* We are supposed to blat all downloads to external handlers belonging
* to @ses, but we will refuse to do so if there is another session
* bound to this terminal. That looks like the reasonable thing to do,
* fulfilling the principle of least astonishment. */
foreach (s, sessions) {
if (s == ses || s->tab->term != ses->tab->term)
continue;
foreach (file_download, downloads) {
if (file_download->ses != ses)
continue;
file_download->ses = s;
}
return;
}
foreachsafe (file_download, next, downloads) {
if (file_download->ses != ses)
continue;
if (!file_download->external_handler) {
file_download->ses = NULL;
continue;
}
abort_download(file_download);
}
}
static void
download_error_dialog(struct file_download *file_download, int saved_errno)
{
unsigned char *emsg = (unsigned char *) strerror(saved_errno);
struct session *ses = file_download->ses;
struct terminal *term = file_download->term;
if (!ses) return;
info_box(term, MSGBOX_FREE_TEXT,
N_("Download error"), ALIGN_CENTER,
msg_text(term, N_("Could not create file '%s':\n%s"),
file_download->file, emsg));
}
static int
write_cache_entry_to_file(struct cache_entry *cached, struct file_download *file_download)
{
struct fragment *frag;
if (file_download->download.progress && file_download->download.progress->seek) {
file_download->seek = file_download->download.progress->seek;
file_download->download.progress->seek = 0;
/* This is exclusive with the prealloc, thus we can perform
* this in front of that thing safely. */
if (lseek(file_download->handle, file_download->seek, SEEK_SET) < 0) {
download_error_dialog(file_download, errno);
return 0;
}
}
foreach (frag, cached->frag) {
off_t remain = file_download->seek - frag->offset;
int *h = &file_download->handle;
ssize_t w;
if (remain < 0 || frag->length <= remain)
continue;
#ifdef USE_OPEN_PREALLOC
if (!file_download->seek
&& (!file_download->download.progress
|| file_download->download.progress->size > 0)) {
close(*h);
*h = open_prealloc(file_download->file,
O_CREAT|O_WRONLY|O_TRUNC,
0666,
file_download->download.progress
? file_download->download.progress->size
: cached->length);
if (*h == -1) {
download_error_dialog(file_download, errno);
return 0;
}
set_bin(*h);
}
#endif
w = safe_write(*h, frag->data + remain, frag->length - remain);
if (w == -1) {
download_error_dialog(file_download, errno);
return 0;
}
file_download->seek += w;
}
return 1;
}
static void
abort_download_and_beep(struct file_download *file_download, struct terminal *term)
{
if (term && get_opt_int("document.download.notify_bell")
+ file_download->notify >= 2) {
beep_terminal(term);
}
abort_download(file_download);
}
static void
download_data_store(struct download *download, struct file_download *file_download)
{
struct terminal *term = file_download->term;
if (!term) {
/* No term here, so no beep. --Zas */
abort_download(file_download);
return;
}
if (is_in_progress_state(download->state)) {
if (file_download->dlg_data)
redraw_dialog(file_download->dlg_data, 1);
return;
}
if (download->state != S_OK) {
unsigned char *url = get_uri_string(file_download->uri, URI_PUBLIC);
enum connection_state state = download->state;
abort_download_and_beep(file_download, term);
if (!url) return;
info_box(term, MSGBOX_FREE_TEXT,
N_("Download error"), ALIGN_CENTER,
msg_text(term, N_("Error downloading %s:\n\n%s"),
url, get_state_message(state, term)));
mem_free(url);
return;
}
if (file_download->external_handler) {
prealloc_truncate(file_download->handle, file_download->seek);
close(file_download->handle);
file_download->handle = -1;
exec_on_terminal(term, file_download->external_handler,
file_download->file,
!!file_download->block);
file_download->delete = 0;
abort_download_and_beep(file_download, term);
return;
}
if (file_download->notify) {
unsigned char *url = get_uri_string(file_download->uri, URI_PUBLIC);
/* This is apparently a little racy. Deleting the box item will
* update the download browser _after_ the notification dialog
* has been drawn whereby it will be hidden. This should make
* the download browser update before launcing any
* notification. */
done_download_display(file_download);
if (url) {
info_box(term, MSGBOX_FREE_TEXT,
N_("Download"), ALIGN_CENTER,
msg_text(term, N_("Download complete:\n%s"), url));
mem_free(url);
}
}
if (file_download->remotetime
&& get_opt_bool("document.download.set_original_time")) {
struct utimbuf foo;
foo.actime = foo.modtime = file_download->remotetime;
utime(file_download->file, &foo);
}
abort_download_and_beep(file_download, term);
}
static void
download_data(struct download *download, struct file_download *file_download)
{
struct cache_entry *cached = download->cached;
if (!cached || is_in_queued_state(download->state)) {
download_data_store(download, file_download);
return;
}
if (cached->last_modified)
file_download->remotetime = parse_date(&cached->last_modified, NULL, 0, 1);
if (cached->redirect && file_download->redirect_cnt++ < MAX_REDIRECTS) {
cancel_download(&file_download->download, 0);
assertm(compare_uri(cached->uri, file_download->uri, 0),
"Redirecting using bad base URI");
done_uri(file_download->uri);
file_download->uri = get_uri_reference(cached->redirect);
file_download->download.state = S_WAIT_REDIR;
if (file_download->dlg_data)
redraw_dialog(file_download->dlg_data, 1);
load_uri(file_download->uri, cached->uri, &file_download->download,
PRI_DOWNLOAD, CACHE_MODE_NORMAL,
download->progress ? download->progress->start : 0);
return;
}
if (!write_cache_entry_to_file(cached, file_download)) {
detach_connection(download, file_download->seek);
abort_download(file_download);
return;
}
detach_connection(download, file_download->seek);
download_data_store(download, file_download);
}
/* XXX: We assume that resume is everytime zero in lun's callbacks. */
struct lun_hop {
struct terminal *term;
unsigned char *ofile, *file;
void (*callback)(struct terminal *, unsigned char *, void *, int);
void *data;
};
static void
lun_alternate(struct lun_hop *lun_hop)
{
lun_hop->callback(lun_hop->term, lun_hop->file, lun_hop->data, 0);
mem_free_if(lun_hop->ofile);
mem_free(lun_hop);
}
static void
lun_overwrite(struct lun_hop *lun_hop)
{
lun_hop->callback(lun_hop->term, lun_hop->ofile, lun_hop->data, 0);
mem_free_if(lun_hop->file);
mem_free(lun_hop);
}
static void
lun_resume(struct lun_hop *lun_hop)
{
lun_hop->callback(lun_hop->term, lun_hop->ofile, lun_hop->data, 1);
mem_free_if(lun_hop->file);
mem_free(lun_hop);
}
static void
lun_cancel(struct lun_hop *lun_hop)
{
lun_hop->callback(lun_hop->term, NULL, lun_hop->data, 0);
mem_free_if(lun_hop->ofile);
mem_free_if(lun_hop->file);
mem_free(lun_hop);
}
static void
lookup_unique_name(struct terminal *term, unsigned char *ofile, int resume,
void (*callback)(struct terminal *, unsigned char *, void *, int),
void *data)
{
Here is a framework that detects cases where a PO file assigns the same accelerator key to multiple buttons in a dialog box or to multiple items in a menu. ELinks already has some support for this but it requires the translator to run ELinks and manually scan through all menus and dialogs. The attached changes make it possible to quickly detect and list any conflicts, including ones that can only occur on operating systems or configurations that the translator is not currently using. The changes have no immediate effect on the elinks executable or the MO files. PO files become larger, however. The scheme works like this: - Like before, accelerator keys in translatable strings are tagged with the tilde (~) character. - Whenever a C source file defines an accelerator key, it must assign one or more named "contexts" to it. The translations in the PO files inherit these contexts. If multiple strings use the same accelerator (case insensitive) in the same context, that's a conflict and can be detected automatically. - The contexts are defined with "gettext_accelerator_context" comments in source files. These comments delimit regions where all translatable strings containing tildes are given the same contexts. There must be one special comment at the top of the region; it lists the contexts assigned to that region. The region automatically ends at the end of the function (found with regexp /^\}/), but it can also be closed explicitly with another special comment. The comments are formatted like this: /* [gettext_accelerator_context(foo, bar, baz)] begins a region that uses the contexts "foo", "bar", and "baz". The comma is the delimiter; whitespace is optional. [gettext_accelerator_context()] ends the region. */ The scripts don't currently check whether this syntax occurs inside or outside comments. - The names of contexts consist of C identifiers delimited with periods. I typically used the name of a function that sets up a dialog, or the name of an array where the items of a menu are listed. There is a special feature for static functions: if the name begins with a period, then the period will be replaced with the name of the source file and a colon. - If a menu is programmatically generated from multiple parts, of which some are never used together, so that it is safe to use the same accelerators in them, then it is necessary to define multiple contexts for the same menu. link_menu() in src/viewer/text/link.c is the most complex example of this. - During make update-po: - A Perl script (po/gather-accelerator-contexts.pl) reads po/elinks.pot, scans the source files listed in it for "gettext_accelerator_context" comments, and rewrites po/elinks.pot with "accelerator_context" comments that indicate the contexts of each msgid: the union of all contexts of all of its uses in the source files. It also removes any "gettext_accelerator_context" comments that xgettext --add-comments has copied to elinks.pot. - If po/gather-accelerator-contexts.pl does not find any contexts for some use of an msgid that seems to contain an accelerator (because it contains a tilde), it warns. If the tilde refers to e.g. "~/.elinks" and does not actually mark an accelerator, the warning can be silenced by specifying the special context "IGNORE", which the script otherwise ignores. - msgmerge copies the "accelerator_context" comments from po/elinks.pot to po/*.po. Translators do not edit those comments. - During make check-po: - Another Perl script (po/check-accelerator-contexts.pl) reads po/*.po and keeps track of which accelerators have been bound in each context. It warns about any conflicts it finds. This script does not access the C source files; thus it does not matter if the line numbers in "#:" lines are out of date. This implementation is not perfect and I am not proposing to add it to the main source tree at this time. Specifically: - It introduces compile-time dependencies on Perl and Locale::PO. There should be a configure-time or compile-time check so that the new features are skipped if the prerequisites are missing. - When the scripts include msgstr strings in warnings, they should transcode them from the charset of the PO file to the one specified by the user's locale. - It is not adequately documented (well, except perhaps here). - po/check-accelerator-contexts.pl reports the same conflict multiple times if it occurs in multiple contexts. - The warning messages should include line numbers, so that users of Emacs could conveniently edit the conflicting part of the PO file. This is not feasible with the current version of Locale::PO. - Locale::PO does not understand #~ lines and spews warnings about them. There is an ugly hack to hide these warnings. - Jonas Fonseca suggested the script could propose accelerators that are still available. This has not been implemented. There are three files attached: - po/gather-accelerator-contexts.pl: Augments elinks.pot with context information. - po/check-accelerator-contexts.pl: Checks conflicts. - accelerator-contexts.diff: Makes po/Makefile run the scripts, and adds special comments to source files.
2005-12-04 18:38:29 -05:00
/* [gettext_accelerator_context(.lookup_unique_name)] */
struct lun_hop *lun_hop;
unsigned char *file;
int overwrite;
ofile = expand_tilde(ofile);
/* Minor code duplication to prevent useless call to get_opt_int()
* if possible. --Zas */
if (resume) {
callback(term, ofile, data, resume);
return;
}
/* !overwrite means always silently overwrite, which may be admitelly
* indeed a little confusing ;-) */
overwrite = get_opt_int("document.download.overwrite");
if (!overwrite) {
/* Nothing special to do... */
callback(term, ofile, data, resume);
return;
}
/* Check if file is a directory, and use a default name if it's the
* case. */
if (file_is_dir(ofile)) {
info_box(term, MSGBOX_FREE_TEXT,
N_("Download error"), ALIGN_CENTER,
msg_text(term, N_("'%s' is a directory."),
ofile));
mem_free(ofile);
callback(term, NULL, data, 0);
return;
}
/* Check if the file already exists (file != ofile). */
file = get_unique_name(ofile);
if (!file || overwrite == 1 || file == ofile) {
/* Still nothing special to do... */
if (file != ofile) mem_free(ofile);
callback(term, file, data, 0);
return;
}
/* overwrite == 2 (ask) and file != ofile (=> original file already
* exists) */
lun_hop = mem_calloc(1, sizeof(*lun_hop));
if (!lun_hop) {
if (file != ofile) mem_free(file);
mem_free(ofile);
callback(term, NULL, data, 0);
return;
}
lun_hop->term = term;
lun_hop->ofile = ofile;
lun_hop->file = (file != ofile) ? file : stracpy(ofile);
lun_hop->callback = callback;
lun_hop->data = data;
msg_box(term, NULL, MSGBOX_FREE_TEXT,
N_("File exists"), ALIGN_CENTER,
msg_text(term, N_("This file already exists:\n"
"%s\n\n"
"The alternative filename is:\n"
"%s"),
empty_string_or_(lun_hop->ofile),
empty_string_or_(file)),
lun_hop, 4,
N_("Sa~ve under the alternative name"), lun_alternate, B_ENTER,
N_("~Overwrite the original file"), lun_overwrite, 0,
N_("~Resume download of the original file"), lun_resume, 0,
N_("~Cancel"), lun_cancel, B_ESC);
}
struct cdf_hop {
unsigned char **real_file;
int safe;
void (*callback)(struct terminal *, int, void *, int);
void *data;
};
static void
create_download_file_do(struct terminal *term, unsigned char *file, void *data,
int resume)
{
struct cdf_hop *cdf_hop = data;
unsigned char *wd;
int h = -1;
int saved_errno;
#ifdef NO_FILE_SECURITY
int sf = 0;
#else
int sf = cdf_hop->safe;
#endif
if (!file) goto finish;
wd = get_cwd();
set_cwd(term->cwd);
/* Create parent directories if needed. */
mkalldirs(file);
/* O_APPEND means repositioning at the end of file before each write(),
* thus ignoring seek()s and that can hide mysterious bugs. IMHO.
* --pasky */
h = open(file, O_CREAT | O_WRONLY | (resume ? 0 : O_TRUNC)
| (sf && !resume ? O_EXCL : 0),
sf ? 0600 : 0666);
saved_errno = errno; /* Saved in case of ... --Zas */
if (wd) {
set_cwd(wd);
mem_free(wd);
}
if (h == -1) {
info_box(term, MSGBOX_FREE_TEXT,
N_("Download error"), ALIGN_CENTER,
msg_text(term, N_("Could not create file '%s':\n%s"),
file, strerror(saved_errno)));
mem_free(file);
goto finish;
} else {
set_bin(h);
if (!cdf_hop->safe) {
unsigned char *download_dir = get_opt_str("document.download.directory");
int i;
safe_strncpy(download_dir, file, MAX_STR_LEN);
/* Find the used directory so it's available in history */
for (i = strlen(download_dir); i >= 0; i--)
if (dir_sep(download_dir[i]))
break;
download_dir[i + 1] = 0;
}
}
if (cdf_hop->real_file)
*cdf_hop->real_file = file;
else
mem_free(file);
finish:
cdf_hop->callback(term, h, cdf_hop->data, resume);
mem_free(cdf_hop);
}
void
create_download_file(struct terminal *term, unsigned char *fi,
unsigned char **real_file, int safe, int resume,
void (*callback)(struct terminal *, int, void *, int),
void *data)
{
struct cdf_hop *cdf_hop = mem_calloc(1, sizeof(*cdf_hop));
unsigned char *wd;
if (!cdf_hop) {
callback(term, -1, data, 0);
return;
}
cdf_hop->real_file = real_file;
cdf_hop->safe = safe;
cdf_hop->callback = callback;
cdf_hop->data = data;
/* FIXME: The wd bussiness is probably useless here? --pasky */
wd = get_cwd();
set_cwd(term->cwd);
/* Also the tilde will be expanded here. */
lookup_unique_name(term, fi, resume, create_download_file_do, cdf_hop);
if (wd) {
set_cwd(wd);
mem_free(wd);
}
}
static unsigned char *
get_temp_name(struct uri *uri)
{
struct string name;
unsigned char *extension;
/* FIXME
* We use tempnam() here, which is unsafe (race condition), for now.
* This should be changed at some time, but it needs an in-depth work
* of whole download code. --Zas */
unsigned char *nm = tempnam(NULL, ELINKS_TEMPNAME_PREFIX);
if (!nm) return NULL;
if (!init_string(&name)) {
free(nm);
return NULL;
}
add_to_string(&name, nm);
free(nm);
extension = get_extension_from_uri(uri);
if (extension) {
add_shell_safe_to_string(&name, extension, strlen(extension));
mem_free(extension);
}
return name.source;
}
static unsigned char *
subst_file(unsigned char *prog, unsigned char *file)
{
struct string name;
if (!init_string(&name)) return NULL;
while (*prog) {
int p;
for (p = 0; prog[p] && prog[p] != '%'; p++);
add_bytes_to_string(&name, prog, p);
prog += p;
if (*prog == '%') {
#if defined(HAVE_CYGWIN_CONV_TO_FULL_WIN32_PATH)
#ifdef MAX_PATH
unsigned char new_path[MAX_PATH];
#else
unsigned char new_path[1024];
#endif
cygwin_conv_to_full_win32_path(file, new_path);
add_to_string(&name, new_path);
#else
add_to_string(&name, file);
#endif
prog++;
}
}
return name.source;
}
struct cmdw_hop {
struct session *ses;
unsigned char *real_file;
};
static void
common_download_do(struct terminal *term, int fd, void *data, int resume)
{
struct file_download *file_download;
struct cmdw_hop *cmdw_hop = data;
unsigned char *file = cmdw_hop->real_file;
struct session *ses = cmdw_hop->ses;
struct stat buf;
mem_free(cmdw_hop);
if (!file || fstat(fd, &buf)) return;
file_download = init_file_download(ses->download_uri, ses, file, fd);
if (!file_download) return;
if (resume) file_download->seek = buf.st_size;
display_download(ses->tab->term, file_download, ses);
load_uri(file_download->uri, ses->referrer, &file_download->download,
PRI_DOWNLOAD, CACHE_MODE_NORMAL, file_download->seek);
}
static void
common_download(struct session *ses, unsigned char *file, int resume)
{
struct cmdw_hop *cmdw_hop;
if (!ses->download_uri) return;
cmdw_hop = mem_calloc(1, sizeof(*cmdw_hop));
if (!cmdw_hop) return;
cmdw_hop->ses = ses;
kill_downloads_to_file(file);
create_download_file(ses->tab->term, file, &cmdw_hop->real_file, 0,
resume, common_download_do, cmdw_hop);
}
void
start_download(void *ses, unsigned char *file)
{
common_download(ses, file, 0);
}
void
resume_download(void *ses, unsigned char *file)
{
common_download(ses, file, 1);
}
struct codw_hop {
struct type_query *type_query;
unsigned char *real_file;
unsigned char *file;
};
static void
continue_download_do(struct terminal *term, int fd, void *data, int resume)
{
struct codw_hop *codw_hop = data;
struct file_download *file_download = NULL;
struct type_query *type_query;
assert(codw_hop);
assert(codw_hop->type_query);
assert(codw_hop->type_query->uri);
assert(codw_hop->type_query->ses);
type_query = codw_hop->type_query;
if (!codw_hop->real_file) goto cancel;
file_download = init_file_download(type_query->uri, type_query->ses,
codw_hop->real_file, fd);
if (!file_download) goto cancel;
if (type_query->external_handler) {
file_download->external_handler = subst_file(type_query->external_handler,
codw_hop->file);
file_download->delete = 1;
mem_free(codw_hop->file);
mem_free_set(&type_query->external_handler, NULL);
}
file_download->block = !!type_query->block;
/* Done here and not in init_file_download() so that the external
* handler can become initialized. */
display_download(term, file_download, type_query->ses);
move_download(&type_query->download, &file_download->download, PRI_DOWNLOAD);
done_type_query(type_query);
mem_free(codw_hop);
return;
cancel:
if (type_query->external_handler) mem_free_if(codw_hop->file);
tp_cancel(type_query);
mem_free(codw_hop);
}
static void
continue_download(void *data, unsigned char *file)
{
struct type_query *type_query = data;
struct codw_hop *codw_hop = mem_calloc(1, sizeof(*codw_hop));
if (!codw_hop) {
tp_cancel(type_query);
return;
}
if (type_query->external_handler) {
/* FIXME: get_temp_name() calls tempnam(). --Zas */
file = get_temp_name(type_query->uri);
if (!file) {
mem_free(codw_hop);
tp_cancel(type_query);
return;
}
}
codw_hop->type_query = type_query;
codw_hop->file = file;
kill_downloads_to_file(file);
create_download_file(type_query->ses->tab->term, file,
&codw_hop->real_file,
!!type_query->external_handler, 0,
continue_download_do, codw_hop);
}
static struct type_query *
init_type_query(struct session *ses, struct download *download,
struct cache_entry *cached)
{
struct type_query *type_query;
/* There can be only one ... */
foreach (type_query, ses->type_queries)
if (compare_uri(type_query->uri, ses->loading_uri, 0))
return NULL;
type_query = mem_calloc(1, sizeof(*type_query));
if (!type_query) return NULL;
type_query->uri = get_uri_reference(ses->loading_uri);
type_query->ses = ses;
type_query->target_frame = null_or_stracpy(ses->task.target.frame);
type_query->cached = cached;
object_lock(type_query->cached);
move_download(download, &type_query->download, PRI_MAIN);
download->state = S_OK;
add_to_list(ses->type_queries, type_query);
return type_query;
}
void
done_type_query(struct type_query *type_query)
{
/* Unregister any active download */
cancel_download(&type_query->download, 0);
object_unlock(type_query->cached);
done_uri(type_query->uri);
mem_free_if(type_query->external_handler);
mem_free_if(type_query->target_frame);
del_from_list(type_query);
mem_free(type_query);
}
void
tp_cancel(void *data)
{
struct type_query *type_query = data;
/* XXX: Should we really abort? (1 vs 0 as the last param) --pasky */
cancel_download(&type_query->download, 1);
done_type_query(type_query);
}
void
tp_save(struct type_query *type_query)
{
mem_free_set(&type_query->external_handler, NULL);
query_file(type_query->ses, type_query->uri, type_query, continue_download, tp_cancel, 1);
}
/* This button handler uses the add_dlg_button() interface so that pressing
* 'Show header' will not close the type query dialog. */
static widget_handler_status_T
tp_show_header(struct dialog_data *dlg_data, struct widget_data *widget_data)
{
struct type_query *type_query = widget_data->widget->data;
cached_header_dialog(type_query->ses, type_query->cached);
return EVENT_PROCESSED;
}
/* FIXME: We need to modify this function to take frame data instead, as we
* want to use this function for frames as well (now, when frame has content
* type text/plain, it is ignored and displayed as HTML). */
void
tp_display(struct type_query *type_query)
{
struct view_state *vs;
struct session *ses = type_query->ses;
struct uri *loading_uri = ses->loading_uri;
unsigned char *target_frame = ses->task.target.frame;
ses->loading_uri = type_query->uri;
ses->task.target.frame = type_query->target_frame;
vs = ses_forward(ses, /* type_query->frame */ 0);
if (vs) vs->plain = 1;
ses->loading_uri = loading_uri;
ses->task.target.frame = target_frame;
if (/* !type_query->frame */ 1) {
struct download *old = &type_query->download;
struct download *new = &cur_loc(ses)->download;
new->callback = (download_callback_T *) doc_loading_callback;
new->data = ses;
move_download(old, new, PRI_MAIN);
}
display_timer(ses);
done_type_query(type_query);
}
static void
tp_open(struct type_query *type_query)
{
if (!type_query->external_handler || !*type_query->external_handler) {
tp_display(type_query);
return;
}
if (type_query->uri->protocol == PROTOCOL_FILE) {
unsigned char *file = get_uri_string(type_query->uri, URI_PATH);
unsigned char *handler = NULL;
if (file) {
handler = subst_file(type_query->external_handler, file);
mem_free(file);
}
if (handler) {
exec_on_terminal(type_query->ses->tab->term,
handler, "", !!type_query->block);
mem_free(handler);
}
done_type_query(type_query);
return;
}
continue_download(type_query, "");
}
static void
do_type_query(struct type_query *type_query, unsigned char *ct, struct mime_handler *handler)
{
Here is a framework that detects cases where a PO file assigns the same accelerator key to multiple buttons in a dialog box or to multiple items in a menu. ELinks already has some support for this but it requires the translator to run ELinks and manually scan through all menus and dialogs. The attached changes make it possible to quickly detect and list any conflicts, including ones that can only occur on operating systems or configurations that the translator is not currently using. The changes have no immediate effect on the elinks executable or the MO files. PO files become larger, however. The scheme works like this: - Like before, accelerator keys in translatable strings are tagged with the tilde (~) character. - Whenever a C source file defines an accelerator key, it must assign one or more named "contexts" to it. The translations in the PO files inherit these contexts. If multiple strings use the same accelerator (case insensitive) in the same context, that's a conflict and can be detected automatically. - The contexts are defined with "gettext_accelerator_context" comments in source files. These comments delimit regions where all translatable strings containing tildes are given the same contexts. There must be one special comment at the top of the region; it lists the contexts assigned to that region. The region automatically ends at the end of the function (found with regexp /^\}/), but it can also be closed explicitly with another special comment. The comments are formatted like this: /* [gettext_accelerator_context(foo, bar, baz)] begins a region that uses the contexts "foo", "bar", and "baz". The comma is the delimiter; whitespace is optional. [gettext_accelerator_context()] ends the region. */ The scripts don't currently check whether this syntax occurs inside or outside comments. - The names of contexts consist of C identifiers delimited with periods. I typically used the name of a function that sets up a dialog, or the name of an array where the items of a menu are listed. There is a special feature for static functions: if the name begins with a period, then the period will be replaced with the name of the source file and a colon. - If a menu is programmatically generated from multiple parts, of which some are never used together, so that it is safe to use the same accelerators in them, then it is necessary to define multiple contexts for the same menu. link_menu() in src/viewer/text/link.c is the most complex example of this. - During make update-po: - A Perl script (po/gather-accelerator-contexts.pl) reads po/elinks.pot, scans the source files listed in it for "gettext_accelerator_context" comments, and rewrites po/elinks.pot with "accelerator_context" comments that indicate the contexts of each msgid: the union of all contexts of all of its uses in the source files. It also removes any "gettext_accelerator_context" comments that xgettext --add-comments has copied to elinks.pot. - If po/gather-accelerator-contexts.pl does not find any contexts for some use of an msgid that seems to contain an accelerator (because it contains a tilde), it warns. If the tilde refers to e.g. "~/.elinks" and does not actually mark an accelerator, the warning can be silenced by specifying the special context "IGNORE", which the script otherwise ignores. - msgmerge copies the "accelerator_context" comments from po/elinks.pot to po/*.po. Translators do not edit those comments. - During make check-po: - Another Perl script (po/check-accelerator-contexts.pl) reads po/*.po and keeps track of which accelerators have been bound in each context. It warns about any conflicts it finds. This script does not access the C source files; thus it does not matter if the line numbers in "#:" lines are out of date. This implementation is not perfect and I am not proposing to add it to the main source tree at this time. Specifically: - It introduces compile-time dependencies on Perl and Locale::PO. There should be a configure-time or compile-time check so that the new features are skipped if the prerequisites are missing. - When the scripts include msgstr strings in warnings, they should transcode them from the charset of the PO file to the one specified by the user's locale. - It is not adequately documented (well, except perhaps here). - po/check-accelerator-contexts.pl reports the same conflict multiple times if it occurs in multiple contexts. - The warning messages should include line numbers, so that users of Emacs could conveniently edit the conflicting part of the PO file. This is not feasible with the current version of Locale::PO. - Locale::PO does not understand #~ lines and spews warnings about them. There is an ugly hack to hide these warnings. - Jonas Fonseca suggested the script could propose accelerators that are still available. This has not been implemented. There are three files attached: - po/gather-accelerator-contexts.pl: Augments elinks.pot with context information. - po/check-accelerator-contexts.pl: Checks conflicts. - accelerator-contexts.diff: Makes po/Makefile run the scripts, and adds special comments to source files.
2005-12-04 18:38:29 -05:00
/* [gettext_accelerator_context(.do_type_query)] */
struct string filename;
unsigned char *description;
unsigned char *desc_sep;
unsigned char *format, *text, *title;
struct dialog *dlg;
#define TYPE_QUERY_WIDGETS_COUNT 8
int widgets = TYPE_QUERY_WIDGETS_COUNT;
struct terminal *term = type_query->ses->tab->term;
struct memory_list *ml;
struct dialog_data *dlg_data;
int selected_widget;
mem_free_set(&type_query->external_handler, NULL);
if (handler) {
type_query->block = handler->block;
if (!handler->ask) {
type_query->external_handler = stracpy(handler->program);
tp_open(type_query);
return;
}
/* Start preparing for the type query dialog. */
description = handler->description;
desc_sep = *description ? "; " : "";
title = N_("What to do?");
} else {
title = N_("Unknown type");
description = "";
desc_sep = "";
}
dlg = calloc_dialog(TYPE_QUERY_WIDGETS_COUNT, MAX_STR_LEN * 2);
if (!dlg) return;
if (init_string(&filename)) {
add_mime_filename_to_string(&filename, type_query->uri);
/* Let's make the filename pretty for display & save */
/* TODO: The filename can be the empty string here. See bug 396. */
decode_uri_string_for_display(&filename);
}
text = get_dialog_offset(dlg, TYPE_QUERY_WIDGETS_COUNT);
format = _("What would you like to do with the file '%s' (type: %s%s%s)?", term);
snprintf(text, MAX_STR_LEN, format, filename.source, ct, desc_sep, description);
done_string(&filename);
dlg->title = _(title, term);
dlg->layouter = generic_dialog_layouter;
dlg->layout.padding_top = 1;
dlg->layout.fit_datalen = 1;
dlg->udata2 = type_query;
add_dlg_text(dlg, text, ALIGN_LEFT, 0);
/* Add input field or text widget with info about the program handler. */
if (!get_cmd_opt_bool("anonymous")) {
unsigned char *field = mem_calloc(1, MAX_STR_LEN);
if (!field) {
mem_free(dlg);
return;
}
if (handler && handler->program) {
int programlen = strlen(handler->program);
programlen = int_max(programlen, MAX_STR_LEN);
memcpy(field, handler->program, programlen);
}
/* xgettext:no-c-format */
add_dlg_field(dlg, _("Program ('%' will be replaced by the filename)", term),
0, 0, NULL, MAX_S