gnome-vfs-standard-callbacks

gnome-vfs-standard-callbacks — standard callbacks for use by gnome-vfs module writers

Synopsis

#define             GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION
                    GnomeVFSModuleCallbackFillAuthenticationIn;
                    GnomeVFSModuleCallbackFillAuthenticationOut;
#define             GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION
enum                GnomeVFSModuleCallbackFullAuthenticationFlags;
                    GnomeVFSModuleCallbackFullAuthenticationIn;
                    GnomeVFSModuleCallbackFullAuthenticationOut;
enum                GnomeVFSModuleCallbackFullAuthenticationOutFlags;
#define             GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION
                    GnomeVFSModuleCallbackSaveAuthenticationIn;
                    GnomeVFSModuleCallbackSaveAuthenticationOut;
#define             GNOME_VFS_MODULE_CALLBACK_QUESTION
                    GnomeVFSModuleCallbackQuestionIn;
                    GnomeVFSModuleCallbackQuestionOut;
#define             GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE
                    GnomeVFSModuleCallbackStatusMessageIn;
                    GnomeVFSModuleCallbackStatusMessageOut;
#define             GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS
                    GnomeVFSModuleCallbackAdditionalHeadersIn;
                    GnomeVFSModuleCallbackAdditionalHeadersOut;
#define             GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS
                    GnomeVFSModuleCallbackReceivedHeadersIn;
                    GnomeVFSModuleCallbackReceivedHeadersOut;
#define             GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION
#define             GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION
enum                GnomeVFSModuleCallbackAuthenticationAuthType;
                    GnomeVFSModuleCallbackAuthenticationIn;
                    GnomeVFSModuleCallbackAuthenticationOut;

Description

Details

GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION

#define GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION "fill-authentication"

A module callback name used together with gnome_vfs_module_callback_invoke() to ask the keyring manager for login data. It is expected to return stored or cached login data, but may not query the user.

The login data consists of a username, a password and a domain, and is used to access a resource. If the data is not suitable for accessing the resource, the GnomeVFSModule typically issues a GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION module callback to query the user right after the authentication failed.

in arg :

A GnomeVFSModuleCallbackFillAuthenticationIn * passed to the application, specifying the authentication request. The application will usually proxy this request to the keyring manager of the desktop environment, but it can also handle the request itself.

out arg :

A GnomeVFSModuleCallbackFillAuthenticationOut * passing the cached keyring data (i.e. username/password etc.) back to the module. Usually, this is data that was stored using GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION, and is either stored permanently on disk or cached.

GnomeVFSModuleCallbackFillAuthenticationIn

typedef struct {
	char *uri;
	char *protocol;
	char *server;
	char *object;
	int port;
	char *authtype;
	char *username;
	char *domain;
} GnomeVFSModuleCallbackFillAuthenticationIn;

A pointer to a GnomeVFSModuleCallbackFillAuthenticationIn structure is passed to the GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION callback, and informs the application about the authentication parameters that should be requested from the user.

The GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION application callback will then set the members of a pointer to a GnomeVFSModuleCallbackFillAuthenticationOut structure according to the stored or cached data.

char *uri;

The textual URI of the resource that requires authentication.

char *protocol;

One of the protocols supported by the invoking module. Typically matches uri's protocol.

char *server;

The server that contains the resource that requires authentication. Typically matches uri's hostname.

char *object;

The type of the resource that requires authentication.

int port;

The port that was used to connect to server. 0 means unset.

char *authtype;

The type of authentication that was requested. For the HTTP method, this may be "basic" or "proxy". For the SFTP method, this may be "publickey" or "password".

char *username;

The username that was used to connect to server.

char *domain;

The domain that server belongs to (only used by the SMB method).

GnomeVFSModuleCallbackFillAuthenticationOut

typedef struct {
	gboolean valid;
	char *username;
	char *domain;
	char *password;
} GnomeVFSModuleCallbackFillAuthenticationOut;

A pointer to a GnomeVFSModuleCallbackFillAuthenticationOut structure is passed to the GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION callback, and informs the module about the authentication parameters that were found in the cache or permanently stored.

The login data returned by GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION was usually previously stored using #GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION.

gboolean valid;

Whether stored or cached login data was found for the resource referenced by the GnomeVFSModuleCallbackFillAuthenticationIn structure.

char *username;

The cached username that should be used to access the resource. This will be freed by the module when it isn't needed any longer. May only be set if valid is TRUE.

char *domain;

The cached domain that should be used to access the resource. This will be freed by the module when it isn't needed any longer. May only be set if valid is TRUE.

char *password;

