GNUnet  0.17.6
Typedefs | Functions
gnunet-daemon-hostlist_client.h File Reference

hostlist support. More...

#include "gnunet_core_service.h"
#include "gnunet_statistics_service.h"
#include "gnunet_util_lib.h"
Include dependency graph for gnunet-daemon-hostlist_client.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef void(* GNUNET_HOSTLIST_UriHandler) (const char *uri)
 Function that handles an advertised URI. More...
 

Functions

int GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c, struct GNUNET_STATISTICS_Handle *st, GNUNET_CORE_ConnectEventHandler *ch, GNUNET_CORE_DisconnectEventHandler *dh, GNUNET_HOSTLIST_UriHandler *msgh, int learn)
 Start downloading hostlists from hostlist servers as necessary. More...
 
void GNUNET_HOSTLIST_client_stop (void)
 Stop downloading hostlists from hostlist servers as necessary. More...
 

Detailed Description

hostlist support.

Downloads HELLOs via HTTP.

Author
Christian Grothoff

Definition in file gnunet-daemon-hostlist_client.h.

Typedef Documentation

◆ GNUNET_HOSTLIST_UriHandler

typedef void(* GNUNET_HOSTLIST_UriHandler) (const char *uri)

Function that handles an advertised URI.

Parameters
uri0-termianted URI of a hostlist

Definition at line 38 of file gnunet-daemon-hostlist_client.h.

Function Documentation

◆ GNUNET_HOSTLIST_client_start()

int GNUNET_HOSTLIST_client_start ( const struct GNUNET_CONFIGURATION_Handle c,
struct GNUNET_STATISTICS_Handle st,
GNUNET_CORE_ConnectEventHandler ch,
GNUNET_CORE_DisconnectEventHandler dh,
GNUNET_HOSTLIST_UriHandler msgh,
int  learn 
)

Start downloading hostlists from hostlist servers as necessary.

Parameters
cconfiguration to use
ststatistics handle to use
[out]chset to handler for CORE connect events
[out]dhset to handler for CORE disconnect events
[out]msghset to handler for CORE advertisement messages
learnshould we learn hostlist URLs from CORE
Returns
GNUNET_OK on success

Definition at line 1577 of file gnunet-daemon-hostlist_client.c.

