path: root/nx-X11/programs/Xserver/hw/nxagent/Keyboard.c

/**************************************************************************/
/*                                                                        */
/* Copyright (c) 2001, 2011 NoMachine (http://www.nomachine.com)          */
/* Copyright (c) 2008-2014 Oleksandr Shneyder <o.shneyder@phoca-gmbh.de>  */
/* Copyright (c) 2011-2016 Mike Gabriel <mike.gabriel@das-netzwerkteam.de>*/
/* Copyright (c) 2014-2016 Mihai Moldovan <ionic@ionic.de>                */
/* Copyright (c) 2014-2016 Ulrich Sibiller <uli42@gmx.de>                 */
/* Copyright (c) 2015-2016 Qindel Group (http://www.qindel.com)           */
/*                                                                        */
/* NXAGENT, NX protocol compression and NX extensions to this software    */
/* are copyright of the aforementioned persons and companies.             */
/*                                                                        */
/* Redistribution and use of the present software is allowed according    */
/* to terms specified in the file LICENSE which comes in the source       */
/* distribution.                                                          */
/*                                                                        */
/* All rights reserved.                                                   */
/*                                                                        */
/* NOTE: This software has received contributions from various other      */
/* contributors, only the core maintainers and supporters are listed as   */
/* copyright holders. Please contact us, if you feel you should be listed */
/* as copyright holder, as well.                                          */
/*                                                                        */
/**************************************************************************/

/*

Copyright 1993 by Davor Matic

Permission to use, copy, modify, distribute, and sell this software
and its documentation for any purpose is hereby granted without fee,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation.  Davor Matic makes no representations about
the suitability of this software for any purpose.  It is provided "as
is" without express or implied warranty.

*/
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <string.h>
#include <stdlib.h>

#include "keysym.h"
#include "screenint.h"
#include "inputstr.h"
#include "misc.h"
#include "scrnintstr.h"
#include "servermd.h"
#include "extnsionst.h"

#include "Agent.h"
#include "Display.h"
#include "Screen.h"
#include "Keyboard.h"
#include "Events.h"
#include "Options.h"
#include "Error.h"
#include "Init.h"
#include "Utils.h"

#include "compext/Compext.h"

#include <nx/Shadow.h>

#ifdef XKB

#include <nx-X11/extensions/XKB.h>

/*
  we need the client side header here, xkbsrv.h will not work because
  server and libX11 have different struct sizes on
  64bit. Interestingly upstream xnest does not take care of this.
*/
#include <nx-X11/extensions/XKBsrv.h>
#include <nx-X11/extensions/XKBconfig.h>

#include "Xatom.h"

#include <errno.h>

static void nxagentXkbGetRemoteNames(void);
static void nxagentXkbClearRemoteNames(void);

void nxagentKeycodeConversionSetup(void);

static void nxagentWriteKeyboardDir(void);
static void nxagentWriteKeyboardFile(char *rules, char *model, char *layout, char *variant, char *options);

#endif /* XKB */

/*
 * Set here the required log level.
 */

#define PANIC
#define WARNING
#undef  TEST
#undef  DEBUG
#undef  WATCH

#ifdef WATCH
#include "unistd.h"
#endif

/*
 * Unfortunately we cannot just include XKBlib.h.  It conflicts with
 * the server side definitions of the same symbols. This is more a X
 * problem than our.
 */

#ifdef XKB

extern Bool XkbQueryExtension(
#if NeedFunctionPrototypes
        Display *        /* dpy */,
        int *            /* opcodeReturn */,
        int *            /* eventBaseReturn */,
        int *            /* errorBaseReturn */,
        int *            /* majorRtrn */,
        int *            /* minorRtrn */
#endif
);

extern        XkbDescPtr XkbGetKeyboard(
#if NeedFunctionPrototypes
        Display *        /* dpy */,
        unsigned int     /* which */,
        unsigned int     /* deviceSpec */
#endif
);

extern        Status        XkbGetControls(
#if NeedFunctionPrototypes
        Display *        /* dpy */,
        unsigned long    /* which */,
        XkbDescPtr       /* desc */
#endif
);

extern int XkbDfltRepeatDelay;
extern int XkbDfltRepeatInterval;

/* xkb configuration of the real X server */
static char *nxagentRemoteRules = NULL;
static char *nxagentRemoteModel = NULL;
static char *nxagentRemoteLayout = NULL;
static char *nxagentRemoteVariant = NULL;
static char *nxagentRemoteOptions = NULL;

#endif /* XKB */

/*
 * Save the values queried from X server.
 */

XkbAgentInfoRec nxagentXkbInfo = { -1, -1, -1, -1, -1 };

/*
 * Keyboard status, updated through XKB events.
 */

XkbAgentStateRec nxagentXkbState = { 0, 0, 0, 0, False };

/*
 * Info for disabling/enabling Xkb extension.
 */

XkbWrapperRec nxagentXkbWrapper;

extern char *nxagentKeyboard;

unsigned int nxagentAltMetaMask;
unsigned int nxagentAltMask;
unsigned int nxagentMetaMask;
unsigned int nxagentCapsMask;
unsigned int nxagentNumlockMask;

static void nxagentCheckModifierMasks(CARD8, int);

CARD8 nxagentCapsLockKeycode = 66;
CARD8 nxagentNumLockKeycode  = 77;

static void nxagentCheckRemoteKeycodes(void);