The cached password that should be used to access the resource. This will be freed by the module when it isn't needed any longer. May only be set if valid is TRUE.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION

#define GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION "full-authentication"

A module callback name used together with gnome_vfs_module_callback_invoke() to ask the user for login data. This includes username and password, but also special login choices like anonymous login.

in arg :

A GnomeVFSModuleCallbackFullAuthenticationIn * passed to the application, specifying the authentication request.

out arg :

A GnomeVFSModuleCallbackFullAuthenticationOut * passing the user's provided authentication data (i.e. his username/password etc.) back to the module.

enum GnomeVFSModuleCallbackFullAuthenticationFlags

typedef enum {
	GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_PREVIOUS_ATTEMPT_FAILED = 1<<0,
	GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSWORD = 1<<1,
	GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME = 1<<2,
	GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_DOMAIN = 1<<3,
	GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED = 1<<4,
	GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_ANON_SUPPORTED = 1<<5
} GnomeVFSModuleCallbackFullAuthenticationFlags;

These flags will be passed to the GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION callback, as part of the GnomeVFSModuleCallbackFullAuthenticationIn structure. The output data will be stored in a GnomeVFSModuleCallbackFullAuthenticationOut structure.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_PREVIOUS_ATTEMPT_FAILED

This is not the first login attempt, i.e. this callback was already invoked but the provided login data was not suitable for a successful login.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSWORD

The application should ask the user for a password and set the password field of GnomeVFSModuleCallbackFullAuthenticationOut.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME

The application should ask the user for a username and set the username field of GnomeVFSModuleCallbackFullAuthenticationOut.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_DOMAIN

The application should ask the user for a domain and set the domain field of GnomeVFSModuleCallbackFullAuthenticationOut.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED

The application may ask the user whether he wants to save the password. If this flag is not present, or the user does not want to save the password, the application must set the save_password field of GnomeVFSModuleCallbackFullAuthenticationOut to FALSE and its keyring field to NULL. If the save_password field is TRUE, the module invoking the GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION callback is expected to invoke the GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION callback if the login attempt was successful with the username, password, domain and keyring fields of GnomeVFSModuleCallbackFullAuthenticationOut.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_ANON_SUPPORTED

The application should offer the user a choice to login anonymously (used for example by the FTP module). If the user requests anonymous login, GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED must be set in the out_flags field of GnomeVFSModuleCallbackFullAuthenticationOut.

GnomeVFSModuleCallbackFullAuthenticationIn

typedef struct {
	GnomeVFSModuleCallbackFullAuthenticationFlags flags;

	char *uri;
	char *protocol;
	char *server;
	char *object;
	int port;
	char *authtype;
	char *username;
	char *domain;

	/* for pre-filling the dialog */
	char *default_user;     
	char *default_domain;
} GnomeVFSModuleCallbackFullAuthenticationIn;

A pointer to a GnomeVFSModuleCallbackFullAuthenticationIn structure is passed to the GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION callback, and informs the application about the authentication parameters that should be requested from the user.

The GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION application callback will then set the members of a pointer to a GnomeVFSModuleCallbackFullAuthenticationOut structure according to the user input.

GnomeVFSModuleCallbackFullAuthenticationFlags flags;

GnomeVFSModuleCallbackFullAuthenticationFlags influencing the user query.

char *uri;

The textual URI of the resource that requires authentication.

char *protocol;

One of the protocols supported by the invoking module. Typically matches uri's protocol.

char *server;

The server that contains the resource that requires authentication. Typically matches uri's hostname.

char *object;

The type of the resource that requires authentication.

int port;

The port that was used to connect to server. 0 means unset.

char *authtype;

The type of authentication that was requested. For the HTTP method, this may be "basic" or "proxy". For the SFTP method, this may be "publickey" or "password".

char *username;

The username that was used to connect to server. This variable should just be used for display purposes, i.e. like You were trying to access foobar.com where foo is the username and bar.com is the server. Do not make the contents of the GnomeVFSModuleCallbackFullAuthenticationOut output variables depend on the value of this variable. If you want to handle absence of user input, pass back default_user instead.

char *domain;

The domain that server belongs to (only used by the SMB method). This variable should just be used for display purposes where foo is the username and bar.com is the server. Do not make the contents of the GnomeVFSModuleCallbackFullAuthenticationOut output variables depend on the value of this variable. If you want to handle absence of user input, pass back default_domain instead.

char *default_user;

The username that should be provided to the user by default. Typically matches username.

char *default_domain;

The domain that should be provided to the user by default. Typically matches domain.

GnomeVFSModuleCallbackFullAuthenticationOut

