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

#include "web_main.h"
#include "../cl_shared.h"
#include "../ui/ui_main.h"
#include "web_cgame.h"
#include "../../common/sha1.h"

Include dependency graph for web_main.cpp:

Go to the source code of this file.

Functions
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.
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.
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.
static void	WEB_AuthResponse (const char response, void userdata)
	The callback for the web auth request.
bool	WEB_Auth (const char username, const char password)
	Performs a web auth request.
static void	WEB_Auth_f (void)
	Console callback for handling the web auth.
bool	WEB_CheckAuth (void)
	Pushes the webauth window if the password is not yet set.
void	WEB_InitStartup (void)

Variables
static cvar_t *	web_authurl
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.cpp.

Function Documentation

◆ WEB_Auth()

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, password, Q_strlwr(), Q_strncpyz(), Q_strvalid, user, WEB_AuthResponse(), web_authurl, WEB_GetURL(), and web_password.

Referenced by TEST_F(), and WEB_Auth_f().

◆ WEB_Auth_f()

void WEB_Auth_f ( void )

static

Console callback for handling the web auth.

See also: WEB_Auth

Definition at line 159 of file web_main.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), UI_ExecuteConfunc(), and WEB_Auth().

Referenced by WEB_InitStartup().

◆ WEB_AuthResponse()

void WEB_AuthResponse	(	const char *	response,
		void *	userdata )

static

The callback for the web auth request.

Parameters

[in]	response	The web auth response
[in]	userdata	The userdata. `NULL` in this case.

Definition at line 110 of file web_main.cpp.

References Com_DPrintf(), Cvar_Set(), DEBUG_CLIENT, and Q_streq.

Referenced by WEB_Auth(), and WEB_InitStartup().

◆ WEB_CheckAuth()

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(), UI_PushWindow(), and web_password.

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

◆ WEB_GetToFile()

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(), FILE, HTTP_Encode(), HTTP_GetToFile(), MAX_VAR, web_password, and web_username.

◆ WEB_GetURL()

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(), web_password, and web_username.

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

◆ 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, Sys_GetCurrentUser(), WEB_API_SERVER, WEB_Auth_f(), WEB_AuthResponse(), web_authurl, WEB_CGameCommands(), WEB_CGameCvars(), WEB_GetURL(), web_password, web_userid, and web_username.

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

◆ WEB_PutFile()

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.