static CARD8 nxagentConvertedKeycodes[] =
{
  /* evdev  pc105*/
  /*   0 */    0,  /*   1 */    1,  /*   2 */    2,  /*   3 */    3,  /*   4 */    4,
  /*   5 */    5,  /*   6 */    6,  /*   7 */    7,  /*   8 */    8,  /*   9 */    9,
  /*  10 */   10,  /*  11 */   11,  /*  12 */   12,  /*  13 */   13,  /*  14 */   14,
  /*  15 */   15,  /*  16 */   16,  /*  17 */   17,  /*  18 */   18,  /*  19 */   19,
  /*  20 */   20,  /*  21 */   21,  /*  22 */   22,  /*  23 */   23,  /*  24 */   24,
  /*  25 */   25,  /*  26 */   26,  /*  27 */   27,  /*  28 */   28,  /*  29 */   29,
  /*  30 */   30,  /*  31 */   31,  /*  32 */   32,  /*  33 */   33,  /*  34 */   34,
  /*  35 */   35,  /*  36 */   36,  /*  37 */   37,  /*  38 */   38,  /*  39 */   39,
  /*  40 */   40,  /*  41 */   41,  /*  42 */   42,  /*  43 */   43,  /*  44 */   44,
  /*  45 */   45,  /*  46 */   46,  /*  47 */   47,  /*  48 */   48,  /*  49 */   49,
  /*  50 */   50,  /*  51 */   51,  /*  52 */   52,  /*  53 */   53,  /*  54 */   54,
  /*  55 */   55,  /*  56 */   56,  /*  57 */   57,  /*  58 */   58,  /*  59 */   59,
  /*  60 */   60,  /*  61 */   61,  /*  62 */   62,  /*  63 */   63,  /*  64 */   64,
  /*  65 */   65,  /*  66 */   66,  /*  67 */   67,  /*  68 */   68,  /*  69 */   69,
  /*  70 */   70,  /*  71 */   71,  /*  72 */   72,  /*  73 */   73,  /*  74 */   74,
  /*  75 */   75,  /*  76 */   76,  /*  77 */   77,  /*  78 */   78,  /*  79 */   79,
  /*  80 */   80,  /*  81 */   81,  /*  82 */   82,  /*  83 */   83,  /*  84 */   84,
  /*  85 */   85,  /*  86 */   86,  /*  87 */   87,  /*  88 */   88,  /*  89 */   89,
  /*  90 */   90,  /*  91 */   91,  /*  92 */  124,  /*  93 */   93,  /*  94 */   94,
  /*  95 */   95,  /*  96 */   96,  /*  97 */  211,  /*  98 */   98,  /*  99 */   99,
  /* 100 */  100,  /* 101 */  208,  /* 102 */  102,  /* 103 */  103,  /* 104 */  108,
  /* 105 */  109,  /* 106 */  112,  /* 107 */  111,  /* 108 */  113,  /* 109 */  109,
  /* 110 */   97,  /* 111 */   98,  /* 112 */   99,  /* 113 */  100,  /* 114 */  102,
  /* 115 */  103,  /* 116 */  104,  /* 117 */  105,  /* 118 */  106,  /* 119 */  107,
  /* 120 */  120,  /* 121 */  121,  /* 122 */  122,  /* 123 */  123,  /* 124 */  124,
  /* 125 */  126,  /* 126 */  126,  /* 127 */  110,  /* 128 */  128,  /* 129 */  129,
  /* 130 */  130,  /* 131 */  131,  /* 132 */  133,  /* 133 */  115,  /* 134 */  116,
  /* 135 */  117,  /* 136 */  136,  /* 137 */  137,  /* 138 */  138,  /* 139 */  139,
  /* 140 */  140,  /* 141 */  141,  /* 142 */  142,  /* 143 */  143,  /* 144 */  144,
  /* 145 */  145,  /* 146 */  146,  /* 147 */  147,  /* 148 */  148,  /* 149 */  149,
  /* 150 */  150,  /* 151 */  151,  /* 152 */  152,  /* 153 */  153,  /* 154 */  154,
  /* 155 */  155,  /* 156 */  156,  /* 157 */  157,  /* 158 */  158,  /* 159 */  159,
  /* 160 */  160,  /* 161 */  161,  /* 162 */  162,  /* 163 */  163,  /* 164 */  164,
  /* 165 */  165,  /* 166 */  166,  /* 167 */  167,  /* 168 */  168,  /* 169 */  169,
  /* 170 */  170,  /* 171 */  171,  /* 172 */  172,  /* 173 */  173,  /* 174 */  174,
  /* 175 */  175,  /* 176 */  176,  /* 177 */  177,  /* 178 */  178,  /* 179 */  179,
  /* 180 */  180,  /* 181 */  181,  /* 182 */  182,  /* 183 */  183,  /* 184 */  184,
  /* 185 */  185,  /* 186 */  186,  /* 187 */  187,  /* 188 */  188,  /* 189 */  189,
  /* 190 */  190,  /* 191 */  118,  /* 192 */  119,  /* 193 */  120,  /* 194 */  121,
  /* 195 */  122,  /* 196 */  196,  /* 197 */  197,  /* 198 */  198,  /* 199 */  199,
  /* 200 */  200,  /* 201 */  201,  /* 202 */  202,  /* 203 */   93,  /* 204 */  125,
  /* 205 */  156,  /* 206 */  127,  /* 207 */  128,  /* 208 */  208,  /* 209 */  209,
  /* 210 */  210,  /* 211 */  211,  /* 212 */  212,  /* 213 */  213,  /* 214 */  214,
  /* 215 */  215,  /* 216 */  216,  /* 217 */  217,  /* 218 */  218,  /* 219 */  219,
  /* 220 */  220,  /* 221 */  221,  /* 222 */  222,  /* 223 */  223,  /* 224 */  224,
  /* 225 */  225,  /* 226 */  226,  /* 227 */  227,  /* 228 */  228,  /* 229 */  229,
  /* 230 */  230,  /* 231 */  231,  /* 232 */  232,  /* 233 */  233,  /* 234 */  234,
  /* 235 */  235,  /* 236 */  236,  /* 237 */  237,  /* 238 */  238,  /* 239 */  239,
  /* 240 */  240,  /* 241 */  241,  /* 242 */  242,  /* 243 */  243,  /* 244 */  244,
  /* 245 */  245,  /* 246 */  246,  /* 247 */  247,  /* 248 */  248,  /* 249 */  249,
  /* 250 */  250,  /* 251 */  251,  /* 252 */  252,  /* 253 */  253,  /* 254 */  254,
  /* 255 */  255
};

static Bool nxagentKeycodeConversion = False;

CARD8 nxagentConvertKeycode(CARD8 k)
{
 if (nxagentKeycodeConversion)
 {
   #ifdef DEBUG
   if (k != nxagentConvertedKeycodes[k])
     fprintf(stderr, "%s: converting keycode [%d] to [%d]\n", __func__, k, nxagentConvertedKeycodes[k]);
   #endif

   return nxagentConvertedKeycodes[k];
 }
 else
 {
   return k;
 }
}

static int nxagentSaveKeyboardDeviceData(DeviceIntPtr dev, DeviceIntPtr devBackup);

static int nxagentRestoreKeyboardDeviceData(DeviceIntPtr devBackup, DeviceIntPtr dev);

static int nxagentFreeKeyboardDeviceData(DeviceIntPtr dev);

void nxagentBell(int volume, DeviceIntPtr pDev, void * ctrl, int cls)
{
  XBell(nxagentDisplay, volume);
}

