prefs.c File Reference

Implementation of API to handle globally stored preferences. More...

#include "settings.h"
#include <glib.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Include dependency graph for prefs.c:

Go to the source code of this file.

Functions
void	prefs_set (const gchar *key, const gchar *value)
	Set a string preference value via a key. More...
static void	prefs_init (void)
	Initializes the preferences structure. If it was already initialized, remove old settings and start from scratch. More...
GHashTable *	preferences_get (void)
	Get the pointer to the global preferences structure. Eventually this function should not be used anywhere. More...
const gchar *	prefs_get (const gchar *key)
	Get a string preference value via a key. More...
int	prefs_get_bool (const gchar *key)
	Get a boolean expression of a preference value via a key. More...
void	prefs_config (const char *config)
	Apply the configs from given file as preferences. More...
void	prefs_dump (void)
	Dump the preferences to stdout. More...
int	prefs_nvt_timeout (const char *oid)
	Returns the timeout defined by the client or 0 if none was set. More...

Variables
static GHashTable *	global_prefs = NULL

Detailed Description

Implementation of API to handle globally stored preferences.

A global store of preferences to scanner and NVTs is handled by this module.

Definition in file prefs.c.

Function Documentation

preferences_get()

GHashTable* preferences_get

(

void

)

Get the pointer to the global preferences structure. Eventually this function should not be used anywhere.

Returns

Pointer to the global preferences structure.

Definition at line 72 of file prefs.c.

{
  if (!global_prefs)
    prefs_init ();

  return global_prefs;
}

References global_prefs, and prefs_init().

Here is the call graph for this function:

prefs_config()

void prefs_config

(

const char *

config

)

Apply the configs from given file as preferences.

Parameters

config

Filename of the configuration file.

Definition at line 147 of file prefs.c.

{
  settings_iterator_t settings;
  char buffer[2048];

  if (!global_prefs)
    prefs_init ();

  strncpy (buffer, config, sizeof (buffer));
  if (!init_settings_iterator_from_file (&settings, buffer, "Misc"))
    {
      while (settings_iterator_next (&settings))
        prefs_set (settings_iterator_name (&settings),
                   settings_iterator_value (&settings));

      cleanup_settings_iterator (&settings);
    }

  prefs_set ("config_file", buffer);
}

References cleanup_settings_iterator(), global_prefs, init_settings_iterator_from_file(), prefs_init(), prefs_set(), settings_iterator_name(), settings_iterator_next(), and settings_iterator_value().

Here is the call graph for this function:

prefs_dump()

void prefs_dump

(

void

)

Dump the preferences to stdout.

Definition at line 172 of file prefs.c.

{
  void *name, *value;
  GHashTableIter iter;

  if (global_prefs)
    {
      g_hash_table_iter_init (&iter, global_prefs);
      while (g_hash_table_iter_next (&iter, &name, &value))
        {
          printf ("%s = %s\n", (char *) name, (char *) value);
        }
    }
}

References global_prefs.

prefs_get()

const gchar* prefs_get

(

const gchar *

key

)

Get a string preference value via a key.

Parameters

key	The identifier for the preference.

Returns

A pointer to a string with the value for the preference. NULL in case for the key no preference was found or the preference is not of type string.

Definition at line 90 of file prefs.c.

{
  if (!global_prefs)
    prefs_init ();

  return g_hash_table_lookup (global_prefs, key);
}

References global_prefs, and prefs_init().

Referenced by prefs_nvt_timeout().

Here is the call graph for this function:

Here is the caller graph for this function:

prefs_get_bool()

int prefs_get_bool

(

const gchar *

key

)

Get a boolean expression of a preference value via a key.

Parameters

key	The identifier for the preference.

Returns

1 if the value is considered to represent "true" and 0 if the value is considered to represent "false". If the preference is of type string, value "yes" is true, anything else is false. Any other type or non-existing key is false.

Definition at line 110 of file prefs.c.

{
  gchar *str;

  if (!global_prefs)
    prefs_init ();

  str = g_hash_table_lookup (global_prefs, key);
  if (str && !strcmp (str, "yes"))
    return 1;

  return 0;
}

References global_prefs, and prefs_init().

Here is the call graph for this function:

prefs_init()

static void prefs_init ( void  )

static

Initializes the preferences structure. If it was already initialized, remove old settings and start from scratch.

Definition at line 46 of file prefs.c.

{
  if (global_prefs)
    g_hash_table_destroy (global_prefs);

  global_prefs =
    g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
  prefs_set ("cgi_path", "/cgi-bin:/scripts");
  prefs_set ("checks_read_timeout", "5");
  prefs_set ("unscanned_closed", "yes");
  prefs_set ("unscanned_closed_udp", "yes");
  prefs_set ("timeout_retry", "3");
  prefs_set ("expand_vhosts", "yes");
  prefs_set ("test_empty_vhost", "no");
  prefs_set ("open_sock_max_attempts", "5");
  prefs_set ("time_between_request", "0");
  prefs_set ("nasl_no_signature_check", "yes");
}

References global_prefs, and prefs_set().

Referenced by preferences_get(), prefs_config(), prefs_get(), prefs_get_bool(), and prefs_set().

Here is the call graph for this function:

Here is the caller graph for this function:

prefs_nvt_timeout()

int prefs_nvt_timeout

(

const char *

oid

)

Returns the timeout defined by the client or 0 if none was set.

Parameters

oid	OID of NVT to ask timeout value of.

Returns

0 if no timeout for the NVT oid was found, timeout in seconds otherwise.

Definition at line 196 of file prefs.c.

{
  char *pref_name = g_strdup_printf ("timeout.%s", oid);
  const char *val = prefs_get (pref_name);
  int timeout = (val ? atoi (val) : 0);

  g_free (pref_name);

  return timeout;
}

References prefs_get().

Here is the call graph for this function:

prefs_set()

void prefs_set	(	const gchar *	key,
		const gchar *	value
	)

Set a string preference value via a key.

Parameters

key	The identifier for the preference. A copy of this will be created if necessary.
value	The value to set. A copy of this will be created.

Definition at line 133 of file prefs.c.

{
  if (!global_prefs)
    prefs_init ();

  g_hash_table_insert (global_prefs, g_strdup (key), g_strdup (value));
}

References global_prefs, and prefs_init().

Referenced by prefs_config(), and prefs_init().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

global_prefs

GHashTable* global_prefs = NULL

static

Definition at line 35 of file prefs.c.

Referenced by preferences_get(), prefs_config(), prefs_dump(), prefs_get(), prefs_get_bool(), prefs_init(), and prefs_set().