typedef struct {
	gboolean abort_auth;

	char *username;
	char *domain;
	char *password;

	gboolean save_password;
	char *keyring;

	gsize out_flags;
} GnomeVFSModuleCallbackFullAuthenticationOut;

A pointer to a GnomeVFSModuleCallbackFullAuthenticationOut structure is passed to the GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION callback, and informs the module about the authentication parameters that the user provided by setting the respective fields according to the user input and the passed-in GnomeVFSModuleCallbackFullAuthenticationIn pointer.

gboolean abort_auth;

Whether the user somehow cancelled the login process. The application is expected to offer the user a cancellation point during the authentication query. In a graphical user interface, this is typically achieved by providing a "Cancel" button.

char *username;

The user-provided username that should be used to access the resource referenced by GnomeVFSModuleCallbackFullAuthenticationIn. This will be freed by the module when it isn't needed any longer. Must not be set if the GnomeVFSModuleCallbackFullAuthenticationFlags don't contain GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME.

char *domain;

The user-provided domain that should be used to access the resource referenced by GnomeVFSModuleCallbackFullAuthenticationIn. This will be freed by the module when it isn't needed any longer. Must not be set if the GnomeVFSModuleCallbackFullAuthenticationFlags don't contain GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_DOMAIN.

char *password;

The user-provided password that should be used to access the resource referenced by GnomeVFSModuleCallbackFullAuthenticationIn. This will be freed by the module when it isn't needed any longer. Must not be set if the GnomeVFSModuleCallbackFullAuthenticationFlags don't contain GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSOWRD.

gboolean save_password;

Flags whether the user requested to save the provided login data. Must be FALSE if the GnomeVFSModuleCallbackFullAuthenticationFlags don't contain GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED.

char *keyring;

Flags which keyring should be used to save the password. This will later be passed to the GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION callback if the login attempt was successful with the specified username, password and domain. This will NOT be freed by the module, so the application typically provides a NULL pointer or a pointer to a static string.

gsize out_flags;

GnomeVFSModuleCallbackFullAuthenticationOutFlags signalling a special request, for instance anonymous access to an FTP server.

enum GnomeVFSModuleCallbackFullAuthenticationOutFlags

typedef enum {
	GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED = 1<<0
} GnomeVFSModuleCallbackFullAuthenticationOutFlags;

These flags will be passed from a GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION callback back to the module, as part of the GnomeVFSModuleCallbackFullAuthenticationOut structure.

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED

Anonymous login requested. May only be set if the GnomeVFSModuleCallbackFullAuthenticationIn's GnomeVFSModuleCallbackFullAuthenticationFlags contain GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_ANON_SUPPORTED.

GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION

#define GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION "save-authentication"

A module callback name used together with gnome_vfs_module_callback_invoke() to request permanent or temporary storage of login data. The storage is typically done using a keyring manager.

Called after a successfull authentication, to allow the client to e.g. store the password for future use. It may be queried again within the current session (temporary storage) or in future sessions (permanent storage) using GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION.

This is typically called after the user provided login data with GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.

in arg :

A GnomeVFSModuleCallbackSaveAuthenticationIn * specifying the login data.

out arg :

A GnomeVFSModuleCallbackSaveAuthenticationOut * (unused).

GnomeVFSModuleCallbackSaveAuthenticationIn

typedef struct {
	char *keyring;
	
	char *uri;
	char *protocol;
	char *server;
	char *object;
	int port;
	char *authtype;
	char *username;
	char *domain;
	char *password;
} GnomeVFSModuleCallbackSaveAuthenticationIn;

A GnomeVFSModuleCallbackSaveAuthenticatioIn pointer is passed to a GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION application callback, and specifies the login data that should be stored permanently on disk or temporarily cached.

This data may be queried in future sessions (permanent storage) or within the current session (temporary storage) using GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION.

char *keyring;

Keyring provided by GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION callback.

char *uri;

The textual URI of the resource that is accessed.

char *protocol;

One of the protocols supported by the invoking module. Typically matches uri's protocol.

char *server;

The server that contains the resource that is accessed. Typically matches uri's hostname.

char *object;

The type of the resource that is accessed.

int port;

The port that was used to connect to server. 0 means unset.

char *authtype;

The type of authentication that was requested. For the HTTP method, this may be "basic" or "proxy". For the SFTP method, this may be "publickey" or "password".

char *username;

The username that was used to connect to server.

char *domain;

The domain that server belongs to (only used by the SMB method).

char *password;

The password that was used to connect to server.

GnomeVFSModuleCallbackSaveAuthenticationOut

