os_installation.c File Reference

get paths used by the program More...

#include "platform.h"
#include <sys/stat.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <unistr.h>
#include "gnunet_util_lib.h"

Include dependency graph for os_installation.c:

Go to the source code of this file.

Macros
#define	LOG(kind, ...)    GNUNET_log_from (kind, "util-os-installation", __VA_ARGS__)
#define	LOG_STRERROR_FILE(kind, syscall, filename)

Functions
const struct GNUNET_OS_ProjectData *	GNUNET_OS_project_data_default (void)
	Return default project data used by 'libgnunetutil' for GNUnet. More...
const struct GNUNET_OS_ProjectData *	GNUNET_OS_project_data_get ()
void	GNUNET_OS_init (const struct GNUNET_OS_ProjectData *pd)
	Setup OS subsystem with project data. More...
static char *	get_path_from_PATH (const char *binary)
	Return the actual path to a file found in the current PATH environment variable. More...
static char *	get_path_from_GNUNET_PREFIX (void)
	Try to obtain the installation path using the "GNUNET_PREFIX" environment variable. More...
static char *	os_get_gnunet_path (void)
	get the path to GNUnet bin/ or lib/, preferring the lib/ path More...
static char *	os_get_exec_path ()
	get the path to current app's bin/ More...
char *	GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind)
	get the path to a specific GNUnet installation directory or, with GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation directory More...
char *	GNUNET_OS_get_libexec_binary_path (const char *progname)
	Given the name of a gnunet-helper, gnunet-service or gnunet-daemon binary, try to prefix it with the libexec/-directory to get the full path. More...
char *	GNUNET_OS_get_suid_binary_path (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *progname)
	Given the name of a helper, service or daemon binary construct the full path to the binary using the SUID_BINARY_PATH in the PATHS section of the configuration. More...
enum GNUNET_GenericReturnValue	GNUNET_OS_check_helper_binary (const char *binary, bool check_suid, const char *params)
	Check whether an executable exists and possibly if the suid bit is set on the file. More...

Variables
static const struct GNUNET_OS_ProjectData	default_pd
	Default project data used for installation path detection for GNUnet (core). More...
static const struct GNUNET_OS_ProjectData *	current_pd = &default_pd
	Which project data do we currently use for installation path detection? Never NULL. More...
static const struct GNUNET_OS_ProjectData *	gettextinit
	PD for which gettext has been initialized last. More...

Detailed Description

get paths used by the program

Author

Milan

Christian Fuchs

Christian Grothoff

Matthias Wachs

Heikki Lindholm

LRN

Definition in file os_installation.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "util-os-installation", __VA_ARGS__)

Definition at line 46 of file os_installation.c.

LOG_STRERROR_FILE

#define LOG_STRERROR_FILE	(		kind,
			syscall,
			filename
	)

Value:

  GNUNET_log_from_strerror_file (kind,                   \
                                 "util-os-installation", \
                                 syscall,                \
                                 filename)

Definition at line 49 of file os_installation.c.

Function Documentation

get_path_from_PATH()

static char* get_path_from_PATH ( const char *  binary )

static

Return the actual path to a file found in the current PATH environment variable.

Parameters

binary

the name of the file to find

Returns

path to binary, NULL if not found

Definition at line 318 of file os_installation.c.

{
  char *path;
  char *pos;
  char *end;
  char *buf;
  const char *p;
 
  if (NULL == (p = getenv ("PATH")))
    return NULL;
 
  path = GNUNET_strdup (p);  /* because we write on it */
 
  buf = GNUNET_malloc (strlen (path) + strlen (binary) + 1 + 1);
  pos = path;
  while (NULL != (end = strchr (pos, PATH_SEPARATOR)))
  {
    *end = '\0';
    sprintf (buf, "%s/%s", pos, binary);
    if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
    {
      pos = GNUNET_strdup (pos);
      GNUNET_free (buf);
      GNUNET_free (path);
      return pos;
    }
    pos = end + 1;
  }
  sprintf (buf, "%s/%s", pos, binary);
  if (GNUNET_YES == GNUNET_DISK_file_test (buf))
  {
    pos = GNUNET_strdup (pos);
    GNUNET_free (buf);
    GNUNET_free (path);
    return pos;
  }
  GNUNET_free (buf);
  GNUNET_free (path);
  return NULL;
}

References buf, end, getenv(), GNUNET_DISK_file_test(), GNUNET_free, GNUNET_malloc, GNUNET_strdup, GNUNET_YES, p, and PATH_SEPARATOR.

Referenced by os_get_gnunet_path().

Here is the call graph for this function:

Here is the caller graph for this function:

get_path_from_GNUNET_PREFIX()

static char* get_path_from_GNUNET_PREFIX ( void  )

static

Try to obtain the installation path using the "GNUNET_PREFIX" environment variable.

Returns

NULL on error (environment variable not set)