void nxagentChangeKeyboardControl(DeviceIntPtr pDev, KeybdCtrl *ctrl)
{
  #ifdef XKB

  if (!noXkbExtension)
  {
    XkbSrvInfoPtr xkbi = pDev -> key -> xkbInfo;
    XkbControlsPtr xkbc = xkbi -> desc -> ctrls;

    /*
     * We want to prevent agent generating auto-repeated
     * keystrokes. Let's intercept any attempt by appli- cations to
     * change the default timeouts on the nxagent device.
     */

    #ifdef TEST
    fprintf(stderr, "%s: Repeat delay was [%d] interval was [%d].\n", __func__,
                xkbc -> repeat_delay, xkbc -> repeat_interval);
    #endif

    xkbc -> repeat_delay = ~ 0;
    xkbc -> repeat_interval = ~ 0;

    #ifdef TEST
    fprintf(stderr, "%s: Repeat delay is now [%d] interval is now [%d].\n", __func__,
                xkbc -> repeat_delay, xkbc -> repeat_interval);
    #endif
  }

  #endif

  /*
   * If enabled, propagate the changes to the devices attached to the
   * real X server.
   */

  if (nxagentOption(DeviceControl))
  {
    #ifdef TEST
    fprintf(stderr, "%s: WARNING! Propagating changes to keyboard settings.\n", __func__);
    #endif

    unsigned long value_mask = KBKeyClickPercent |  KBBellPercent | KBBellPitch | KBBellDuration;

    XKeyboardControl values = {
      .key_click_percent = ctrl->click,
      .bell_percent = ctrl->bell,
      .bell_pitch = ctrl->bell_pitch,
      .bell_duration = ctrl->bell_duration,
    };

    /*
     * Don't propagate the auto repeat mode. It is forced to be off in
     * the agent server.
     *
     * value_mask |= KBAutoRepeatMode;
     * values.auto_repeat_mode = ctrl->autoRepeat ?
     *                          AutoRepeatModeOn : AutoRepeatModeOff;
     */

    XChangeKeyboardControl(nxagentDisplay, value_mask, &values);

    /*
     * At this point, we need to walk through the vector and compare
     * it to the current server vector. If there are differences,
     * report them.
     */

    value_mask = KBLed | KBLedMode;

    for (int i = 1; i <= XkbNumIndicators; i++)
    {
      unsigned int mask = (unsigned int)1 << (i - 1);
      values.led = i;
      values.led_mode = (ctrl->leds & mask) ? LedModeOn : LedModeOff;

      XChangeKeyboardControl(nxagentDisplay, value_mask, &values);
    }

    return;
  }

  #ifdef TEST
  fprintf(stderr, "%s: WARNING! Not propagating changes to keyboard settings.\n", __func__);
  #endif
}