1583 {
1584  char *filename;
1585  char *proxytype_str;
1586  int result;
1587 
1588  GNUNET_assert (NULL != st);
1589  if (0 != curl_global_init (CURL_GLOBAL_WIN32))
1590  {
1591  GNUNET_break (0);
1592  return GNUNET_SYSERR;
1593  }
1594  cfg = c;
1595  stats = st;
1596 
1597  /* Read proxy configuration */
1599  if (GNUNET_OK ==
1600  GNUNET_CONFIGURATION_get_value_string (cfg, "HOSTLIST", "PROXY", &proxy))
1601  {
1602  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Found proxy host: `%s'\n", proxy);
1603  /* proxy username */
1605  "HOSTLIST",
1606  "PROXY_USERNAME",
1607  &proxy_username))
1608  {
1610  "Found proxy username name: `%s'\n",
1611  proxy_username);
1612  }
1613 
1614  /* proxy password */
1616  "HOSTLIST",
1617  "PROXY_PASSWORD",
1618  &proxy_password))
1619  {
1621  "Found proxy password name: `%s'\n",
1622  proxy_password);
1623  }
1624 
1625  /* proxy type */
1627  "HOSTLIST",
1628  "PROXY_TYPE",
1629  &proxytype_str))
1630  {
1631  if (GNUNET_OK != GNUNET_STRINGS_utf8_toupper (proxytype_str,
1632  proxytype_str))
1634  "Unable to convert `%s' to UTF-8 uppercase\n",
1635  proxytype_str);
1636  proxy_type = CURLPROXY_HTTP;
1637  if (0 == strcmp (proxytype_str, "HTTP"))
1638  proxy_type = CURLPROXY_HTTP;
1639  else if (0 == strcmp (proxytype_str, "HTTP_1_0"))
1640  proxy_type = CURLPROXY_HTTP_1_0;
1641  else if (0 == strcmp (proxytype_str, "SOCKS4"))
1642  proxy_type = CURLPROXY_SOCKS4;
1643  else if (0 == strcmp (proxytype_str, "SOCKS5"))
1644  proxy_type = CURLPROXY_SOCKS5;
1645  else if (0 == strcmp (proxytype_str, "SOCKS4A"))
1646  proxy_type = CURLPROXY_SOCKS4A;
1647  else if (0 == strcmp (proxytype_str, "SOCKS5_HOSTNAME"))
1648  proxy_type = CURLPROXY_SOCKS5_HOSTNAME;
1649  else
1650  {
1651  GNUNET_log (
1653  _ (
1654  "Invalid proxy type: `%s', disabling proxy! Check configuration!\n"),
1655  proxytype_str);
1656  GNUNET_free (proxytype_str);
1657  GNUNET_free (proxy);
1658  proxy = NULL;
1660  proxy_username = NULL;
1662  proxy_password = NULL;
1663 
1664  return GNUNET_SYSERR;
1665  }
1666  }
1667  GNUNET_free (proxytype_str);
1668  }
1669 
1670  stat_learning = learn;
1671  *ch = &handler_connect;
1672  *dh = &handler_disconnect;
1673  linked_list_head = NULL;
1674  linked_list_tail = NULL;
1678 
1679  if (GNUNET_YES == stat_learning)
1680  {
1681  *msgh = &handler_advertisement;
1683  _ ("Learning is enabled on this peer\n"));
1684  load_hostlist_file ();
1686  "Hostlists will be saved to file again in %s\n",
1688  GNUNET_YES));
1691  NULL);
1692  }
1693  else
1694  {
1696  _ ("Learning is not enabled on this peer\n"));
1697  *msgh = NULL;
1699  "HOSTLIST",
1700  "HOSTLISTFILE",
1701  &filename))
1702  {
1704  {
1705  result = remove (filename);
1706  if (0 == result)
1707  GNUNET_log (
1709  _ (
1710  "Since learning is not enabled on this peer, hostlist file `%s' was removed\n"),
1711  filename);
1712  else
1714  "remove",
1715  filename);
1716  }
1717  }
1719  }
1721  "Loading stats value on hostlist download frequency\n");
1723  "hostlist",
1724  gettext_noop (
1725  "# milliseconds between hostlist downloads"),
1726  &primary_task,
1727  &process_stat,
1728  NULL);
1729  if (NULL == sget)
1730  {
1732  "Statistics request failed, scheduling hostlist download\n");
1734  }
1735  else
1736  {
1739  NULL);
1740  }
1741  return GNUNET_OK;
1742 }
#define gettext_noop(String)
Definition: gettext.h:69
static struct GNUNET_CADET_Channel * ch
Channel handle.
Definition: gnunet-cadet.c:117
static struct GNUNET_SCHEDULER_Task * st
The shutdown task.
#define SAVING_INTERVAL
Time interval hostlists are saved to disk.
static char * proxy
Proxy hostname or ip we are using (can be NULL).
static void handler_disconnect(void *cls, const struct GNUNET_PeerIdentity *peer, void *internal_cls)
Method called whenever a given peer disconnects.
static int process_stat(void *cls, const char *subsystem, const char *name, uint64_t value, int is_persistent)
We've received the previous delay value from statistics.
static void task_check(void *cls)
Task that checks if we should try to download a hostlist.
static void task_hostlist_saving(void *cls)
Task that writes hostlist entries to a file on a regular base.
static int stat_learning
Set if we are allowed to learn new hostlists and use them.
static struct Hostlist * linked_list_head
Head of the linked list used to store hostlists.
static void handler_advertisement(const char *uri)
Method called whenever an advertisement message arrives.
static unsigned int stat_use_bootstrap
Value saying if a preconfigured bootstrap server is used.
static void * handler_connect(void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_MQ_Handle *mq)
Method called whenever a given peer connects.
static struct GNUNET_STATISTICS_Handle * stats
Statistics handle.
static int stat_testing_allowed
Value controlling if a hostlist testing is allowed at the moment.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
static int stat_testing_hostlist
Value controlling if a hostlist is tested at the moment.
static struct GNUNET_PEERINFO_Handle * pi
Handle to peerinfo service.
static char * proxy_password
Proxy password we are using (can be NULL).
static void stat_timeout_task(void *cls)
Continuation called by the statistics code once we go the stat.
static struct GNUNET_STATISTICS_GetHandle * sget
Handle for our statistics GET operation.
static void load_hostlist_file()
Method to load persistent hostlist file during hostlist client startup.
static struct Hostlist * linked_list_tail
Tail of the linked list used to store hostlists.
static struct GNUNET_SCHEDULER_Task * ti_check_download
ID of the task, checking if hostlist download should take plate.
static struct GNUNET_SCHEDULER_Task * ti_saving_task
ID of the task saving the hostlsit in a regular interval.
static char * proxy_username
Proxy username we are using (can be NULL).
static curl_proxytype proxy_type
Proxy type we are using (can be NULL).
static void primary_task(void *cls, int success)
Continuation called by the statistics code once we go the stat.
static char * filename
static int result
Global testing status.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
enum GNUNET_GenericReturnValue GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory).
Definition: disk.c:482
#define GNUNET_log(kind,...)
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_YES
@ GNUNET_NO
Definition: gnunet_common.h:98
@ GNUNET_SYSERR
Definition: gnunet_common.h:97
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
@ GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_INFO
#define GNUNET_free(ptr)
Wrapper around free.
struct GNUNET_PEERINFO_Handle * GNUNET_PEERINFO_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Connect to the peerinfo service.
Definition: peerinfo_api.c:130
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1281
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1254
struct GNUNET_STATISTICS_GetHandle * GNUNET_STATISTICS_get(struct GNUNET_STATISTICS_Handle *handle, const char *subsystem, const char *name, GNUNET_STATISTICS_Callback cont, GNUNET_STATISTICS_Iterator proc, void *cls)
Get statistic from the peer.
enum GNUNET_GenericReturnValue GNUNET_STRINGS_utf8_toupper(const char *input, char *output)
Convert the utf-8 input string to upper case.
Definition: strings.c:472
#define GNUNET_TIME_UNIT_MINUTES
One minute.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:570
#define _(String)
GNU gettext support macro.
Definition: platform.h:177

