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 "config.h"
  28
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <errno.h>
  32
  33 #include "xkbcommon/xkbcommon.h"
  34 #include "utils.h"
  35 #include "context.h"
  36
  37 /**
  38  * Append one directory to the context's include path.
  39  */
  40 XKB_EXPORT int
  41 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
  42 {
  43     struct stat stat_buf;
  44     int err = ENOMEM;
  45     char *tmp;
  46
  47     tmp = strdup(path);
  48     if (!tmp)
  49         goto err;
  50
  51     err = stat(path, &stat_buf);
  52     if (err != 0) {
  53         err = errno;
  54         goto err;
  55     }
  56     if (!S_ISDIR(stat_buf.st_mode)) {
  57         err = ENOTDIR;
  58         goto err;
  59     }
  60
  61     if (!check_eaccess(path, R_OK | X_OK)) {
  62         err = EACCES;
  63         goto err;
  64     }
  65
  66     darray_append(ctx->includes, tmp);
  67     log_dbg(ctx, "Include path added: %s\n", tmp);
  68
  69     return 1;
  70
  71 err:
  72     darray_append(ctx->failed_includes, tmp);
  73     log_dbg(ctx, "Include path failed: %s (%s)\n", tmp, strerror(err));
  74     return 0;
  75 }
  76
  77 const char *
  78 xkb_context_include_path_get_extra_path(struct xkb_context *ctx)
  79 {
  80     const char *extra = secure_getenv("XKB_CONFIG_EXTRA_PATH");
  81     return extra ? extra : DFLT_XKB_CONFIG_EXTRA_PATH;
  82 }
  83
  84 const char *
  85 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
  86 {
  87     const char *root = secure_getenv("XKB_CONFIG_ROOT");
  88     return root ? root : DFLT_XKB_CONFIG_ROOT;
  89 }
  90
  91 /**
  92  * Append the default include directories to the context.
  93  */
  94 XKB_EXPORT int
  95 xkb_context_include_path_append_default(struct xkb_context *ctx)
  96 {
  97     const char *home, *xdg, *root, *extra;
  98     char *user_path;
  99     int ret = 0;
 100
 101     home = secure_getenv("HOME");
 102
 103     xdg = secure_getenv("XDG_CONFIG_HOME");
 104     if (xdg != NULL) {
 105         user_path = asprintf_safe("%s/xkb", xdg);
 106         if (user_path) {
 107             ret |= xkb_context_include_path_append(ctx, user_path);
 108             free(user_path);
 109         }
 110     } else if (home != NULL) {
 111         /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
 112         user_path = asprintf_safe("%s/.config/xkb", home);
 113         if (user_path) {
 114             ret |= xkb_context_include_path_append(ctx, user_path);
 115             free(user_path);
 116         }
 117     }
 118
 119     if (home != NULL) {
 120         user_path = asprintf_safe("%s/.xkb", home);
 121         if (user_path) {
 122             ret |= xkb_context_include_path_append(ctx, user_path);
 123             free(user_path);
 124         }
 125     }
 126
 127     extra = xkb_context_include_path_get_extra_path(ctx);
 128     ret |= xkb_context_include_path_append(ctx, extra);
 129     root = xkb_context_include_path_get_system_path(ctx);
 130     ret |= xkb_context_include_path_append(ctx, root);
 131
 132     return ret;
 133 }
 134
 135 /**
 136  * Remove all entries in the context's include path.
 137  */
 138 XKB_EXPORT void
 139 xkb_context_include_path_clear(struct xkb_context *ctx)
 140 {
 141     char **path;
 142
 143     darray_foreach(path, ctx->includes)
 144         free(*path);
 145     darray_free(ctx->includes);
 146
 147     darray_foreach(path, ctx->failed_includes)
 148         free(*path);
 149     darray_free(ctx->failed_includes);
 150 }
 151
 152 /**
 153  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 154  */
 155 XKB_EXPORT int
 156 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
 157 {
 158     xkb_context_include_path_clear(ctx);
 159     return xkb_context_include_path_append_default(ctx);
 160 }
 161
 162 /**
 163  * Returns the number of entries in the context's include path.
 164  */
 165 XKB_EXPORT unsigned int
 166 xkb_context_num_include_paths(struct xkb_context *ctx)
 167 {
 168     return darray_size(ctx->includes);
 169 }
 170
 171 /**
 172  * Returns the given entry in the context's include path, or NULL if an
 173  * invalid index is passed.
 174  */
 175 XKB_EXPORT const char *
 176 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 177 {
 178     if (idx >= xkb_context_num_include_paths(ctx))
 179         return NULL;
 180
 181     return darray_item(ctx->includes, idx);
 182 }
 183
 184 /**
 185  * Take a new reference on the context.
 186  */
 187 XKB_EXPORT struct xkb_context *
 188 xkb_context_ref(struct xkb_context *ctx)
 189 {
 190     ctx->refcnt++;
 191     return ctx;
 192 }
 193
 194 /**
 195  * Drop an existing reference on the context, and free it if the refcnt is
 196  * now 0.
 197  */
 198 XKB_EXPORT void
 199 xkb_context_unref(struct xkb_context *ctx)
 200 {
 201     if (!ctx || --ctx->refcnt > 0)
 202         return;
 203
 204     free(ctx->x11_atom_cache);
 205     xkb_context_include_path_clear(ctx);
 206     atom_table_free(ctx->atom_table);
 207     free(ctx);
 208 }
 209
 210 static const char *
 211 log_level_to_prefix(enum xkb_log_level level)
 212 {
 213     switch (level) {
 214     case XKB_LOG_LEVEL_DEBUG:
 215         return "xkbcommon: DEBUG: ";
 216     case XKB_LOG_LEVEL_INFO:
 217         return "xkbcommon: INFO: ";
 218     case XKB_LOG_LEVEL_WARNING:
 219         return "xkbcommon: WARNING: ";
 220     case XKB_LOG_LEVEL_ERROR:
 221         return "xkbcommon: ERROR: ";
 222     case XKB_LOG_LEVEL_CRITICAL:
 223         return "xkbcommon: CRITICAL: ";
 224     default:
 225         return NULL;
 226     }
 227 }
 228
 229 ATTR_PRINTF(3, 0) static void
 230 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
 231                const char *fmt, va_list args)
 232 {
 233     const char *prefix = log_level_to_prefix(level);
 234
 235     if (prefix)
 236         fprintf(stderr, "%s", prefix);
 237     vfprintf(stderr, fmt, args);
 238 }
 239
 240 static enum xkb_log_level
 241 log_level(const char *level) {
 242     char *endptr;
 243     enum xkb_log_level lvl;
 244
 245     errno = 0;
 246     lvl = strtol(level, &endptr, 10);
 247     if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
 248         return lvl;
 249     if (istreq_prefix("crit", level))
 250         return XKB_LOG_LEVEL_CRITICAL;
 251     if (istreq_prefix("err", level))
 252         return XKB_LOG_LEVEL_ERROR;
 253     if (istreq_prefix("warn", level))
 254         return XKB_LOG_LEVEL_WARNING;
 255     if (istreq_prefix("info", level))
 256         return XKB_LOG_LEVEL_INFO;
 257     if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
 258         return XKB_LOG_LEVEL_DEBUG;
 259
 260     return XKB_LOG_LEVEL_ERROR;
 261 }
 262
 263 static int
 264 log_verbosity(const char *verbosity) {
 265     char *endptr;
 266     int v;
 267
 268     errno = 0;
 269     v = strtol(verbosity, &endptr, 10);
 270     if (errno == 0)
 271         return v;
 272
 273     return 0;
 274 }
 275
 276 /**
 277  * Create a new context.
 278  */
 279 XKB_EXPORT struct xkb_context *
 280 xkb_context_new(enum xkb_context_flags flags)
 281 {
 282     const char *env;
 283     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 284
 285     if (!ctx)
 286         return NULL;
 287
 288     ctx->refcnt = 1;
 289     ctx->log_fn = default_log_fn;
 290     ctx->log_level = XKB_LOG_LEVEL_ERROR;
 291     ctx->log_verbosity = 0;
 292
 293     /* Environment overwrites defaults. */
 294     env = secure_getenv("XKB_LOG_LEVEL");
 295     if (env)
 296         xkb_context_set_log_level(ctx, log_level(env));
 297
 298     env = secure_getenv("XKB_LOG_VERBOSITY");
 299     if (env)
 300         xkb_context_set_log_verbosity(ctx, log_verbosity(env));
 301
 302     if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
 303         !xkb_context_include_path_append_default(ctx)) {
 304         log_err(ctx, "failed to add default include path %s\n",
 305                 DFLT_XKB_CONFIG_ROOT);
 306         xkb_context_unref(ctx);
 307         return NULL;
 308     }
 309
 310     ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
 311
 312     ctx->atom_table = atom_table_new();
 313     if (!ctx->atom_table) {
 314         xkb_context_unref(ctx);
 315         return NULL;
 316     }
 317
 318     ctx->x11_atom_cache = NULL;
 319
 320     return ctx;
 321 }
 322
 323 XKB_EXPORT void
 324 xkb_context_set_log_fn(struct xkb_context *ctx,
 325                        void (*log_fn)(struct xkb_context *ctx,
 326                                       enum xkb_log_level level,
 327                                       const char *fmt, va_list args))
 328 {
 329     ctx->log_fn = (log_fn ? log_fn : default_log_fn);
 330 }
 331
 332 XKB_EXPORT enum xkb_log_level
 333 xkb_context_get_log_level(struct xkb_context *ctx)
 334 {
 335     return ctx->log_level;
 336 }
 337
 338 XKB_EXPORT void
 339 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
 340 {
 341     ctx->log_level = level;
 342 }
 343
 344 XKB_EXPORT int
 345 xkb_context_get_log_verbosity(struct xkb_context *ctx)
 346 {
 347     return ctx->log_verbosity;
 348 }
 349
 350 XKB_EXPORT void
 351 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
 352 {
 353     ctx->log_verbosity = verbosity;
 354 }
 355
 356 XKB_EXPORT void *
 357 xkb_context_get_user_data(struct xkb_context *ctx)
 358 {
 359     if (ctx)
 360         return ctx->user_data;
 361     return NULL;
 362 }
 363
 364 XKB_EXPORT void
 365 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
 366 {
 367     ctx->user_data = user_data;
 368 }