int nxagentKeyboardProc(DeviceIntPtr pDev, int onoff)
{
  KeySym *keymap;
  int mapWidth;
  int min_keycode, max_keycode;
  CARD8 modmap[MAP_LENGTH];
  XKeyboardState values;
#ifdef XKB
  char *model = NULL, *layout = NULL;
  XkbDescPtr xkb = NULL;
#endif

  switch (onoff)
  {
    case DEVICE_INIT:

      #ifdef TEST
      fprintf(stderr, "%s: Called for [DEVICE_INIT].\n", __func__);
      #endif

      if (NXDisplayError(nxagentDisplay) == 1)
      {
        return Success;
      }

      #ifdef WATCH

      fprintf(stderr, "%s: Watchpoint 9.\n", __func__);

/*
Reply   Total	Cached	Bits In			Bits Out		Bits/Reply	  Ratio
------- -----	------	-------			--------		----------	  -----
N/A
*/

      sleep(30);

      #endif

      /*
       * Prevent agent from generating auto-repeat keystroke.  Note
       * that this is working only if XKB is enabled.  A better
       * solution should account cases where XKB is not
       * available. Check also the behaviour of the DeviceControl
       * nxagent option.
       */

      XkbDfltRepeatDelay = ~ 0;
      XkbDfltRepeatInterval = ~ 0;

      #ifdef TEST
      fprintf(stderr, "%s: Set repeat delay to [%d] interval to [%d].\n", __func__,
                  XkbDfltRepeatDelay, XkbDfltRepeatInterval);
      #endif

      XModifierKeymap *modifier_keymap = XGetModifierMapping(nxagentDisplay);

      if (modifier_keymap == NULL)
      {
        return -1;
      }

      XDisplayKeycodes(nxagentDisplay, &min_keycode, &max_keycode);
#ifdef _XSERVER64
      {
        KeySym64 *keymap64 = XGetKeyboardMapping(nxagentDisplay,
                                                 min_keycode,
                                                 max_keycode - min_keycode + 1,
                                                 &mapWidth);
        if (keymap64 == NULL)
        {
          XFreeModifiermap(modifier_keymap);
          return -1;
        }

        int len = (max_keycode - min_keycode + 1) * mapWidth;
        keymap = (KeySym *)malloc(len * sizeof(KeySym));
        if (keymap == NULL)
        {
          XFreeModifiermap(modifier_keymap);
          return -1;
        }
        for(int i = 0; i < len; ++i)
        {
          keymap[i] = keymap64[i];
        }
        SAFE_XFree(keymap64);
      }

#else /* #ifdef _XSERVER64 */

      keymap = XGetKeyboardMapping(nxagentDisplay,
                                   min_keycode,
                                   max_keycode - min_keycode + 1,
                                   &mapWidth);

      if (keymap == NULL)
      {
        XFreeModifiermap(modifier_keymap);
        return -1;
      }

#endif /* #ifdef _XSERVER64 */

      nxagentAltMetaMask = 0;
      nxagentAltMask = 0;
      nxagentMetaMask = 0;
      nxagentCapsMask = 0;
      nxagentNumlockMask = 0;

      memset(modmap, 0, sizeof(modmap));
      for (int j = 0; j < 8; j++)
      {
        for(int i = 0; i < modifier_keymap->max_keypermod; i++)
        {
          CARD8 keycode;
          if ((keycode =
              modifier_keymap->
                modifiermap[j * modifier_keymap->max_keypermod + i]))
          {
            modmap[keycode] |= 1<<j;
          }

          if (keycode > 0)
          {
            nxagentCheckModifierMasks(keycode, j);
          }
        }
      }

      XFreeModifiermap(modifier_keymap);
      modifier_keymap = NULL;

      nxagentCheckRemoteKeycodes();

      KeySymsRec keySyms = {
        .minKeyCode = min_keycode,
        .maxKeyCode = max_keycode,
        .mapWidth = mapWidth,
        .map = keymap,
      };

#ifdef XKB
      if (!nxagentGetRemoteXkbExtension())
      {
        ErrorF("Unable to query XKEYBOARD extension.\n");
        goto XkbError;
      }

      if (noXkbExtension) {
        #ifdef TEST
        fprintf(stderr, "%s: No XKB extension.\n", __func__);
        #endif

XkbError:

        #ifdef TEST
        fprintf(stderr, "%s: XKB error.\n", __func__);
        #endif

#endif
        XGetKeyboardControl(nxagentDisplay, &values);

        memmove((char *) defaultKeyboardControl.autoRepeats,
               (char *) values.auto_repeats, sizeof(values.auto_repeats));

        #ifdef TEST
        {
          int ret =
        #endif
          InitKeyboardDeviceStruct((DevicePtr) pDev, &keySyms, modmap,
                                 nxagentBell, nxagentChangeKeyboardControl);

        #ifdef TEST
          fprintf(stderr, "%s: InitKeyboardDeviceStruct returns [%d].\n", __func__, ret);
        }
        #endif

#ifdef XKB
      } else { /* if (noXkbExtension) */
        XkbComponentNamesRec names = {0};
        char *rules = NULL, *variant = NULL, *options = NULL; /* use xkb default */

	/* handle empty string like the NULL pointer */
	if (nxagentKeyboard && nxagentKeyboard[0] == '\0')
	{
	  SAFE_free(nxagentKeyboard);
	}

        #ifdef TEST
        fprintf(stderr, "%s: Using XKB extension.\n", __func__);
        fprintf(stderr, "%s: nxagentKeyboard is [%s].\n", __func__, validateString(nxagentKeyboard));
        #endif


        /*
          from nxagent changelog:
          2.0.22:
          - Implemented handling of value "query" for nxagentKbtype. This value
          is passed by the NX client for MacOSX. If value of nxagentKbtype is
          "query" or NULL we init keyboard by core protocol functions reading
          the keyboard mapping of the X server. The property _XKB_RULES_NAMES
          is always set on the root window with default values of model and
          layout.
        */

        if (nxagentKeyboard &&
            (strcmp(nxagentKeyboard, "query") != 0) &&
            (strcmp(nxagentKeyboard, "clone") != 0))
        {
          int i;
          for (i = 0; nxagentKeyboard[i] != '/' && nxagentKeyboard[i] != '\0'; i++);

          if (nxagentKeyboard[i] == '\0' || nxagentKeyboard[i + 1] == '\0' || i == 0)
          {
            ErrorF("Warning: Wrong keyboard type: '%s'.\n", nxagentKeyboard);
            goto XkbError;
          }

          /*
            The original nxagent only supports model/layout values
            here. It uses these values together with the default rules
            and empty variant and options. We use a more or less
            compatible hack here: The special keyword rlmvo for model
            means that the layout part of the string will contain a
            full RMLVO config, separated by #, e.g.
            rlmvo/base#pc105#de,us#nodeadkeys#lv3:rwin_switch
          */
          if (strncmp(nxagentKeyboard, "rlmvo/", 6) == 0)
          {
            const char * sep = "#";
            char * rmlvo = strdup(&nxagentKeyboard[i+1]);
            char * tmp = rmlvo;
            /* strtok cannot handle empty fields, so use strsep */
            rules = strdup(strsep(&tmp, sep));
            model = strdup(strsep(&tmp, sep));
            layout = strdup(strsep(&tmp, sep));
            variant = strdup(strsep(&tmp, sep));
            options = strdup(strsep(&tmp, sep));
            SAFE_free(rmlvo);
          }
          else
          {
            model = strndup(nxagentKeyboard, i);
            layout = strdup(&nxagentKeyboard[i + 1]);
          }

          /*
           * There is no description for pc105 on Solaris.  Need to
           * revert to the closest approximation.
           */

          #ifdef TEST
          fprintf(stderr, "%s: Using [rules='%s',model='%s',layout='%s',variant='%s',options='%s'].\n",
                  __func__, rules, model, layout, variant, options);
          #endif

          #ifdef __sun

          if (strcmp(model, "pc105") == 0)
          {
            #ifdef TEST
            fprintf(stderr, "%s: WARNING! Keyboard model 'pc105' unsupported on Solaris.\n", __func__);
            fprintf(stderr, "%s: WARNING! Forcing keyboard model to 'pc104'.\n", __func__);
            #endif

            strcpy(model, "pc104");
          }

          #endif
        }
        else
        {
          #ifdef TEST
          fprintf(stderr, "%s: Using default keyboard: model [%s] layout [%s].\n", __func__,
                      model?model:"(default)", layout?layout:"(default)");
          #endif
        }

        #ifdef TEST
        fprintf(stderr, "%s: Init XKB extension.\n", __func__);
        #endif

        if (nxagentRemoteRules && nxagentRemoteModel)
        {
          #ifdef DEBUG
          fprintf(stderr, "%s: Remote: [rules='%s',model='%s',layout='%s',variant='%s',options='%s'].\n",
                  __func__, nxagentRemoteRules, nxagentRemoteModel, nxagentRemoteLayout, nxagentRemoteVariant, nxagentRemoteOptions);
          #endif

          if (nxagentKeyboard && (strcmp(nxagentKeyboard, "clone") == 0))
          {
            SAFE_free(rules); rules = strdup(nxagentRemoteRules);
            SAFE_free(model); model = strdup(nxagentRemoteModel);
            SAFE_free(layout); layout = strdup(nxagentRemoteLayout);
            SAFE_free(variant); variant = strdup(nxagentRemoteVariant);
            SAFE_free(options); options = strdup(nxagentRemoteOptions);

            /* Only setup keycode conversion if we are NOT in clone mode */
            #ifdef DEBUG
            fprintf(stderr, "%s: nxagentKeyboard is [%s] - disabling keycode conversion.\n", __func__,
                        nxagentKeyboard);
            #endif
            nxagentChangeOption(KeycodeConversion, KeycodeConversionOff);

#ifdef X2GO
            /*
             * when cloning we do not want X2Go to set the keyboard
             * via a keyboard file generated by nxagent. The defined
             * method for switching that off is the creation of a dir
             * instead of a file.
             */
            if (nxagentX2go)
            {
              nxagentWriteKeyboardDir();
            }
          }
          else
          {
            /*
             * Keyboard has always been tricky with nxagent. For that
             * reason X2Go offers "auto" keyboard configuration. You can
             * specify it in the client side session configuration. In
             * "auto" mode x2goserver expects nxagent to write the
             * remote keyboard config to a file on startup and
             * x2goserver would then pick that file and pass it to
             * setxkbmap. This functionality is obsoleted by the "clone"
             * stuff but we still need it because x2goserver does not
             * know about that yet. Once x2go starts using clone
             * we can drop this here.
             */
            if (nxagentX2go)
            {
              nxagentWriteKeyboardFile(nxagentRemoteRules, nxagentRemoteModel, nxagentRemoteLayout, nxagentRemoteVariant, nxagentRemoteOptions);
            }
#endif
          }
          nxagentKeycodeConversionSetup();
        }
        #ifdef DEBUG
        else
        {
          fprintf(stderr, "%s: Failed to retrieve remote rules.\n", __func__);
        }
        #endif

        /* we don't need the remote keyboard information anymore */
        nxagentXkbClearRemoteNames();

        xkb = XkbGetKeyboard(nxagentDisplay, XkbGBN_AllComponentsMask, XkbUseCoreKbd);

        if (xkb && xkb->geom)
        {
          XkbGetControls(nxagentDisplay, XkbAllControlsMask, xkb);
        }
        #ifdef TEST
        else
        {
          fprintf(stderr, "%s: No current keyboard.\n", __func__);
        }
        #endif

        #ifdef TEST
        if (nxagentCapsLockKeycode != 0)
        {
          fprintf(stderr, "%s: Modifiers for CapsLock (%d): 0x%x\n", __func__, nxagentCapsLockKeycode, xkb->map->modmap[nxagentCapsLockKeycode]);
        }
        if (nxagentNumLockKeycode != 0)
        {
          fprintf(stderr, "%s: Modifiers for NumLock (%d): 0x%x\n", __func__, nxagentNumLockKeycode, xkb->map->modmap[nxagentNumLockKeycode]);
        }
        #endif

        /* Users can add options to their xkb setup. E.g. setxkbmap
         * -option caps:ctrl_modifier makes CapsLock behave like the
         * Ctrl key. As we have special treatment for CapsLock and
         * NumLock to keep them in sync with the real X server we
         * check if they are assigned to another modifier. In that
         * case we disable the sync treatment by setting the according
         * keycode to 0.
         */
        if (xkb && xkb->map && xkb->map->modmap)
        {
          if (nxagentCapsLockKeycode != 0 && xkb->map->modmap[nxagentCapsLockKeycode] != LockMask)
          {
            nxagentCapsLockKeycode = 0;
            #ifdef TEST
            fprintf(stderr, "%s: CapsLock key is mapped to some other modifier - disabling special treatment\n", __func__);
            #endif
          }

          /* I have not found an xkb option definition for remapping
           * NumLock. But users can still do that manually so let's be
           * safe here.
           */
          if (xkb->map->modmap[nxagentNumLockKeycode] != Mod2Mask)
          {
            nxagentNumLockKeycode = 0;
            #ifdef TEST
            fprintf(stderr, "%s: Numock key is mapped to some other modifier - disabling special treatment\n", __func__);
            #endif
          }
        }

        #ifdef DEBUG
        fprintf(stderr, "%s: Going to set rules and init device: "
                        "[rules='%s',model='%s',layout='%s',variant='%s',options='%s'].\n", __func__,
                        rules?rules:"(default)", model?model:"(default)", layout?layout:"(default)",
                        variant?variant:"(default)", options?options:"(default)");
        #endif

        XkbSetRulesDflts(rules, model, layout, variant, options);
        XkbInitKeyboardDeviceStruct((void *)pDev, &names, &keySyms, modmap,
                                    nxagentBell, nxagentChangeKeyboardControl);

        if (nxagentKeyboard && strcmp(nxagentKeyboard, "query") == 0)
        {
          goto XkbError;
        }

        if (xkb && xkb->geom)
        {
          XkbDDXChangeControls(pDev, xkb->ctrls, xkb->ctrls);
        }

        if (nxagentOption(Shadow) && pDev && pDev->key)
        {
          NXShadowInitKeymap(&(pDev->key->curKeySyms));
        }

	SAFE_free(rules);
	SAFE_free(variant);
	SAFE_free(options);
      }

      if (xkb)
      {
        XkbFreeKeyboard(xkb, XkbAllComponentsMask, True);
        xkb = NULL;
      }

      SAFE_free(model);
      SAFE_free(layout);
#endif

      #ifdef WATCH

      fprintf(stderr, "%s: Watchpoint 10.\n", __func__);

/*
Reply   Total	Cached	Bits In			Bits Out		Bits/Reply	  Ratio
------- -----	------	-------			--------		----------	  -----
#1   U  3	2	80320 bits (10 KB) ->	28621 bits (3 KB) ->	26773/1 -> 9540/1	= 2.806:1
#98     1		256 bits (0 KB) ->	27 bits (0 KB) ->	256/1 -> 27/1	= 9.481:1
#101    1		32000 bits (4 KB) ->	2940 bits (0 KB) ->	32000/1 -> 2940/1	= 10.884:1
#119    1		384 bits (0 KB) ->	126 bits (0 KB) ->	384/1 -> 126/1	= 3.048:1
*/

      sleep(30);

      #endif

#ifdef _XSERVER64
      SAFE_free(keymap);
#else
      SAFE_XFree(keymap);
#endif
      break;
    case DEVICE_ON:

      #ifdef TEST
      fprintf(stderr, "%s: Called for [DEVICE_ON].\n", __func__);
      #endif

      if (NXDisplayError(nxagentDisplay) == 1)
      {
        return Success;
      }

      #ifdef WATCH

      fprintf(stderr, "%s: Watchpoint 11.\n", __func__);

/*
Reply   Total	Cached	Bits In			Bits Out		Bits/Reply	  Ratio
------- -----	------	-------			--------		----------	  -----
#117    1		320 bits (0 KB) ->	52 bits (0 KB) ->	320/1 -> 52/1	= 6.154:1
*/

      sleep(30);

      #endif

      nxagentEnableKeyboardEvents();

      break;

    case DEVICE_OFF:

      #ifdef TEST
      fprintf(stderr, "%s: Called for [DEVICE_OFF].\n", __func__);
      #endif

      if (NXDisplayError(nxagentDisplay) == 1)
      {
        return Success;
      }

      nxagentDisableKeyboardEvents();

      break;

    case DEVICE_CLOSE:
      #ifdef TEST
      fprintf(stderr, "%s: Called for [DEVICE_CLOSE].\n", __func__);
      #endif

      break;
  }

  return Success;
}