References _, cfg, ch, filename, gettext_noop, GNUNET_assert, GNUNET_break, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_DISK_file_test(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_strerror_file, GNUNET_NO, GNUNET_OK, GNUNET_PEERINFO_connect(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_add_now(), GNUNET_STATISTICS_get(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_STRINGS_utf8_toupper(), GNUNET_SYSERR, GNUNET_TIME_UNIT_MINUTES, GNUNET_YES, handler_advertisement(), handler_connect(), handler_disconnect(), linked_list_head, linked_list_tail, load_hostlist_file(), pi, primary_task(), process_stat(), proxy, proxy_password, proxy_type, proxy_username, result, SAVING_INTERVAL, sget, st, stat_learning, stat_testing_allowed, stat_testing_hostlist, stat_timeout_task(), stat_use_bootstrap, stats, task_check(), task_hostlist_saving(), ti_check_download, and ti_saving_task.

Referenced by run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_HOSTLIST_client_stop()

void GNUNET_HOSTLIST_client_stop ( void  )

Stop downloading hostlists from hostlist servers as necessary.

Definition at line 1749 of file gnunet-daemon-hostlist_client.c.

1750 {
1751  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostlist client shutdown\n");
1752  if (NULL != sget)
1753  {
1755  sget = NULL;
1756  }
1757  stats = NULL;
1758  if (GNUNET_YES == stat_learning)
1760  if (NULL != ti_saving_task)
1761  {
1763  ti_saving_task = NULL;
1764  }
1765  if (NULL != ti_download_dispatcher_task)
1766  {
1769  }
1770  if (NULL != ti_testing_intervall_task)
1771  {
1774  }
1775  if (NULL != ti_download)
1776  {
1778  ti_download = NULL;
1779  update_hostlist ();
1780  clean_up ();
1781  }
1782  if (NULL != ti_check_download)
1783  {
1785  ti_check_download = NULL;
1786  curl_global_cleanup ();
1787  }
1788  GNUNET_free (proxy);
1789  proxy = NULL;
1791  proxy_username = NULL;
1793  proxy_password = NULL;
1794  if (NULL != pi)
1795  {
1797  pi = NULL;
1798  }
1799  cfg = NULL;
1800 }
static struct GNUNET_SCHEDULER_Task * ti_testing_intervall_task
ID of the task controlling the locking between two hostlist tests.
static void update_hostlist()
Method updating hostlist statistics.
static struct GNUNET_SCHEDULER_Task * ti_download
ID of the task downloading the hostlist.
static void save_hostlist_file(int shutdown)
Method to save hostlist to a file during hostlist client shutdown.
static struct GNUNET_SCHEDULER_Task * ti_download_dispatcher_task
ID of the task called to initiate a download.
static void clean_up()
Clean up the state from the task that downloaded the hostlist and schedule the next task.
void GNUNET_PEERINFO_disconnect(struct GNUNET_PEERINFO_Handle *h)
Disconnect from the peerinfo service.
Definition: peerinfo_api.c:156
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:957
void GNUNET_STATISTICS_get_cancel(struct GNUNET_STATISTICS_GetHandle *gh)
Cancel a GNUNET_STATISTICS_get request.

References cfg, clean_up(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_PEERINFO_disconnect(), GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_get_cancel(), GNUNET_YES, pi, proxy, proxy_password, proxy_username, save_hostlist_file(), sget, stat_learning, stats, ti_check_download, ti_download, ti_download_dispatcher_task, ti_saving_task, ti_testing_intervall_task, and update_hostlist().

Referenced by cleaning_task().

Here is the call graph for this function:
Here is the caller graph for this function: