web_main.h File Reference

UFOAI web interface management. Authentication as well as uploading/downloading stuff to and from your account is done here. More...

#include "../../common/common.h"
#include "../../common/http.h"

Go to the source code of this file.

Macros
#define	WEB_API_SERVER   "http://ufoai.org/"

Functions
bool	WEB_CheckAuth (void)
	Pushes the webauth window if the password is not yet set. More...
bool	WEB_Auth (const char *username, const char *password)
	Performs a web auth request. More...
void	WEB_InitStartup (void)
bool	WEB_GetURL (const char *url, http_callback_t callback, void *userdata=nullptr)
	Downloads the given url and notify the callback. The login credentials are automatically added as GET parameters. More...
bool	WEB_GetToFile (const char *url, FILE *file)
	Downloads the given url directly into the given file. The login credentials are automatically added as GET parameters. More...
bool	WEB_PutFile (const char *formName, const char *fileName, const char *url, upparam_t *params=nullptr)
	Uploads a file to the server with the login credentials. More...

Variables
cvar_t *	web_username
cvar_t *	web_password
cvar_t *	web_userid

Detailed Description

UFOAI web interface management. Authentication as well as uploading/downloading stuff to and from your account is done here.

Definition in file web_main.h.

Macro Definition Documentation

#define WEB_API_SERVER   "http://ufoai.org/"

Definition at line 31 of file web_main.h.

Referenced by WEB_CGameCvars(), and WEB_InitStartup().

Function Documentation

bool WEB_Auth	(	const char *	username,
		const char *	password
	)

Performs a web auth request.

Parameters

[in]	username	The (unencoded) username
[in]	password	The (ununcoded) password

Note

the cvars web_username and web_password are going to become overridden here. If the auth failed, the cvar web_password is set to an empty string again.

Returns

true if the auth was successful, false otherwise.

Definition at line 135 of file web_main.cpp.

References Com_SHA1Buffer(), Com_sprintf(), Cvar_Set(), MAX_VAR, Q_strlwr(), Q_strncpyz(), Q_strvalid, cvar_s::string, user, WEB_AuthResponse(), and WEB_GetURL().

Referenced by TEST_F(), and WEB_Auth_f().

bool WEB_CheckAuth

(

void

)

Pushes the webauth window if the password is not yet set.

Returns

true if the user is authenticated, false otherwise

Definition at line 176 of file web_main.cpp.

References Q_strnull(), cvar_s::string, and UI_PushWindow().

Referenced by WEB_CGameDelete(), WEB_CGameListForUser(), and WEB_CGameUpload().

bool WEB_GetToFile	(	const char *	url,
		FILE *	file
	)

Downloads the given url directly into the given file. The login credentials are automatically added as GET parameters.

Parameters

[in]	url	The url to download
[in]	file	The file to write into

Returns

true if the download was successful, false otherwise

Definition at line 65 of file web_main.cpp.

References Com_Printf(), Com_sprintf(), HTTP_Encode(), HTTP_GetToFile(), MAX_VAR, and cvar_s::string.

bool WEB_GetURL	(	const char *	url,
		http_callback_t	callback,
		void *	userdata
	)

Downloads the given url and notify the callback. The login credentials are automatically added as GET parameters.

Parameters

[in]	url	The url to download
[in]	callback	The callback to given the downloaded data to
[in]	userdata	Userdata that is given to the callback

Returns

true if the download was successful, false otherwise

Definition at line 44 of file web_main.cpp.

References Com_Printf(), Com_sprintf(), HTTP_Encode(), HTTP_GetURL(), and cvar_s::string.

Referenced by WEB_Auth(), WEB_CGameDelete(), WEB_CGameListForUser(), and WEB_InitStartup().

void WEB_InitStartup

(

void

)

Definition at line 185 of file web_main.cpp.

References Cmd_AddCommand(), Com_Printf(), CVAR_ARCHIVE, Cvar_Get(), Cvar_Set(), Q_strvalid, cvar_s::string, Sys_GetCurrentUser(), WEB_API_SERVER, WEB_Auth_f(), WEB_AuthResponse(), WEB_CGameCommands(), WEB_CGameCvars(), and WEB_GetURL().

Referenced by CL_InitLocal(), and WebApiTest::SetUpTestCase().

bool WEB_PutFile	(	const char *	formName,
		const char *	fileName,
		const char *	url,
		upparam_t *	params
	)

Uploads a file to the server with the login credentials.

Parameters

[in]	formName	The name of the form to submit with the file upload
[in]	fileName	The filename to upload - this must be a full path, not a virtual filesystem path
[in]	url	The url to open
[in]	params	Additional parameters for the form. The username and password values are automatically filled in and don't have to be specified here.

Definition at line 87 of file web_main.cpp.

References HTTP_PutFile(), upparam_s::name, upparam_s::next, cvar_s::string, and upparam_s::value.

Referenced by WEB_CGameUpload().

Variable Documentation

cvar_t* web_password

Definition at line 34 of file web_main.cpp.

cvar_t* web_userid

Definition at line 35 of file web_main.cpp.

Referenced by TEST_F(), WEB_CGameDelete(), WEB_CGameListForUser(), and WEB_ListCGameFilesCallback().

cvar_t* web_username

Definition at line 33 of file web_main.cpp.