Bool LegalModifier(key, pDev)
     unsigned int key;
     DevicePtr pDev;
{
  return TRUE;
}

void nxagentNotifyKeyboardChanges(int oldMinKeycode, int oldMaxKeycode)
{
  #ifdef XKB

  if (!noXkbExtension)
  {
    DeviceIntPtr dev;
    xkbNewKeyboardNotify nkn = {0};

    dev = inputInfo.keyboard;

    nkn.deviceID = nkn.oldDeviceID = dev -> id;
    nkn.minKeyCode = 8;
    nkn.maxKeyCode = 255;
    nkn.oldMinKeyCode = oldMinKeycode;
    nkn.oldMaxKeyCode = oldMaxKeycode;
    nkn.requestMajor = XkbReqCode;
    nkn.requestMinor = X_kbGetKbdByName;
    nkn.changed = XkbNKN_KeycodesMask;

    XkbSendNewKeyboardNotify(dev, &nkn);
  }
  else
  {

  #endif

    xEvent event = {0};
    event.u.u.type = MappingNotify;
    event.u.mappingNotify.request = MappingKeyboard;
    event.u.mappingNotify.firstKeyCode = inputInfo.keyboard -> key -> curKeySyms.minKeyCode;
    event.u.mappingNotify.count = inputInfo.keyboard -> key -> curKeySyms.maxKeyCode -
                                      inputInfo.keyboard -> key -> curKeySyms.minKeyCode;

    /*
     *  0 is the server client
     */

    for (int i = 1; i < currentMaxClients; i++)
    {
      if (clients[i] && clients[i] -> clientState == ClientStateRunning)
      {
        event.u.u.sequenceNumber = clients[i] -> sequence;
        WriteEventsToClient(clients[i], 1, &event);
      }
    }

  #ifdef XKB

  }

  #endif

}

