bsdism
[oweals/gnunet.git] / src / util / os_installation.c
1 /*
2      This file is part of GNUnet.
3      (C) 2006 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 2, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file src/util/os_installation.c
23  * @brief get paths used by the program
24  * @author Milan
25  */
26
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #if 0                           /* keep Emacsens' auto-indent happy */
31 }
32 #endif
33 #endif
34
35 #include <sys/stat.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <unistd.h>
39
40 #include "platform.h"
41 #include "gnunet_common.h"
42 #include "gnunet_configuration_lib.h"
43 #include "gnunet_disk_lib.h"
44 #include "gnunet_os_lib.h"
45 #if OSX
46 #include <mach-o/ldsyms.h>
47 #include <mach-o/dyld.h>
48 #endif
49
50 #if LINUX
51 /**
52  * Try to determine path by reading /proc/PID/exe
53  */
54 static char *
55 get_path_from_proc_maps ()
56 {
57   char fn[64];
58   char *line;
59   char *dir;
60   FILE *f;
61
62   GNUNET_snprintf (fn, 64, "/proc/%u/maps", getpid ());
63   line = GNUNET_malloc (1024);
64   dir = GNUNET_malloc (1024);
65   f = fopen (fn, "r");
66   if (f != NULL)
67     {
68       while (NULL != fgets (line, 1024, f))
69         {
70           if ((1 == sscanf (line,
71                             "%*x-%*x %*c%*c%*c%*c %*x %*2u:%*2u %*u%*[ ]%s",
72                             dir)) && (NULL != strstr (dir, "libgnunetutil")))
73             {
74               strstr (dir, "libgnunetutil")[0] = '\0';
75               fclose (f);
76               GNUNET_free (line);
77               return dir;
78             }
79         }
80       fclose (f);
81     }
82   GNUNET_free (dir);
83   GNUNET_free (line);
84   return NULL;
85 }
86
87 /**
88  * Try to determine path by reading /proc/PID/exe
89  */
90 static char *
91 get_path_from_proc_exe ()
92 {
93   char fn[64];
94   char *lnk;
95   size_t size;
96
97   GNUNET_snprintf (fn, 64, "/proc/%u/exe", getpid ());
98   lnk = GNUNET_malloc (1024);
99   size = readlink (fn, lnk, 1023);
100   if ((size == 0) || (size >= 1024))
101     {
102       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "readlink", fn);
103       GNUNET_free (lnk);
104       return NULL;
105     }
106   lnk[size] = '\0';
107   while ((lnk[size] != '/') && (size > 0))
108     size--;
109   if ((size < 4) || (lnk[size - 4] != '/'))
110     {
111       /* not installed in "/bin/" -- binary path probably useless */
112       GNUNET_free (lnk);
113       return NULL;
114     }
115   lnk[size] = '\0';
116   return lnk;
117 }
118 #endif
119
120 #if WINDOWS
121 /**
122  * Try to determine path with win32-specific function
123  */
124 static char *
125 get_path_from_module_filename ()
126 {
127   char *path;
128   char *idx;
129
130   path = GNUNET_malloc (4097);
131   GetModuleFileName (NULL, path, 4096);
132   idx = path + strlen (path);
133   while ((idx > path) && (*idx != '\\') && (*idx != '/'))
134     idx--;
135   *idx = '\0';
136   return path;
137 }
138 #endif
139
140 #if OSX
141 typedef int (*MyNSGetExecutablePathProto) (char *buf, size_t * bufsize);
142
143 static char *
144 get_path_from_NSGetExecutablePath ()
145 {
146   static char zero = '\0';
147   char *path;
148   size_t len;
149   MyNSGetExecutablePathProto func;
150   int ret;
151
152   path = NULL;
153   func =
154     (MyNSGetExecutablePathProto) dlsym (RTLD_DEFAULT, "_NSGetExecutablePath");
155   if (!func)
156     return NULL;
157   path = &zero;
158   len = 0;
159   /* get the path len, including the trailing \0 */
160   func (path, &len);
161   if (len == 0)
162     return NULL;
163   path = GNUNET_malloc (len);
164   ret = func (path, &len);
165   if (ret != 0)
166     {
167       GNUNET_free (path);
168       return NULL;
169     }
170   len = strlen (path);
171   while ((path[len] != '/') && (len > 0))
172     len--;
173   path[len] = '\0';
174   return path;
175 }
176
177 static char *
178 get_path_from_dyld_image ()
179 {
180   const char *path;
181   char *p, *s;
182   int i;
183   int c;
184
185   p = NULL;
186   c = _dyld_image_count ();
187   for (i = 0; i < c; i++)
188     {
189       if (_dyld_get_image_header (i) == &_mh_dylib_header)
190         {
191           path = _dyld_get_image_name (i);
192           if (path != NULL && strlen (path) > 0)
193             {
194               p = strdup (path);
195               s = p + strlen (p);
196               while ((s > p) && (*s != '/'))
197                 s--;
198               s++;
199               *s = '\0';
200             }
201           break;
202         }
203     }
204   return p;
205 }
206 #endif
207
208 static char *
209 get_path_from_PATH ()
210 {
211   char *path;
212   char *pos;
213   char *end;
214   char *buf;
215   const char *p;
216
217   p = getenv ("PATH");
218   if (p == NULL)
219     return NULL;
220   path = GNUNET_strdup (p);     /* because we write on it */
221   buf = GNUNET_malloc (strlen (path) + 20);
222   pos = path;
223
224   while (NULL != (end = strchr (pos, ':')))
225     {
226       *end = '\0';
227       sprintf (buf, "%s/%s", pos, "gnunetd");
228       if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
229         {
230           pos = GNUNET_strdup (pos);
231           GNUNET_free (buf);
232           GNUNET_free (path);
233           return pos;
234         }
235       pos = end + 1;
236     }
237   sprintf (buf, "%s/%s", pos, "gnunetd");
238   if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
239     {
240       pos = GNUNET_strdup (pos);
241       GNUNET_free (buf);
242       GNUNET_free (path);
243       return pos;
244     }
245   GNUNET_free (buf);
246   GNUNET_free (path);
247   return NULL;
248 }
249
250 static char *
251 get_path_from_GNUNET_PREFIX ()
252 {
253   const char *p;
254
255   p = getenv ("GNUNET_PREFIX");
256   if (p != NULL)
257     return GNUNET_strdup (p);
258   return NULL;
259 }
260
261 /*
262  * @brief get the path to GNUnet bin/ or lib/, prefering the lib/ path
263  * @author Milan
264  *
265  * @return a pointer to the executable path, or NULL on error
266  */
267 static char *
268 os_get_gnunet_path ()
269 {
270   char *ret;
271
272   ret = get_path_from_GNUNET_PREFIX ();
273   if (ret != NULL)
274     return ret;
275 #if LINUX
276   ret = get_path_from_proc_maps ();
277   if (ret != NULL)
278     return ret;
279   ret = get_path_from_proc_exe ();
280   if (ret != NULL)
281     return ret;
282 #endif
283 #if WINDOWS
284   ret = get_path_from_module_filename ();
285   if (ret != NULL)
286     return ret;
287 #endif
288 #if OSX
289   ret = get_path_from_dyld_image ();
290   if (ret != NULL)
291     return ret;
292   ret = get_path_from_NSGetExecutablePath ();
293   if (ret != NULL)
294     return ret;
295 #endif
296   ret = get_path_from_PATH ();
297   if (ret != NULL)
298     return ret;
299   /* other attempts here */
300   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
301               _("Could not determine installation path for GNUnet.  Set `%s' environment variable.\n"),
302               "GNUNET_PREFIX");
303   return NULL;
304 }
305
306 /*
307  * @brief get the path to current app's bin/
308  * @author Milan
309  *
310  * @return a pointer to the executable path, or NULL on error
311  */
312 static char *
313 os_get_exec_path ()
314 {
315   char *ret;
316
317   ret = NULL;
318 #if LINUX
319   ret = get_path_from_proc_exe ();
320   if (ret != NULL)
321     return ret;
322 #endif
323 #if WINDOWS
324   ret = get_path_from_module_filename ();
325   if (ret != NULL)
326     return ret;
327 #endif
328 #if OSX
329   ret = get_path_from_NSGetExecutablePath ();
330   if (ret != NULL)
331     return ret;
332 #endif
333   /* other attempts here */
334   return ret;
335 }
336
337
338
339 /**
340  * @brief get the path to a specific GNUnet installation directory or,
341  * with GNUNET_IPK_SELF_PREFIX, the current running apps installation directory
342  * @author Milan
343  * @return a pointer to the dir path (to be freed by the caller)
344  */
345 char *
346 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind)
347 {
348   size_t n;
349   const char *dirname;
350   char *execpath = NULL;
351   char *tmp;
352   int isbasedir;
353
354   /* if wanted, try to get the current app's bin/ */
355   if (dirkind == GNUNET_OS_IPK_SELF_PREFIX)
356     execpath = os_get_exec_path ();
357
358   /* try to get GNUnet's bin/ or lib/, or if previous was unsuccessful some
359    * guess for the current app */
360   if (execpath == NULL)
361     execpath = os_get_gnunet_path ();
362
363   if (execpath == NULL)
364     return NULL;
365
366   n = strlen (execpath);
367   if (n == 0)
368     {
369       /* should never happen, but better safe than sorry */
370       GNUNET_free (execpath);
371       return NULL;
372     }
373   /* remove filename itself */
374   while ((n > 1) && (execpath[n - 1] == DIR_SEPARATOR))
375     execpath[--n] = '\0';
376
377   isbasedir = 1;
378   if ((n > 5) &&
379       ((0 == strcasecmp (&execpath[n - 5], "lib32")) ||
380        (0 == strcasecmp (&execpath[n - 5], "lib64"))))
381     {
382       if (dirkind != GNUNET_OS_IPK_LIBDIR)
383         {
384           /* strip '/lib32' or '/lib64' */
385           execpath[n - 5] = '\0';
386           n -= 5;
387         }
388       else
389         isbasedir = 0;
390     }
391   else if ((n > 3) &&
392            ((0 == strcasecmp (&execpath[n - 3], "bin")) ||
393             (0 == strcasecmp (&execpath[n - 3], "lib"))))
394     {
395       /* strip '/bin' or '/lib' */
396       execpath[n - 3] = '\0';
397       n -= 3;
398     }
399   /* in case this was a directory named foo-bin, remove "foo-" */
400   while ((n > 1) && (execpath[n - 1] == DIR_SEPARATOR))
401     execpath[--n] = '\0';
402   switch (dirkind)
403     {
404     case GNUNET_OS_IPK_PREFIX:
405     case GNUNET_OS_IPK_SELF_PREFIX:
406       dirname = DIR_SEPARATOR_STR;
407       break;
408     case GNUNET_OS_IPK_BINDIR:
409       dirname = DIR_SEPARATOR_STR "bin" DIR_SEPARATOR_STR;
410       break;
411     case GNUNET_OS_IPK_LIBDIR:
412       if (isbasedir)
413         dirname =
414           DIR_SEPARATOR_STR "lib" DIR_SEPARATOR_STR "gnunet"
415           DIR_SEPARATOR_STR;
416       else
417         dirname = DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
418       break;
419     case GNUNET_OS_IPK_DATADIR:
420       dirname =
421         DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "gnunet"
422         DIR_SEPARATOR_STR;
423       break;
424     case GNUNET_OS_IPK_LOCALEDIR:
425       dirname =
426         DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "locale"
427         DIR_SEPARATOR_STR;
428       break;
429     default:
430       GNUNET_free (execpath);
431       return NULL;
432     }
433   tmp = GNUNET_malloc (strlen (execpath) + strlen (dirname) + 1);
434   sprintf (tmp, "%s%s", execpath, dirname);
435   GNUNET_free (execpath);
436   return tmp;
437 }
438
439 #if 0                           /* keep Emacsens' auto-indent happy */
440 {
441 #endif
442 #ifdef __cplusplus
443 }
444 #endif
445 /* end of installpath.c */