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