int nxagentResetKeyboard(void)
{
  DeviceIntPtr dev = inputInfo.keyboard;
  DeviceIntPtr devBackup;

  int oldMinKeycode = 8;
  int oldMaxKeycode = 255;

  if (NXDisplayError(nxagentDisplay) == 1)
  {
    return 0;
  }

  /*
   * Save bell settings.
   */

  int savedBellPercent = inputInfo.keyboard -> kbdfeed -> ctrl.bell;
  int savedBellPitch = inputInfo.keyboard -> kbdfeed -> ctrl.bell_pitch;
  int savedBellDuration = inputInfo.keyboard -> kbdfeed -> ctrl.bell_duration;

  #ifdef TEST
  fprintf(stderr, "%s: bellPercent [%d]  bellPitch [%d]  bellDuration [%d].\n", __func__,
              savedBellPercent, savedBellPitch, savedBellDuration);
  #endif

  if (!(devBackup = calloc(1, sizeof(DeviceIntRec))))
  {
    #ifdef PANIC
    fprintf(stderr, "%s: PANIC! Can't allocate backup structure.\n", __func__);
    #endif
  }

  nxagentSaveKeyboardDeviceData(dev, devBackup);

  if (dev->key)
  {
    #ifdef XKB
    if (!noXkbExtension && dev->key->xkbInfo)
    {
      oldMinKeycode = dev->key->xkbInfo -> desc -> min_key_code;
      oldMaxKeycode = dev->key->xkbInfo -> desc -> max_key_code;
    }
    #endif

    dev->key = NULL;
  }

  dev->focus = NULL;
  dev->kbdfeed = NULL;

  #ifdef XKB
  nxagentTuneXkbWrapper();
  #endif

  int result = (*inputInfo.keyboard -> deviceProc)(inputInfo.keyboard, DEVICE_INIT);

  if (result == Success && inputInfo.keyboard -> key != NULL)
  {

    /*
     * Restore bell settings.
     */

    inputInfo.keyboard -> kbdfeed -> ctrl.bell = savedBellPercent;
    inputInfo.keyboard -> kbdfeed -> ctrl.bell_pitch = savedBellPitch;
    inputInfo.keyboard -> kbdfeed -> ctrl.bell_duration = savedBellDuration;

    nxagentNotifyKeyboardChanges(oldMinKeycode, oldMaxKeycode);

    nxagentFreeKeyboardDeviceData(devBackup);

    SAFE_free(devBackup);

    return 1;
  }
  else
  {
    #ifdef WARNING
    fprintf(stderr, "%s: Can't initialize the keyboard device.\n", __func__);
    #endif

    nxagentRestoreKeyboardDeviceData(devBackup, dev);

    return 0;
  }
}

void nxagentCheckModifierMasks(CARD8 keycode, int j)
{
  if (keycode == XKeysymToKeycode(nxagentDisplay, XK_Meta_L))
  {
    nxagentAltMetaMask |= 1 << j;
    nxagentMetaMask |= 1 << j;
  }

  if (keycode == XKeysymToKeycode(nxagentDisplay, XK_Meta_R))
  {
    nxagentAltMetaMask |= 1 << j;
    nxagentMetaMask |= 1 << j;
  }

  if (keycode == XKeysymToKeycode(nxagentDisplay, XK_Alt_L))
  {
    nxagentAltMetaMask |= 1 << j;
    nxagentAltMask |= 1 << j;
  }

  if (keycode == XKeysymToKeycode(nxagentDisplay, XK_Alt_R))
  {
    nxagentAltMetaMask |= 1 << j;
    nxagentAltMask |= 1 << j;
  }

  if (keycode == XKeysymToKeycode(nxagentDisplay, XK_Num_Lock))
  {
    nxagentNumlockMask |= 1 << j;
  }

  if (keycode == XKeysymToKeycode(nxagentDisplay, XK_Caps_Lock) ||
      keycode == XKeysymToKeycode(nxagentDisplay, XK_Shift_Lock) )
  {
    nxagentCapsMask |= 1 << j;
  }
}

void nxagentCheckRemoteKeycodes(void)
{
  nxagentCapsLockKeycode = XKeysymToKeycode(nxagentDisplay, XK_Caps_Lock);
  nxagentNumLockKeycode  = XKeysymToKeycode(nxagentDisplay, XK_Num_Lock);

  #ifdef DEBUG
  fprintf(stderr, "%s: Remote keycodes: CapsLock [%d] NumLock [%d].\n", __func__,
                  nxagentCapsLockKeycode,nxagentNumLockKeycode);
  #endif
}

static int nxagentSaveKeyboardDeviceData(DeviceIntPtr dev, DeviceIntPtr devBackup)
{
  if (!devBackup)
  {
    #ifdef PANIC
    fprintf(stderr, "%s: PANIC! Pointer to backup structure is null.\n", __func__);
    #endif

    return -1;
  }

  devBackup -> key     = dev -> key;
  devBackup -> focus   = dev -> focus;
  devBackup -> kbdfeed = dev -> kbdfeed;

  #ifdef DEBUG
  fprintf(stderr, "%s: Saved device data.\n", __func__);
  #endif

  return 1;
}

static int nxagentRestoreKeyboardDeviceData(DeviceIntPtr devBackup, DeviceIntPtr dev)
{
  if (!devBackup)
  {
    #ifdef PANIC
    fprintf(stderr, "%s: PANIC! Pointer to backup structure is null.\n", __func__);
    #endif

    return -1;
  }

  dev -> key     = devBackup -> key;
  dev -> focus   = devBackup -> focus;
  dev -> kbdfeed = devBackup -> kbdfeed;

  #ifdef DEBUG
  fprintf(stderr, "%s: Restored device data.\n", __func__);
  #endif

  return 1;
}


static int nxagentFreeKeyboardDeviceData(DeviceIntPtr dev)
{
  if (!dev)
  {
    #ifdef PANIC
    fprintf(stderr, "%s: PANIC! Pointer to device structure is null.\n", __func__);
    #endif

    return -1;
  }

  if (dev->key)
  {
    #ifdef XKB
    if (!noXkbExtension && dev->key->xkbInfo)
    {
        XkbFreeInfo(dev->key->xkbInfo);
        dev->key->xkbInfo = NULL;
    }
    #endif

    SAFE_free(dev->key->curKeySyms.map);
    SAFE_free(dev->key->modifierKeyMap);
    SAFE_free(dev->key);
  }

  if (dev->focus)
  {
    SAFE_free(dev->focus->trace);
    SAFE_free(dev->focus);
  }

  if (dev->kbdfeed)
  {
    for (KbdFeedbackPtr k = dev->kbdfeed, knext; k; k = knext)
    {
      knext = k->next;
      #ifdef XKB
      if (k->xkb_sli)
        XkbFreeSrvLedInfo(k->xkb_sli);
      #endif
      SAFE_free(k);
    }
    dev->kbdfeed = NULL;
  }

  #ifdef DEBUG
  fprintf(stderr, "%s: Freed device data.\n", __func__);
  #endif

  return 1;
}

