erbrowser/src/browserSettings.h File Reference

browser - read/write the browser settings and configure mozilla with these settings More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_ProxySettings
struct	_BrowserSettings
Defines
#define	PREF_ID   NS_PREF_CONTRACTID
#define	MAX_SETTINGSPATH_LENGTH   128
#define	MAX_PROXY   15
#define	MAX_PROXY_PORT   5
#define	MAX_URL_SIZE   256
#define	CONFIG_FILE_NAME   "/config"
#define	STARTUP_FILE_NAME   "/startup"
Typedefs
typedef struct _ProxySettings	ProxySettings
typedef struct _BrowserSettings	BrowserSettings
Functions
gboolean	browser_settings_init (GtkMozEmbed *b)
gboolean	browser_settings_store (void)
gboolean	browser_settings_get (BrowserSettings *theBrowserSettings)
gboolean	browser_settings_set_mozilla_settings (BrowserSettings *theBrowserSettings)
float	browser_settings_get_zoom_factor (void)
void	browser_settings_set_zoom_factor (float zoom_factor)

---

Detailed Description

browser - read/write the browser settings and configure mozilla with these settings

<File description>="">

Definition in file browserSettings.h.

---

Define Documentation

#define CONFIG_FILE_NAME   "/config"

Definition at line 39 of file browserSettings.h.

#define MAX_PROXY   15

Definition at line 35 of file browserSettings.h.

#define MAX_PROXY_PORT   5

Definition at line 36 of file browserSettings.h.

#define MAX_SETTINGSPATH_LENGTH   128

Definition at line 34 of file browserSettings.h.

#define MAX_URL_SIZE   256

Definition at line 37 of file browserSettings.h.

#define PREF_ID   NS_PREF_CONTRACTID

Definition at line 33 of file browserSettings.h.

#define STARTUP_FILE_NAME   "/startup"

Definition at line 40 of file browserSettings.h.

---

Typedef Documentation

typedef struct _BrowserSettings BrowserSettings

typedef struct _ProxySettings ProxySettings

---

Function Documentation

gboolean browser_settings_get

(

BrowserSettings *

theBrowserSettings

)

retrieve the current content of the settingsfile

Parameters:

theBrowserSettings

where the retreived values should be stored

Returns:

TRUE in case of succes

Definition at line 137 of file browserSettings.cpp.

{
    FILE   *settings_file = NULL;
    gchar  *filename = NULL;

    BR_LOGPRINTF("entry");

    if (theBrowserSettings)
    {
        filename = g_strconcat(gBrowserSettingsPath, CONFIG_FILE_NAME, NULL);
        settings_file = fopen(filename, "r");

        if (settings_file)
        {
            fscanf(settings_file, "directconnection=%d\n", &theBrowserSettings->theProxySettings.direct_connection);
            fscanf(settings_file, "http_proxy=%s\n", &theBrowserSettings->theProxySettings.http_proxy);
            fscanf(settings_file, "http_proxy_port=%s\n", &theBrowserSettings->theProxySettings.http_proxy_port);
            fscanf(settings_file, "ftp_proxy=%s\n", &theBrowserSettings->theProxySettings.ftp_proxy);
            fscanf(settings_file, "ftp_proxy_port=%s\n", &theBrowserSettings->theProxySettings.ftp_proxy_port);
            fscanf(settings_file, "ssl_proxy=%s\n", &theBrowserSettings->theProxySettings.ssl_proxy);
            fscanf(settings_file, "ssl_proxy_port=%s\n", &theBrowserSettings->theProxySettings.ssl_proxy_port);
            fscanf(settings_file, "no_proxy_for=%s\n", &theBrowserSettings->theProxySettings.no_proxy_for);
            fscanf(settings_file, "zoom_factor=%f\n", &theBrowserSettings->zoom_factor);

            fclose(settings_file);
        }
        else
        {
            BR_ERRORPRINTF("could not open settings file %s", filename);
        }

        g_free(filename);
        return TRUE;

    }
    else
    {
        BR_ERRORPRINTF("input parameter == NULL");
        return FALSE;
    }
}

float browser_settings_get_zoom_factor

(

void

)

Method used to retrieve the zoomfactor used by the browser .

Returns:

zoomfactor

Definition at line 362 of file browserSettings.cpp.

{
    return gBrowserSettings.zoom_factor;
}

gboolean browser_settings_init

(

GtkMozEmbed *

b

)

creates (if needed) the directory on the system used to store the settings files retrieve the current browser settings and use these to configure mozilla/Gecko.

Parameters:

b

reference to the MozEmbed widget

Returns:

TRUE in case of succes

Definition at line 66 of file browserSettings.cpp.

{
    gboolean returnValue = FALSE;
    gchar  *directory;
    gchar  *browserUserHomePath;
    gchar  *filename;
    BrowserSettings *theBrowserSettings;

    BR_LOGPRINTF("entry");

    browserUserHomePath = PR_GetEnv("HOME");

    if (!browserUserHomePath)
    {
        BR_ERRORPRINTF("Failed to get HOME");
        return returnValue;
    }

    // create directory [g_strconcat alllocates memory]
    directory = g_strconcat(browserUserHomePath, "/.Browser", NULL);
    mkdir(directory, 0755);

    // store the path value
    if (strlen(directory) < MAX_SETTINGSPATH_LENGTH)
    {
        g_strlcpy(gBrowserSettingsPath, directory, MAX_SETTINGSPATH_LENGTH);
    }

    g_free(directory);

    BR_LOGPRINTF("path %s", gBrowserSettingsPath);

    filename = g_strconcat(gBrowserSettingsPath, CONFIG_FILE_NAME, NULL);

    theBrowserSettings = &gBrowserSettings;

    if (g_file_test(filename, G_FILE_TEST_EXISTS) == TRUE)
    {
        //retrieve the current content of the settingsfile 
        returnValue = browser_settings_get(theBrowserSettings);
    }
    else
    {
        browser_settings_get_defaults(theBrowserSettings);
        theBrowserSettings->zoom_factor = 1.0;
        returnValue = TRUE;
    }

    //only for debug reasons
    browser_display_settings(&gBrowserSettings);

    browser_settings_set_mozilla_settings(theBrowserSettings);
    
    // MvdW: Quick hack to allow XHTML navigation with hardkeys:
    //  made focus_ring visible, so links are outlined
    //  this needs to be moved to more generic settings functions
    //  which also need to read the registry for proxy settings and such
    mozilla_pref_set_int("browser.display.focus_ring_width", 3);
    mozilla_pref_set_boolean("browser.display.focus_ring_on_anything", TRUE);

    g_free(filename);

    return returnValue;
}

Here is the call graph for this function:

gboolean browser_settings_set_mozilla_settings

(

BrowserSettings *

theBrowserSettings

)

configure mozilla with the current settings

Parameters:

theBrowserSettings

the current settings

Returns:

TRUE in case of succes

Definition at line 282 of file browserSettings.cpp.

{
    // set proxy preferences 
    browser_set_proxy_prefs(&theBrowserSettings->theProxySettings);
    mozilla_save_prefs();
    return TRUE;
}

Here is the call graph for this function:

void browser_settings_set_zoom_factor

(

float

zoom_factor

)

Method used to set the the zoomfactor used by the browser .

Returns:

void

Definition at line 367 of file browserSettings.cpp.

{
    if (zoom_factor >= 0)
    {
        gBrowserSettings.zoom_factor = zoom_factor;
    }
}

gboolean browser_settings_store

(

void

)

write the current browser settings into $home/.Browser/config

Returns:

TRUE in case of succes