typedef struct {
} GnomeVFSModuleCallbackSaveAuthenticationOut;

A GnomeVFSModuleCallbackSaveAuthenticationOut pointer is passed to a GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION application callback, and is reserved for future use. Applications are not expected to modify this data, because its interpretation might change in the future.


GNOME_VFS_MODULE_CALLBACK_QUESTION

#define GNOME_VFS_MODULE_CALLBACK_QUESTION "ask-question"

A module callback name used together with gnome_vfs_module_callback_invoke() to ask the user a question.

Called when access to a URI requires the user to make a choice.

in arg :

A GnomeVFSModuleCallbackFullAuthenticationIn * passed to the application,

out arg :

specifying the proxy authentication request. A GnomeVFSModuleCallbackFullAuthenticationOut * passing the user's provided proxy authentication data (i.e. his username/password) back to the module.

GnomeVFSModuleCallbackQuestionIn

typedef struct {
	char *primary_message;
	char *secondary_message;
	char **choices;
} GnomeVFSModuleCallbackQuestionIn;

A GnomeVFSModuleCallbackQuestionIn pointer is passed to a GNOME_VFS_MODULE_CALLBACK_QUESTION application callback. Applications are expected to request a decision from the user, and store the answer in a GnomeVFSModuleCallbackQuestionOut structure.

char *primary_message;

A short message explaining the question to the user, or NULL if there is no message.

char *secondary_message;

The long version of the message, containing more details, or NULL if there is no message.

char **choices;

NULL-terminated string list of choices the user has to choose from. The first item in the list should be affermative, and will be put on the right in a GUI dialog.

GnomeVFSModuleCallbackQuestionOut

typedef struct {
	int answer;
} GnomeVFSModuleCallbackQuestionOut;

A GnomeVFSModuleCallbackQuestionOut pointer is passed to a GNOME_VFS_MODULE_CALLBACK_QUESTION application callback, and is used by applications to store the user's decision.

int answer;

The index of the answer the user picked. Matches the base pointer address of the user's choice in GnomeVFSModuleCallbackQuestionIn, i.e. its index in choices, where the first choice has index 0.

GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE

#define GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE "status-message"

A module callback name used together with gnome_vfs_module_callback_invoke() to inform the user about an ongoing operation.

Called when a GnomeVFSModule has a status message to return to the user.

in arg :

A GnomeVFSModuleCallbackStatusMessageIn * containing the message to present to the user.

out arg :

A GnomeVFSModuleCallbackStatusMessageOut * (not used).

GnomeVFSModuleCallbackStatusMessageIn

typedef struct {
	char *uri;
	char *message;
	int percentage;
} GnomeVFSModuleCallbackStatusMessageIn;

A GnomeVFSModuleCallbackStatusMessageIn pointer is passed to a GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE application callback, to inform it about the progress and/or status of an ongoing operation.

char *uri;

The textual URI the status message refers to.

char *message;

The message the application should display to the user, indicating the current state, or it is NULL.

int percentage;

The percentage indicating the completeness of a currently pending operation on uri (1-100), or -1 if there is no progress percentage to report.

GnomeVFSModuleCallbackStatusMessageOut

typedef struct {
	/* empty structs not allowed */
	int dummy;
} GnomeVFSModuleCallbackStatusMessageOut;

A GnomeVFSModuleCallbackStatusMessageOut pointer is passed to a GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE application callback, and is reserved for future use. Applications are not expected to modify this data, because its interpretation might change in the future.

int dummy;

unused.

GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS

#define GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS "http:send-additional-headers"

A module callback name used together with gnome_vfs_module_callback_invoke() to request additional HTTP headers.

Called before sending headers to an HTTP server. Client applications can add additional headers.

in arg :

A GnomeVFSModuleCallbackAdditionalHeadersIn * identifying the resource.

out arg :

A GnomeVFSModuleCallbackAdditionalHeadersOut * allowing to add headers to the request.

GnomeVFSModuleCallbackAdditionalHeadersIn

typedef struct {
	GnomeVFSURI *uri;
} GnomeVFSModuleCallbackAdditionalHeadersIn;

A GnomeVFSModuleCallbackAdditionalHeadersIn pointer is passed to a GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS application callback, to inform it about a pending HTTP request and allow it to add additional headers.

GnomeVFSURI *uri;

A GnomeVFSURI identifying the resource of the currently pending request.

GnomeVFSModuleCallbackAdditionalHeadersOut

typedef struct {
	GList *headers;
} GnomeVFSModuleCallbackAdditionalHeadersOut;

A GnomeVFSModuleCallbackAdditionalHeadersOut pointer is passed to a GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS application callback, to store the headers the application wants to add to a pending HTTP request.