#if XKB

int ProcXkbInhibited(register ClientPtr client)
{
  #ifdef TEST
  fprintf(stderr, "%s: Called.\n", __func__);
  #endif

  unsigned char majorop = ((xReq *)client->requestBuffer)->reqType;

  #ifdef PANIC
  if (majorop != (unsigned char)nxagentXkbWrapper.base)
  {
    fprintf(stderr, "%s: MAJOROP is [%d] but should be [%d].\n", __func__,
            majorop, nxagentXkbWrapper.base);
  }
  #endif

  unsigned char minorop = *((unsigned char *) client->requestBuffer + 1);

  #ifdef TEST
  fprintf(stderr, "%s: MAJOROP is [%d] MINOROP is [%d].\n", __func__,
              majorop, minorop);
  #endif

  switch (minorop)
  {
    case X_kbLatchLockState:
    case X_kbSetControls:
    case X_kbSetCompatMap:
    case X_kbSetIndicatorMap:
    case X_kbSetNamedIndicator:
    case X_kbSetNames:
    case X_kbSetGeometry:
    case X_kbSetDebuggingFlags:
    case X_kbSetMap:
    {
      return client->noClientException;
    }
    case X_kbGetKbdByName:
    {
      return BadAccess;
    }
    case X_kbBell:
    case X_kbGetCompatMap:
    case X_kbGetControls:
    case X_kbGetDeviceInfo:
    case X_kbGetGeometry:
    case X_kbGetIndicatorMap:
    case X_kbGetIndicatorState:
    case X_kbGetMap:
    case X_kbGetNamedIndicator:
    case X_kbGetNames:
    case X_kbGetState:
    case X_kbListComponents:
    case X_kbPerClientFlags:
    case X_kbSelectEvents:
    case X_kbSetDeviceInfo:
    case X_kbUseExtension:
    {
      return (client->swapped ? nxagentXkbWrapper.SProcXkbDispatchBackup(client) :
                  nxagentXkbWrapper.ProcXkbDispatchBackup(client));
    }
    default:
    {
      /* Just make sure that it works in case xkb gets extended in future  */
      return BadImplementation;
    }
  }
}

void nxagentInitXkbWrapper(void)
{
  ExtensionEntry * extension;

  #ifdef TEST
  fprintf(stderr, "%s: Called.\n", __func__);
  #endif

  if (!nxagentOption(InhibitXkb))
  {
    #ifdef TEST
    fprintf(stderr, "%s: Nothing to do.\n", __func__);
    #endif

    return;
  }

  memset(&nxagentXkbWrapper, 0, sizeof(XkbWrapperRec));

  if ((extension = CheckExtension("XKEYBOARD")))
  {
    nxagentXkbWrapper.base = extension -> base;
    nxagentXkbWrapper.eventBase = extension -> eventBase;
    nxagentXkbWrapper.errorBase = extension -> errorBase;
    nxagentXkbWrapper.ProcXkbDispatchBackup  = NULL;
    nxagentXkbWrapper.SProcXkbDispatchBackup = NULL;

    #ifdef TEST
    fprintf(stderr, "%s: base [%d] eventBase [%d] errorBase [%d].\n", __func__,
                extension -> base, extension -> eventBase, extension -> errorBase);
    #endif
  }
  else
  {
    nxagentXkbWrapper.base = -1;

    #ifdef TEST
    fprintf(stderr, "%s: XKEYBOARD extension not found.\n", __func__);
    #endif
  }
}

void nxagentDisableXkbExtension(void)
{  
  #ifdef TEST
  fprintf(stderr, "%s: Called.\n", __func__);
  #endif

  if (nxagentXkbWrapper.base > 0)
  {
    if (!nxagentXkbWrapper.ProcXkbDispatchBackup)
    {
      nxagentXkbWrapper.ProcXkbDispatchBackup = ProcVector[nxagentXkbWrapper.base];

      ProcVector[nxagentXkbWrapper.base] = ProcXkbInhibited;
    }
    #ifdef TEST
    else
    {
      fprintf(stderr, "%s: Nothing to be done for ProcXkbDispatch.\n", __func__);
    }
    #endif

    if (!nxagentXkbWrapper.SProcXkbDispatchBackup)
    {
      nxagentXkbWrapper.SProcXkbDispatchBackup = SwappedProcVector[nxagentXkbWrapper.base];

      SwappedProcVector[nxagentXkbWrapper.base] = ProcXkbInhibited;
    }
    #ifdef TEST
    else
    {
      fprintf(stderr, "%s: Nothing to be done for SProcXkbDispatch.\n", __func__);
    }
    #endif
  }
}

void nxagentEnableXkbExtension(void)
{
  #ifdef TEST
  fprintf(stderr, "%s: Called.\n", __func__);
  #endif

  if (nxagentXkbWrapper.base > 0)
  {
    if (nxagentXkbWrapper.ProcXkbDispatchBackup)
    {
      ProcVector[nxagentXkbWrapper.base] = nxagentXkbWrapper.ProcXkbDispatchBackup;

      nxagentXkbWrapper.ProcXkbDispatchBackup = NULL;
    }
    #ifdef TEST
    else
    {
      fprintf(stderr, "%s: Nothing to be done for ProcXkbDispatch.\n", __func__);
    }
    #endif

    if (nxagentXkbWrapper.SProcXkbDispatchBackup)
    {
      SwappedProcVector[nxagentXkbWrapper.base] = nxagentXkbWrapper.SProcXkbDispatchBackup;

      nxagentXkbWrapper.SProcXkbDispatchBackup = NULL;
    }
    #ifdef TEST
    else
    {
      fprintf(stderr, "%s: Nothing to be done for SProcXkbDispatch.\n", __func__);
    }
    #endif
  }
}

/*
  from nxagent-3.0.0-88 changelog:

  - Fixed TR10D01539. Some XKEYBOARD requests are disabled if the option
  'keyboard' has value 'query'. This locks the initial keyboard map.
  Enabling/disabling of XKEYBOARD requests is done at run time.

  - Added -noxkblock command line option enabling the XKEYBOARD requests
  even if the option 'keyboard' value is 'query'.
*/
void nxagentTuneXkbWrapper(void)
{
  if (!nxagentOption(InhibitXkb))
  {
    #ifdef TEST
    fprintf(stderr, "%s: Nothing to do.\n", __func__);
    #endif

    return;
  }

  if (nxagentKeyboard && strcmp(nxagentKeyboard, "query") == 0)
  {
    nxagentDisableXkbExtension();
  }
  else
  {
    nxagentEnableXkbExtension();
  }
}

void nxagentXkbClearRemoteNames(void)
{
  SAFE_free(nxagentRemoteRules);
  SAFE_free(nxagentRemoteModel);
  SAFE_free(nxagentRemoteLayout);
  SAFE_free(nxagentRemoteVariant);
  SAFE_free(nxagentRemoteOptions);
}