Definition at line 367 of file os_installation.c.

{
  const char *p;
 
  if ((NULL != current_pd->env_varname) &&
      (NULL != (p = getenv (current_pd->env_varname))))
    return GNUNET_strdup (p);
  if ((NULL != current_pd->env_varname_alt) &&
      (NULL != (p = getenv (current_pd->env_varname_alt))))
    return GNUNET_strdup (p);
  return NULL;
}

References current_pd, GNUNET_OS_ProjectData::env_varname, GNUNET_OS_ProjectData::env_varname_alt, getenv(), GNUNET_strdup, and p.

Referenced by os_get_gnunet_path().

Here is the call graph for this function:

Here is the caller graph for this function:

os_get_gnunet_path()

static char* os_get_gnunet_path ( void  )

static

get the path to GNUnet bin/ or lib/, preferring the lib/ path

Author

Milan

Returns

a pointer to the executable path, or NULL on error

Definition at line 388 of file os_installation.c.

{
  char *ret;
 
  if (NULL != (ret = get_path_from_GNUNET_PREFIX ()))
    return ret;
#ifdef __linux__
  if (NULL != (ret = get_path_from_proc_maps ()))
    return ret;
  /* try path *first*, before /proc/exe, as /proc/exe can be wrong */
  if ((NULL != current_pd->binary_name) &&
      (NULL != (ret = get_path_from_PATH (current_pd->binary_name))))
    return ret;
  if (NULL != (ret = get_path_from_proc_exe ()))
    return ret;
#endif
#if DARWIN
  if (NULL != (ret = get_path_from_dyld_image ()))
    return ret;
  if (NULL != (ret = get_path_from_NSGetExecutablePath ()))
    return ret;
#endif
  if ((NULL != current_pd->binary_name) &&
      (NULL != (ret = get_path_from_PATH (current_pd->binary_name))))
    return ret;
  /* other attempts here */
  LOG (GNUNET_ERROR_TYPE_ERROR,
       _ (
         "Could not determine installation path for %s.  Set `%s' environment variable.\n"),
       current_pd->project_dirname,
       current_pd->env_varname);
  return NULL;
}

References _, GNUNET_OS_ProjectData::binary_name, current_pd, GNUNET_OS_ProjectData::env_varname, get_path_from_GNUNET_PREFIX(), get_path_from_PATH(), GNUNET_ERROR_TYPE_ERROR, LOG, GNUNET_OS_ProjectData::project_dirname, and ret.

Referenced by GNUNET_OS_installation_get_path().

Here is the call graph for this function:

Here is the caller graph for this function:

os_get_exec_path()

static char* os_get_exec_path ( )

static

get the path to current app's bin/

Returns

a pointer to the executable path, or NULL on error

Definition at line 428 of file os_installation.c.

{
  char *ret = NULL;
 
#ifdef __linux__
  if (NULL != (ret = get_path_from_proc_exe ()))
    return ret;
#endif
#if DARWIN
  if (NULL != (ret = get_path_from_NSGetExecutablePath ()))
    return ret;
#endif
  /* other attempts here */
  return ret;
}

References ret.

Referenced by GNUNET_OS_installation_get_path().

Here is the caller graph for this function:

Variable Documentation

default_pd

const struct GNUNET_OS_ProjectData default_pd

static

Initial value:

= {
  .libname = "libgnunetutil",
  .project_dirname = "gnunet",
  .binary_name = "gnunet-arm",
  .version = PACKAGE_VERSION " " VCS_VERSION,
  .env_varname = "GNUNET_PREFIX",
  .base_config_varname = "GNUNET_BASE_CONFIG",
  .bug_email = "gnunet-developers@gnu.org",
  .homepage = "http://www.gnu.org/s/gnunet/",
  .config_file = "gnunet.conf",
  .user_config_file = "~/.config/gnunet.conf",
  .is_gnu = 1,
  .gettext_domain = "gnunet",
  .gettext_path = NULL,
  .agpl_url = GNUNET_AGPL_URL,
}

Default project data used for installation path detection for GNUnet (core).

Definition at line 1 of file os_installation.c.

Referenced by GNUNET_OS_project_data_default().

current_pd

const struct GNUNET_OS_ProjectData* current_pd = &default_pd

static

Which project data do we currently use for installation path detection? Never NULL.

Definition at line 81 of file os_installation.c.

Referenced by get_path_from_GNUNET_PREFIX(), GNUNET_OS_init(), GNUNET_OS_installation_get_path(), GNUNET_OS_project_data_get(), and os_get_gnunet_path().

gettextinit

const struct GNUNET_OS_ProjectData* gettextinit

static

PD for which gettext has been initialized last.

Note that the gettext initialization done within GNUNET_PROGRAM_run2 is for the specific application.

Definition at line 88 of file os_installation.c.

Referenced by GNUNET_OS_init(), and GNUNET_OS_project_data_get().