GList *headers;

A GList of strings, each of them is an additional header that is added to the HTTP request. headers and all its strings will be freed by the module when they aren't needed any longer.

GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS

#define GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS "http:received-headers"

A module callback name used together with gnome_vfs_module_callback_invoke() to inform an application about the delivery of a HTTP request.

GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS is called after receiving HTTP headers from a server that belonged to a HTTP request that was issued by the application and allows the application to analyze the returned headers.


GnomeVFSModuleCallbackReceivedHeadersIn

typedef struct {
	GnomeVFSURI *uri;
	GList *headers;
} GnomeVFSModuleCallbackReceivedHeadersIn;

A GnomeVFSModuleCallbackReceivedHeadersIn pointer is passed to a GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS application callback, to inform it about a delivered HTTP request and allow it to analyze the returned headers.

GnomeVFSURI *uri;

A GnomeVFSURI identifying the resource of the currently delivered request.

GList *headers;

A GList of strings, each of them is a header that was received when delivering the HTTP request. headers and all its strings will be freed by the module when they aren't needed any longer.

GnomeVFSModuleCallbackReceivedHeadersOut

typedef struct {
	int dummy;
} GnomeVFSModuleCallbackReceivedHeadersOut;

A GnomeVFSModuleCallbackReceivedHeadersOut pointer is passed to a GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS application callback, and is reserved for future use. Applications are not expected to modify this data, because its interpretation might change in the future.

int dummy;

unused.

GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION

#define GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION "simple-authentication"

Warning

GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION is deprecated and should not be used in newly-written code. Modules should use GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION and GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.

A module callback name formerly used together with gnome_vfs_module_callback_invoke().

Formerly called when access to a URI requires a username/password.


GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION

#define GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION "http:proxy-authentication"

Warning

GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION is deprecated and should not be used in newly-written code. Proxy authentication now works desktop-wide through GConf.

A module callback name formerly used together with gnome_vfs_module_callback_invoke() to ask the user for HTTP proxy login data. It works exactly like GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION, and used to be kept separate to allow applications to distinguish proxy authentication from actual server authentication, so that the wording of the interface could be adapted.

Formerly called when access to an HTTP proxy required a username/password.


enum GnomeVFSModuleCallbackAuthenticationAuthType

typedef enum {
	AuthTypeBasic,
	AuthTypeDigest
} GnomeVFSModuleCallbackAuthenticationAuthType;

Warning

GnomeVFSModuleCallbackAuthenticationAuthType is deprecated and should not be used in newly-written code. Modules should use GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION and GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.

This defines the possible values of the GnomeVFSModuleCallbackAuthenticationIn's auth_type field.

AuthTypeBasic

transmit password unencrypted.

AuthTypeDigest

transmit digest instead of plaintext credentials.

GnomeVFSModuleCallbackAuthenticationIn

typedef struct {
	char *uri;
	char *realm;
	gboolean previous_attempt_failed;
	GnomeVFSModuleCallbackAuthenticationAuthType auth_type;
} GnomeVFSModuleCallbackAuthenticationIn;

Warning

GnomeVFSModuleCallbackAuthenticationIn is deprecated and should not be used in newly-written code. Modules should use GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION and GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.

A pointer to a GnomeVFSModuleCallbackAuthenticationIn structure that used to be passed to the GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION callback, and informed the application about the authentication parameters that should be requested.

char *uri;

The textual URI of the resource that requires authentication.

char *realm;

"auth" for HTTP, NULL for others.

gboolean previous_attempt_failed;

TRUE if there already was login data specified for this request, but the login failed. FALSE if no previous login attempt has been made right before this one.

GnomeVFSModuleCallbackAuthenticationAuthType auth_type;

Whether the login data will be transmitted in plaintext or encrypted.

GnomeVFSModuleCallbackAuthenticationOut

typedef struct {
	char *username;
	char *password;
} GnomeVFSModuleCallbackAuthenticationOut;

Warning

GnomeVFSModuleCallbackAuthenticationOut is deprecated and should not be used in newly-written code. Modules should use GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION and GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.

A pointer to a GnomeVFSModuleCallbackAuthenticationOut structure that used to be passed to the GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION callback, and was used to pass the login data back to the module.

char *username;

The username that should be used to access the resource referenced by GnomeVFSModuleCallbackFullAuthenticationIn, or NULL if no data was provided. This will be freed by the module when it isn't needed any longer.

char *password;

The password that should be used to access the resource referenced by GnomeVFSModuleCallbackFullAuthenticationIn. This will be freed by the module when it isn't needed any longer.