ulinet.c File Reference

#include "ulinet.h"
#include "server_internal.h"
#include <assert.h>
#include <ctype.h>

Macros
#define	_ULINET
#define	MAX_WAIT_MSECS   180*1000 /* Wait max. 180 seconds */

Functions
size_t	write_data_into (void *buffer, size_t size, size_t nmemb, void *data)
	Write the downloaded content to a _HINTERNET structure. More...
size_t	write_data_into_file (void *buffer, size_t size, size_t nmemb, void *data)
	Write the downloaded content in the file pouted by the _HINTERNET structure. More...
size_t	header_write_data (void *buffer, size_t size, size_t nmemb, void *data)
	In case of presence of "Set-Cookie" in the headers red, store the cookie identifier in cookie. More...
void	setProxy (CURL *handle, char *host, long port)
	Define the proxy to use for a CURL handler. More...
int	setProxiesForProtcol (CURL *handle, const char *proto)
	MACOSX. More...
HINTERNET	InternetOpen (char *lpszAgent, int dwAccessType, char *lpszProxyName, char *lpszProxyBypass, int dwFlags)
	Create a HINTERNET. More...
char *	getProvenance (maps *conf, const char *url)
	Verify if the URL should use a shared cache or not. More...
int	AddMissingHeaderEntry (_HINTERNET *handle, const char *key, const char *value)
	Add missing headers to an existing _HINTERNET. More...
int	isProtectedHost (const char *protectedHosts, const char *url)
	Verify if a host is protected (appear in [security] > hosts) More...
void	AddHeaderEntries (HINTERNET *handle, maps *conf)
	Add headers defined in [security] > attributes to an existing HINTERNET. More...
void	InternetCloseHandle (HINTERNET *handle0)
	Close a HINTERNET connection and free allocated resources. More...
HINTERNET	InternetOpenUrl (HINTERNET *hInternet, LPCTSTR lpszUrl, LPCTSTR lpszHeaders, size_t dwHeadersLength, size_t dwFlags, size_t dwContext, const maps *conf)
	Create a new element in the download queue. More...
int	processDownloads (HINTERNET *hInternet)
	Download all opened urls in the queue. More...
int	freeCookieList (HINTERNET hInternet)
	Initialize the cookie for a specific index (hInternet.nb) More...
int	InternetReadFile (_HINTERNET hInternet, LPVOID lpBuffer, int dwNumberOfBytesToRead, size_t *lpdwNumberOfBytesRead)
	Copy a downloaded content. More...
int	setBasicAuth (HINTERNET hInternet, char *login, char *passwd)
	Use basic authentication for accessing a resource. More...

Macro Definition Documentation

_ULINET

#define _ULINET

MAX_WAIT_MSECS

#define MAX_WAIT_MSECS   180*1000 /* Wait max. 180 seconds */

Function Documentation

AddHeaderEntries()

void AddHeaderEntries	(	HINTERNET *	handle,
		maps *	conf
	)

Add headers defined in [security] > attributes to an existing HINTERNET.

See also

isProtectedHost, AddMissingHeaderEntry

Parameters

handle	the _HINTERNET pointer
conf	the header parameter name
value	the header parameter value

Returns

0 if the operation succeeded, -1 in other case.

AddMissingHeaderEntry()

int AddMissingHeaderEntry	(	_HINTERNET *	handle,
		const char *	key,
		const char *	value
	)

Add missing headers to an existing _HINTERNET.

Parameters

handle	the _HINTERNET pointer
key	the header parameter name
value	the header parameter value

Returns

0 if the operation succeeded, -1 in other case.

freeCookieList()

int freeCookieList

(

HINTERNET

hInternet

)

Initialize the cookie for a specific index (hInternet.nb)

Parameters

hInternet

the HINTERNET structure to know the cookie index to reset

Returns

1

See also

HINTERNET

getProvenance()

char* getProvenance	(	maps *	conf,
		const char *	url
	)

Verify if the URL should use a shared cache or not.

In case the security section contains a key named "shared", then if the domain listed in the shared key are contained in the url given as parameter then it return "SHARED" in other cases, it returns "OTHER".

Parameters

conf	the main configuration file maps
url	the URL to evaluate

Returns

a string "SHARED" in case the host is in a domain listed in the shared key, "OTHER" in other cases.

header_write_data()

size_t header_write_data	(	void *	buffer,
		size_t	size,
		size_t	nmemb,
		void *	data
	)

