src/context.c

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  * Copyright © 2012 Ran Benita
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Author: Daniel Stone <daniel@fooishbar.org>
  25  */
  26
  27 #include <sys/types.h>
  28 #include <sys/stat.h>
  29 #include <errno.h>
  30 #include <unistd.h>
  31
  32 #include "xkbcommon/xkbcommon.h"
  33 #include "utils.h"
  34 #include "context.h"
  35
  36 /**
  37  * Append one directory to the context's include path.
  38  */
  39 XKB_EXPORT int
  40 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
  41 {
  42     struct stat stat_buf;
  43     int err;
  44     char *tmp;
  45
  46     tmp = strdup(path);
  47     if (!tmp)
  48         goto err;
  49
  50     err = stat(path, &stat_buf);
  51     if (err != 0)
  52         goto err;
  53     if (!S_ISDIR(stat_buf.st_mode))
  54         goto err;
  55
  56 #if defined(HAVE_EACCESS)
  57     if (eaccess(path, R_OK | X_OK) != 0)
  58         goto err;
  59 #elif defined(HAVE_EUIDACCESS)
  60     if (euidaccess(path, R_OK | X_OK) != 0)
  61         goto err;
  62 #endif
  63
  64     darray_append(ctx->includes, tmp);
  65     return 1;
  66
  67 err:
  68     darray_append(ctx->failed_includes, tmp);
  69     return 0;
  70 }
  71
  72 /**
  73  * Append the default include directories to the context.
  74  */
  75 XKB_EXPORT int
  76 xkb_context_include_path_append_default(struct xkb_context *ctx)
  77 {
  78     const char *home, *xdg, *root;
  79     char *user_path;
  80     int err;
  81     int ret = 0;
  82
  83     home = secure_getenv("HOME");
  84
  85     xdg = secure_getenv("XDG_CONFIG_HOME");
  86     if (xdg != NULL) {
  87         err = asprintf(&user_path, "%s/xkb", xdg);
  88         if (err >= 0) {
  89             ret |= xkb_context_include_path_append(ctx, user_path);
  90             free(user_path);
  91         }
  92     } else if (home != NULL) {
  93         /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
  94         err = asprintf(&user_path, "%s/.config/xkb", home);
  95         if (err >= 0) {
  96             ret |= xkb_context_include_path_append(ctx, user_path);
  97             free(user_path);
  98         }
  99     }
 100
 101     if (home != NULL) {
 102         err = asprintf(&user_path, "%s/.xkb", home);
 103         if (err >= 0) {
 104             ret |= xkb_context_include_path_append(ctx, user_path);
 105             free(user_path);
 106         }
 107     }
 108
 109     root = secure_getenv("XKB_CONFIG_ROOT");
 110     if (root != NULL)
 111        ret |= xkb_context_include_path_append(ctx, root);
 112     else
 113        ret |= xkb_context_include_path_append(ctx, DFLT_XKB_CONFIG_ROOT);
 114
 115     return ret;
 116 }
 117
 118 /**
 119  * Remove all entries in the context's include path.
 120  */
 121 XKB_EXPORT void
 122 xkb_context_include_path_clear(struct xkb_context *ctx)
 123 {
 124     char **path;
 125
 126     darray_foreach(path, ctx->includes)
 127         free(*path);
 128     darray_free(ctx->includes);
 129
 130     darray_foreach(path, ctx->failed_includes)
 131         free(*path);
 132     darray_free(ctx->failed_includes);
 133 }
 134
 135 /**
 136  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 137  */
 138 XKB_EXPORT int
 139 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
 140 {
 141     xkb_context_include_path_clear(ctx);
 142     return xkb_context_include_path_append_default(ctx);
 143 }
 144
 145 /**
 146  * Returns the number of entries in the context's include path.
 147  */
 148 XKB_EXPORT unsigned int
 149 xkb_context_num_include_paths(struct xkb_context *ctx)
 150 {
 151     return darray_size(ctx->includes);
 152 }
 153
 154 /**
 155  * Returns the given entry in the context's include path, or NULL if an
 156  * invalid index is passed.
 157  */
 158 XKB_EXPORT const char *
 159 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 160 {
 161     if (idx >= xkb_context_num_include_paths(ctx))
 162         return NULL;
 163
 164     return darray_item(ctx->includes, idx);
 165 }
 166
 167 /**
 168  * Take a new reference on the context.
 169  */
 170 XKB_EXPORT struct xkb_context *
 171 xkb_context_ref(struct xkb_context *ctx)
 172 {
 173     ctx->refcnt++;
 174     return ctx;
 175 }
 176
 177 /**
 178  * Drop an existing reference on the context, and free it if the refcnt is
 179  * now 0.
 180  */
 181 XKB_EXPORT void
 182 xkb_context_unref(struct xkb_context *ctx)
 183 {
 184     if (!ctx || --ctx->refcnt > 0)
 185         return;
 186
 187     xkb_context_include_path_clear(ctx);
 188     atom_table_free(ctx->atom_table);
 189     free(ctx);
 190 }
 191
 192 static const char *
 193 log_level_to_prefix(enum xkb_log_level level)
 194 {
 195     switch (level) {
 196     case XKB_LOG_LEVEL_DEBUG:
 197         return "xkbcommon: DEBUG: ";
 198     case XKB_LOG_LEVEL_INFO:
 199         return "xkbcommon: INFO: ";
 200     case XKB_LOG_LEVEL_WARNING:
 201         return "xkbcommon: WARNING: ";
 202     case XKB_LOG_LEVEL_ERROR:
 203         return "xkbcommon: ERROR: ";
 204     case XKB_LOG_LEVEL_CRITICAL:
 205         return "xkbcommon: CRITICAL: ";
 206     default:
 207         return NULL;
 208     }
 209 }
 210
 211 ATTR_PRINTF(3, 0) static void
 212 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
 213                const char *fmt, va_list args)
 214 {
 215     const char *prefix = log_level_to_prefix(level);
 216
 217     if (prefix)
 218         fprintf(stderr, "%s", prefix);
 219     vfprintf(stderr, fmt, args);
 220 }
 221
 222 static enum xkb_log_level
 223 log_level(const char *level) {
 224     char *endptr;
 225     enum xkb_log_level lvl;
 226
 227     errno = 0;
 228     lvl = strtol(level, &endptr, 10);
 229     if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
 230         return lvl;
 231     if (istreq_prefix("crit", level))
 232         return XKB_LOG_LEVEL_CRITICAL;
 233     if (istreq_prefix("err", level))
 234         return XKB_LOG_LEVEL_ERROR;
 235     if (istreq_prefix("warn", level))
 236         return XKB_LOG_LEVEL_WARNING;
 237     if (istreq_prefix("info", level))
 238         return XKB_LOG_LEVEL_INFO;
 239     if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
 240         return XKB_LOG_LEVEL_DEBUG;
 241
 242     return XKB_LOG_LEVEL_ERROR;
 243 }
 244
 245 static int
 246 log_verbosity(const char *verbosity) {
 247     char *endptr;
 248     int v;
 249
 250     errno = 0;
 251     v = strtol(verbosity, &endptr, 10);
 252     if (errno == 0)
 253         return v;
 254
 255     return 0;
 256 }
 257
 258 /**
 259  * Create a new context.
 260  */
 261 XKB_EXPORT struct xkb_context *
 262 xkb_context_new(enum xkb_context_flags flags)
 263 {
 264     const char *env;
 265     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 266
 267     if (!ctx)
 268         return NULL;
 269
 270     ctx->refcnt = 1;
 271     ctx->log_fn = default_log_fn;
 272     ctx->log_level = XKB_LOG_LEVEL_ERROR;
 273     ctx->log_verbosity = 0;
 274
 275     /* Environment overwrites defaults. */
 276     env = secure_getenv("XKB_LOG_LEVEL");
 277     if (env)
 278         xkb_context_set_log_level(ctx, log_level(env));
 279
 280     env = secure_getenv("XKB_LOG_VERBOSITY");
 281     if (env)
 282         xkb_context_set_log_verbosity(ctx, log_verbosity(env));
 283
 284     if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
 285         !xkb_context_include_path_append_default(ctx)) {
 286         log_err(ctx, "failed to add default include path %s\n",
 287                 DFLT_XKB_CONFIG_ROOT);
 288         xkb_context_unref(ctx);
 289         return NULL;
 290     }
 291
 292     ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
 293
 294     ctx->atom_table = atom_table_new();
 295     if (!ctx->atom_table) {
 296         xkb_context_unref(ctx);
 297         return NULL;
 298     }
 299
 300     return ctx;
 301 }
 302
 303 XKB_EXPORT void
 304 xkb_context_set_log_fn(struct xkb_context *ctx,
 305                        void (*log_fn)(struct xkb_context *ctx,
 306                                       enum xkb_log_level level,
 307                                       const char *fmt, va_list args))
 308 {
 309     ctx->log_fn = (log_fn ? log_fn : default_log_fn);
 310 }
 311
 312 XKB_EXPORT enum xkb_log_level
 313 xkb_context_get_log_level(struct xkb_context *ctx)
 314 {
 315     return ctx->log_level;
 316 }
 317
 318 XKB_EXPORT void
 319 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
 320 {
 321     ctx->log_level = level;
 322 }
 323
 324 XKB_EXPORT int
 325 xkb_context_get_log_verbosity(struct xkb_context *ctx)
 326 {
 327     return ctx->log_verbosity;
 328 }
 329
 330 XKB_EXPORT void
 331 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
 332 {
 333     ctx->log_verbosity = verbosity;
 334 }
 335
 336 XKB_EXPORT void *
 337 xkb_context_get_user_data(struct xkb_context *ctx)
 338 {
 339     if (ctx)
 340         return ctx->user_data;
 341     return NULL;
 342 }
 343
 344 XKB_EXPORT void
 345 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
 346 {
 347     ctx->user_data = user_data;
 348 }