static void nxagentXkbGetRemoteNames(void)
{
  if (nxagentRemoteRules)
    return;

  XlibAtom rulesprop = XInternAtom(nxagentDisplay, "_XKB_RULES_NAMES", 1);

  if (rulesprop == 0)
  {
    return;
  }

  XlibAtom type;
  int format;
  unsigned long n;
  unsigned long after;
  char *data = NULL;

  Status result = XGetWindowProperty(nxagentDisplay, DefaultRootWindow(nxagentDisplay),
                                         rulesprop, 0, 256, 0, XA_STRING, &type, &format,
                                             &n, &after, (unsigned char **)&data);

  if (result != Success || !data)
  {
    return;
  }

  if ((after > 0) || (type != XA_STRING) || (format != 8))
  {
    /* data non-null - has been checked above */
    SAFE_XFree(data);
    return;
  }

  char *name = data;

  if (name < data + n)
  {
    nxagentRemoteRules = strdup(name);
    name += strlen(name) + 1;
  }

  if (name < data + n)
  {
    nxagentRemoteModel = strdup(name);
    name += strlen(name) + 1;
  }

  if (name < data + n)
  {
    nxagentRemoteLayout = strdup(name);
    name += strlen(name) + 1;
  }

  if (name < data + n)
  {
    nxagentRemoteVariant = strdup(name);
    name += strlen(name) + 1;
  }

  if (name < data + n)
  {
    nxagentRemoteOptions = strdup(name);
    name += strlen(name) + 1;
  }

  SAFE_XFree(data);

  return;
}

static void writeKeyboardfileData(FILE *out, char *rules, char *model, char *layout, char *variant, char *options)
{
  /*
    How to set "empty" values with setxkbmap, result of trial and error:
    - model and layout: empty strings are accepted by setxkbmap.
    - rules: setxkbmap will fail if rules is an empty string
      (code will intercept in an earlier stage in that case)
    - variant: the variant line must be omitted completely.
    - options: prepend value with "," to override, otherwise options will be added.
  */
  fprintf(out, "rules=\"%s\"\n", rules);
  fprintf(out, "model=\"%s\"\n", model ? model : "");
  fprintf(out, "layout=\"%s\"\n", layout ? layout : "");
  if (variant && variant[0] != '\0')
    fprintf(out, "variant=\"%s\"\n", variant);
  fprintf(out, "options=\",%s\"\n", options ? options : "");
}

static char* getKeyboardFilePath(void)
{
  char *keyboard_file_path = NULL;
  char *sessionpath = nxagentGetSessionPath();
  if (sessionpath)
  {
    if ((asprintf(&keyboard_file_path, "%s/keyboard", sessionpath) == -1))
    {
      FatalError("malloc for keyboard file path failed.");
    }
  }
  else
  {
    fprintf(stderr, "Warning: Failed to determine keyboard file path: SessionPath not defined\n");
  }
  return keyboard_file_path;
}

static void nxagentWriteKeyboardDir(void)
{
  char *keyboard_file_path = getKeyboardFilePath();

  if (keyboard_file_path)
  {
    /*
     * special case: if rules is NULL create a directory instead of
     * a file. This is the defined method to disable x2gosetkeyboard.
     */
    if (mkdir(keyboard_file_path, 0555) < 0)
    {
      int save_err = errno;
      fprintf(stderr, "Warning: Failed to create keyboard blocking directory '%s': %s\n", keyboard_file_path, strerror(save_err));
    }
    else
    {
      fprintf(stderr, "Info: keyboard blocking directory created: '%s'\n", keyboard_file_path);
    }
    SAFE_free(keyboard_file_path);
  }
}

static void nxagentWriteKeyboardFile(char *rules, char *model, char *layout, char *variant, char *options)
{
  if (rules && rules[0] != '\0')
  {
    #ifdef DEBUG
    writeKeyboardfileData(stderr, rules, model, layout, variant, options);
    #endif

    char *keyboard_file_path = getKeyboardFilePath();

    if (keyboard_file_path)
    {
      FILE *keyboard_file;
      if ((keyboard_file = fopen(keyboard_file_path, "w")))
      {
        writeKeyboardfileData(keyboard_file, rules, model, layout, variant, options);
        fclose(keyboard_file);
        fprintf(stderr, "Info: keyboard file created: '%s'\n", keyboard_file_path);
      }
      else
      {
        int save_err = errno;
        fprintf(stderr, "Error: keyboard file not created: %s\n", strerror(save_err));
      }
      SAFE_free(keyboard_file_path);
    }
  }
}

void nxagentKeycodeConversionSetup(void)
{
  nxagentKeycodeConversion = False;

  if (nxagentXkbInfo.Opcode == -1)
    return;

  if (nxagentOption(KeycodeConversion) == KeycodeConversionOff)
  {
    fprintf(stderr, "Info: Keycode conversion is off\n");
  }
  else if (nxagentOption(KeycodeConversion) == KeycodeConversionOn)
  {
    fprintf(stderr, "Info: Keycode conversion is on\n");
    nxagentKeycodeConversion = True;
  }
  else
  {
    if (nxagentRemoteRules && nxagentRemoteModel &&
        (strcmp(nxagentRemoteRules, "evdev") == 0 ||
         strcmp(nxagentRemoteModel, "evdev") == 0))
    {
      #ifdef DEBUG
      fprintf(stderr, "%s: Activating KeyCode conversion.\n", __func__);
      #endif

      fprintf(stderr, "Info: Keycode conversion auto-determined as on\n");
      nxagentKeycodeConversion = True;
    }
    else
    {
      #ifdef DEBUG
      fprintf(stderr, "%s: Deactivating KeyCode conversion.\n", __func__);
      #endif

      fprintf(stderr, "Info: Keycode conversion auto-determined as off\n");
    }
  }
}

Bool nxagentGetRemoteXkbExtension(void)
{
  nxagentXkbInfo.Opcode = nxagentXkbInfo.EventBase = nxagentXkbInfo.ErrorBase = nxagentXkbInfo.MajorVersion = nxagentXkbInfo.MinorVersion = -1;
  nxagentXkbClearRemoteNames();

  Bool result = XkbQueryExtension(nxagentDisplay,
                                  &nxagentXkbInfo.Opcode,
                                  &nxagentXkbInfo.EventBase,
                                  &nxagentXkbInfo.ErrorBase,
                                  &nxagentXkbInfo.MajorVersion,
                                  &nxagentXkbInfo.MinorVersion);

  if (result)
  {
    nxagentXkbGetRemoteNames();
  }
  #ifdef WARNING
  else
  {
    fprintf(stderr, "%s: WARNING! Failed to query XKB extension.\n", __func__);
  }
  #endif

  return result;
}
#endif /* XKB */