In case of presence of "Set-Cookie" in the headers red, store the cookie identifier in cookie.

Parameters

buffer	the buffer to read
size	size of each member
nmemb	number of element to read
data	the _HINTERNET structure to write in

Returns

the size red, -1 if buffer is NULL

See also

cookie

InternetCloseHandle()

void InternetCloseHandle

(

HINTERNET *

handle0

)

Close a HINTERNET connection and free allocated resources.

Parameters

handle0

the HINTERNET connection to close

InternetOpen()

HINTERNET InternetOpen	(	char *	lpszAgent,
		int	dwAccessType,
		char *	lpszProxyName,
		char *	lpszProxyBypass,
		int	dwFlags
	)

Create a HINTERNET.

Parameters

lpszAgent	the HTPP User-Agent to use to send requests
dwAccessType	type of access required
lpszProxyName	the name of the proxy server(s) to use
lpszProxyBypass	ip address or host names which should not be routed through the proxy
dwFlags	Options (INTERNET_FLAG_ASYNC,INTERNET_FLAG_FROM_CACHE,INTERNET_FLAG_OFFLINE)

Returns

the created HINTERNET

InternetOpenUrl()

HINTERNET InternetOpenUrl	(	HINTERNET *	hInternet,
		LPCTSTR	lpszUrl,
		LPCTSTR	lpszHeaders,
		size_t	dwHeadersLength,
		size_t	dwFlags,
		size_t	dwContext,
		const maps *	conf
	)

Create a new element in the download queue.

Parameters

hInternet	the HINTERNET connection to add the download link
lpszUrl	the url to download
lpszHeaders	the additional headers to be sent to the HTTP server
dwHeadersLength	the size of the additional headers
dwFlags	desired download mode (INTERNET_FLAG_NO_CACHE_WRITE for not using cache file)
dwContext	not used
conf	the main configuration file maps pointer

Returns

the updated HINTERNET

InternetReadFile()

int InternetReadFile	(	_HINTERNET	hInternet,
		LPVOID	lpBuffer,
		int	dwNumberOfBytesToRead,
		size_t *	lpdwNumberOfBytesRead
	)

Copy a downloaded content.

Parameters

hInternet	the _HINTERNET structure
lpBuffer	the memory space to copy the downloaded content
dwNumberOfBytesToRead	the size of lpBuffer
lpdwNumberOfBytesRead	number of bytes red

Returns

1 on success, 0 if failure

isProtectedHost()

int isProtectedHost	(	const char *	protectedHosts,
		const char *	url
	)

Verify if a host is protected (appear in [security] > hosts)

Parameters

protectedHosts	string containing all the protected hosts (coma separated)
url	string used to extract the host from

Returns

1 if the host is listed as protected, 0 in other case

processDownloads()

int processDownloads

(

HINTERNET *

hInternet

)

Download all opened urls in the queue.

Parameters

hInternet

the HINTERNET structure containing the queue

Returns

0

setBasicAuth()

int setBasicAuth	(	HINTERNET	hInternet,
		char *	login,
		char *	passwd
	)

Use basic authentication for accessing a resource.

Parameters

hInternet	the _HINTERNET structure
login	the login to use to authenticate
passwd	the password to use to authenticate

setProxiesForProtcol()

int setProxiesForProtcol	(	CURL *	handle,
		const char *	proto
	)

MACOSX.

Should autodetect the proxy configuration (do nothing on linux)

Parameters

handle	a CURL handle
proto	the protocol requiring the use of a proxy

setProxy()

void setProxy	(	CURL *	handle,
		char *	host,
		long	port
	)

Define the proxy to use for a CURL handler.

Parameters

handle	the CURL handler
host	the proxy host (including http://)
port	the proxy port

write_data_into()

size_t write_data_into	(	void *	buffer,
		size_t	size,
		size_t	nmemb,
		void *	data
	)

Write the downloaded content to a _HINTERNET structure.

Parameters

buffer	the buffer to read
size	size of each member
nmemb	number of element to read
data	the _HINTERNET structure to write in

Returns

the size red, -1 if buffer is NULL

write_data_into_file()

size_t write_data_into_file	(	void *	buffer,
		size_t	size,
		size_t	nmemb,
		void *	data
	)

Write the downloaded content in the file pouted by the _HINTERNET structure.

Parameters

buffer	the buffer to read
size	size of each member
nmemb	number of element to read
data	the _HINTERNET structure to write in

Returns

the size red, -1 if buffer is NULL