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