Added a new FETCH_CALLBACK option to fetch data without allocation

This commit is contained in:
Martin Willi
2011-04-04 08:48:27 +02:00
parent 5131c62517
commit 13eda8e903
7 changed files with 97 additions and 22 deletions
+33
View File
@@ -0,0 +1,33 @@
/*
* Copyright (C) 2011 Martin Willi
* Copyright (C) 2011 revosec AG
*
* This program 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; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* 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 General Public License
* for more details.
*/
#include "fetcher.h"
/**
* See header.
*/
bool fetcher_default_callback(void *userdata, chunk_t chunk)
{
chunk_t *accu = userdata;
accu->ptr = realloc(accu->ptr, accu->len + chunk.len);
if (accu->ptr)
{
memcpy(&accu->ptr[accu->len], chunk.ptr, chunk.len);
accu->len += chunk.len;
return TRUE;
}
return FALSE;
}
+41 -10
View File
@@ -1,6 +1,7 @@
/*
* Copyright (C) 2008 Martin Willi
* Copyright (C) 2008-2011 Martin Willi
* Hochschule fuer Technik Rapperswil
* Copyright (C) 2011 revosec AG
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
@@ -25,6 +26,23 @@ typedef struct fetcher_t fetcher_t;
typedef enum fetcher_option_t fetcher_option_t;
#include <stdarg.h>
#include <chunk.h>
/**
* Constructor function which creates fetcher instances.
*
* @return fetcher instance
*/
typedef fetcher_t* (*fetcher_constructor_t)();
/**
* Callback function used with FETCH_CALLBACK.
*
* @param userdata userdata passed to fetcher_t.fetch()
* @param chunk chunk with next chunk of data
* @return TRUE to continue with transfer, FALSE to abort
*/
typedef bool (*fetcher_callback_t)(void *userdata, chunk_t chunk);
#include <library.h>
@@ -63,19 +81,20 @@ enum fetcher_option_t {
*/
FETCH_TIMEOUT,
/**
* Callback to invoke with each chunk of data.
* Additional argument fetch_callback_t.
* If this option is not given, the fetcher_default_callback is used,
* which accumulates the data into an allocated chunk.
*/
FETCH_CALLBACK,
/**
* end of fetching options
*/
FETCH_END,
};
/**
* Constructor function which creates fetcher instances.
*
* @return fetcher instance
*/
typedef fetcher_t* (*fetcher_constructor_t)();
/**
* Fetcher interface, an implementation fetches data from an URL.
*/
@@ -87,15 +106,18 @@ struct fetcher_t {
* The fetcher returns NOT_SUPPORTED to indicate that it is uncappable
* to handle such URLs. Other return values indicate a failure, and
* fetching of that URL gets cancelled.
* If no FETCH_CALLBACK function is set as option, userdata must be
* a chunk_t*. This chunk gets allocated, accumulated data using the
* fetcher_default_callback() function.
*
* @param uri URI to fetch from
* @param result chunk which receives allocated data
* @param userdata userdata to pass to callback function.
* @return
* - SUCCESS if fetch was successful
* - NOT_SUPPORTED if fetcher does not support such URLs
* - FAILED, NOT_FOUND, PARSE_ERROR on failure
*/
status_t (*fetch)(fetcher_t *this, char *uri, chunk_t *result);
status_t (*fetch)(fetcher_t *this, char *uri, void *userdata);
/**
* Set a fetcher option, as defined in fetcher_option_t.
@@ -114,4 +136,13 @@ struct fetcher_t {
void (*destroy)(fetcher_t *this);
};
/**
* Default fetcher callback function, accumulates data to a chunk.
*
* @param userdata chunk for allocated data, empty on first invocation
* @param chunk current chunk of data
* @return FALSE if chunk too large to allocate
*/
bool fetcher_default_callback(void *userdata, chunk_t chunk);
#endif /** FETCHER_H_ @}*/
+12 -6
View File
@@ -59,7 +59,7 @@ static void entry_destroy(entry_t *entry)
}
METHOD(fetcher_manager_t, fetch, status_t,
private_fetcher_manager_t *this, char *url, chunk_t *response, ...)
private_fetcher_manager_t *this, char *url, void *userdata, ...)
{
enumerator_t *enumerator;
status_t status = NOT_SUPPORTED;
@@ -86,25 +86,31 @@ METHOD(fetcher_manager_t, fetch, status_t,
{
continue;
}
va_start(args, response);
va_start(args, userdata);
while (good)
{
opt = va_arg(args, int);
switch (opt)
{
case FETCH_REQUEST_DATA:
good = fetcher->set_option(fetcher, opt, va_arg(args, chunk_t));
good = fetcher->set_option(fetcher, opt,
va_arg(args, chunk_t));
continue;
case FETCH_REQUEST_TYPE:
case FETCH_REQUEST_HEADER:
good = fetcher->set_option(fetcher, opt, va_arg(args, char*));
good = fetcher->set_option(fetcher, opt,
va_arg(args, char*));
continue;
case FETCH_HTTP_VERSION_1_0:
good = fetcher->set_option(fetcher, opt);
continue;
case FETCH_TIMEOUT:
good = fetcher->set_option(fetcher, opt, va_arg(args, u_int));
good = fetcher->set_option(fetcher, opt,
va_arg(args, u_int));
continue;
case FETCH_CALLBACK:
good = fetcher->set_option(fetcher, opt,
va_arg(args, fetcher_callback_t));
case FETCH_END:
break;
}
@@ -117,7 +123,7 @@ METHOD(fetcher_manager_t, fetch, status_t,
continue;
}
status = fetcher->fetch(fetcher, url, response);
status = fetcher->fetch(fetcher, url, userdata);
fetcher->destroy(fetcher);
/* try another fetcher only if this one does not support that URL */
if (status == NOT_SUPPORTED)
+6 -3
View File
@@ -31,17 +31,20 @@ typedef struct fetcher_manager_t fetcher_manager_t;
struct fetcher_manager_t {
/**
* Fetch data from URI into chunk.
* Fetch data from URI.
*
* The variable argument list contains fetcher_option_t's, followed
* by a option specific data argument.
* If no FETCH_CALLBACK function is given as option, userdata must be
* a chunk_t*. This chunk gets allocated, accumulated data using the
* fetcher_default_callback() function.
*
* @param uri URI to fetch from
* @param result chunk which receives allocated data
* @param userdata userdata to pass to callback function.
* @param options FETCH_END terminated fetcher_option_t arguments
* @return status indicating result of fetch
*/
status_t (*fetch)(fetcher_manager_t *this, char *url, chunk_t *response, ...);
status_t (*fetch)(fetcher_manager_t *this, char *url, void *userdata, ...);
/**
* Register a fetcher implementation.