Merge pull request #66 from rbreaves/hotfix

- Fixes Kinto startup delay on cold boots. Closes #65

.gitattributes

@@ -0,0 +1,3 @@
+*.py linguist-detectable=false
+*.json liguist-detectable=false
+*.c linguist-detectable=true

.xkb/symbols/mac_gui

@@ -1,3 +1,8 @@
+hidden partial modifier_keys
+xkb_symbols "swapescape" {
+    key <CAPS> { [ Escape ] };
+    key <ESC>  { [ Caps_Lock ] };
+};
 default partial xkb_symbols "mac_levelssym" {
     // LEFT to Begin Line or Beginning of word
     replace key <LEFT> {

README.md

@@ -26,15 +26,13 @@ Kinto works for standard Windows, Apple and Chromebook keyboards. The following
 - systemd
 - x11
 - IBus*
-- Fedora/RHEL/Debian/Ubuntu based distro 16.04+
+- Fedora/RHEL/Manjaro/Arch/Debian/Ubuntu based distro 16.04+
 
-If you need kintox11 recompiled for your distro please let me know and I will add a binary for your distro if my binary fails.
-
-You can also attempt to compile kintox11.c on your system as well, but you will need to compile and install json-c first as its libraries will be required to compile and run the program.
+Binary is included and will be installed, but you can also compile kintox11.c on your system. You will need to compile and install json-c first as its libraries will be required to compile and run the program.
 
 *IBus is needed to support wordwise during browser app usage as the keymap will need to change slightly depending if the cursor/caret is on screen waiting for input. Setup.py will set it but you can manually set it as well or check your current Input Method.
 
-To confirm navigate to your "Language Support" and set "Keyboard input method system:" to IBus for full word-wise support with web browsers.
+On most distros you can confirm navigate to your "Language Support" and set "Keyboard input method system:" to IBus for full word-wise support with web browsers. 
 
 Wayland support is planned, but not ready yet.
 
@@ -57,8 +55,104 @@ sudo apt install python3
 ./setup.py
 ```
 
+To Uninstall Kinto
+
+```
+./uninstall.sh
+```
+
+## Other Notes Related to Install
+
+**Manjaro with Gnome there are issues.** 
+
+Please see this ticket for more information.
+
+https://github.com/rbreaves/kinto/issues/59
+
+https://wiki.archlinux.org/index.php/IBus
+
+**For other Arch based distros.**
+
+Append the following and logoff and back on, but only after running setup.py to install all packages and the kinto service. Please report if there are any difficulties.
+nano ~/.bashrc
+```
+export GTK_IM_MODULE=xim
+export XMODIFIERS=@im=ibus
+export QT_IM_MODULE=xim
+```
+
+## How to Upgrade Kinto
+
+Simply bring down the latest in either the master branch or dev, but dev is sometimes in flux as new features are being developed. Then you can re-run the setup.py installer, it will stop the service and re-install Kinto.
+
+Note: If you have made any custom changes to ~/.xkb or ~/.config/kinto then you will need to backup or rename those directories before running an update.
+
+```
+git pull origin master
+./setup.py
+```
+
+## How to Control Kinto
+
+Under systemd this is how you control Kinto.
+
+Status
+```
+systemctl --user status keyswap
+```
+
+Stop (your keymap will return to normal)
+```
+systemctl --user stop keyswap
+```
+
+Start
+```
+systemctl --user start keyswap
+```
+
+Restart
+```
+systemctl --user restart keyswap
+```
+
+Enable
+```
+systemctl --user enable keyswap
+```
+
+Disable
+```
+systemctl --user disable keyswap
+```
+
+## How to Add Setxkbmap Option inside Kinto
+
+To summarize you'll need to pull the partial out of the symbols file the option resides in and then add that to the mac_gui file and lastly reference it in the keymap file(s) you want it in.
+
+symbols directory
+```
+/usr/share/X11/xkb/symbols/ 
+```
+
+symbols file
+```
+~/.xkb/symbols/mac_gui
+```
+
+keymap files
+```
+~/.xkb/keymap/kbd.mac.gui
+~/.xkb/keymap/kbd.mac.term
+```
+
+A more detailed explaination is here.
+https://github.com/rbreaves/kinto/issues/50#issuecomment-595953373
+
 ## How to Add or Change keymaps for Applications
 
+Note: All of the following is already done in Kinto (but may also change as improvements are made). The following is purely for documentation and example sake as they are real examples of how to leverage the json config to support additional keymaps.
+
 **First it is important to understand how Kinto operates.**
 
 1. It listens for any focus/active window changes
@@ -323,40 +417,6 @@ You can also add additional Desktop Environment related tweaks to user_config.js
 }
 ```
 
-## How to Control Kinto
-
-Under systemd this is how you control Kinto.
-
-Status
-```
-systemctl --user status keyswap
-```
-
-Stop (your keymap will return to normal)
-```
-systemctl --user stop keyswap
-```
-
-Start
-```
-systemctl --user start keyswap
-```
-
-Restart
-```
-systemctl --user restart keyswap
-```
-
-Enable
-```
-systemctl --user enable keyswap
-```
-
-Disable
-```
-systemctl --user disable keyswap
-```
-
 ## Learning macOS style hotkeys on Linux
 
 You can use websites like https://www.shortcutfoo.com in Google Chrome while using the terminal style keymap, but Firefox is not compatible due to detecting "cmd" as keycode 224. Chrome detects Win/Super/Cmd as keycode 91 on all OS's.

defaults.json

@@ -9,8 +9,8 @@
 		"type":"windows",
 		"active": false,
 		"description":"Standard Windows 104 Keyboards",
-		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY",
-		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY",
+		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY 2>&1 | grep -v XF86FullScreen",
+		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY 2>&1 | grep -v XF86FullScreen",
 		"xkb_symbols_gui":"+altwin(ctrl_alt_win)+mac_gui(mac_levelssym)",
 		"xkb_symbols_term":"+altwin(swap_alt_win)+mac_term(mac_win)+mac_term(mac_global)",
 		"xkb_types_gui":"+mac_gui(addmac_levels)",
@@ -22,8 +22,8 @@
 		"type":"mac",
 		"active": false,
 		"description":"Standard Mac Keyboards with Apple driver",
-		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY",
-		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY",
+		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY 2>&1 | grep -v XF86FullScreen",
+		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY 2>&1 | grep -v XF86FullScreen",
 		"xkb_symbols_gui":"+altwin(ctrl_alt_win)+mac_gui(mac_levelssym)",
 		"xkb_symbols_term":"+altwin(swap_alt_win)+mac_term(mac_win)+mac_term(mac_global)",
 		"xkb_types_gui":"+mac_gui(addmac_levels)",
@@ -36,8 +36,8 @@
 		"type":"mac",
 		"active": true,
 		"description":"Standard Mac Keyboards",
-		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY",
-		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY",
+		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY 2>&1 | grep -v XF86FullScreen",
+		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY 2>&1 | grep -v XF86FullScreen",
 		"xkb_symbols_gui":"+ctrl(swap_lwin_lctl)+ctrl(swap_rwin_rctl)+mac_gui(mac_levelssym)",
 		"xkb_symbols_term":"+altwin(alt_super_win)+mac_term(mac_apple)+mac_term(mac_global)",
 		"xkb_types_gui":"+mac_gui(addmac_levels)",
@@ -49,8 +49,8 @@
 		"type":"chromebook",
 		"active": false,
 		"description":"Standard Chromebook Keyboards",
-		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY",
-		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY",
+		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY 2>&1 | grep -v XF86FullScreen",
+		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY 2>&1 | grep -v XF86FullScreen",
 		"xkb_symbols_gui":"+chromebook(swap_lalt_lctrl)+mac_gui(mac_levelssym)",
 		"xkb_symbols_term":"+altwin(swap_alt_win)+mac_term_chromebook(mac_levelssym)",
 		"xkb_types_gui":"+mac_gui(addmac_levels)",
@@ -62,9 +62,9 @@
 		"type":"chromebook",
 		"active": false,
 		"description":"Chromebook with Windows 104 Keyboard",
-		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY; setxkbmap -device $usbid -option altwin:ctrl_alt_win",
-		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY",
-		"fallbackgui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY",
+		"gui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY 2>&1 | grep -v XF86FullScreen; setxkbmap -device $usbid -option altwin:ctrl_alt_win",
+		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY 2>&1 | grep -v XF86FullScreen",
+		"fallbackgui":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY 2>&1 | grep -v XF86FullScreen",
 		"xkb_symbols_gui":"+chromebook(swap_lalt_lctrl)+mac_gui(mac_levelssym)",
 		"xkb_symbols_term":"+altwin(swap_alt_win)+mac_term_chromebook(mac_levelssym)",
 		"xkb_types_gui":"+mac_gui(addmac_levels)",
@@ -76,8 +76,8 @@
 		"type":"chromebook",
 		"active": false,
 		"description":"Chromebook with Mac Keyboard",
-		"gui":"setxkbmap -option;setxkbmap -option ctrl:swap_lwin_lctl; xkbcomp -w0 -i $internalid -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY",
-		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY",
+		"gui":"setxkbmap -option;setxkbmap -option ctrl:swap_lwin_lctl; xkbcomp -w0 -i $internalid -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.gui $DISPLAY 2>&1 | grep -v XF86FullScreen",
+		"term":"setxkbmap -option;xkbcomp -w0 -I$HOME/.xkb ~/.xkb/keymap/kbd.mac.term $DISPLAY 2>&1 | grep -v XF86FullScreen",
 		"xkb_symbols_gui":"+chromebook(swap_lalt_lctrl)+mac_gui(mac_levelssym)",
 		"xkb_symbols_term":"+altwin(swap_alt_win)+mac_term_chromebook(mac_levelssym)",
 		"xkb_types_gui":"+mac_gui(addmac_levels)",

keyswap_service.sh

@@ -4,18 +4,23 @@ systemctl --user stop keyswap >/dev/null 2>&1
 systemctl --user disable keyswap >/dev/null 2>&1
 systemctl --user stop keyswap.timer >/dev/null 2>&1
 systemctl --user disable keyswap.timer >/dev/null 2>&1
-swapcmd="\/bin\/bash -c \"\/home\/`whoami`\/.config\/kinto\/xactive.sh carrots\""
-swapstopcmd="\/bin\/bash \/home\/`whoami`\/.config\/kinto\/cleanup.sh"
 mkdir -p ~/.config/systemd/user
 mkdir -p ~/.config/autostart
 cp ./system-config/keyswap.service ~/.config/systemd/user/keyswap.service
 cp ./system-config/kinto.desktop ~/.config/autostart/kinto.desktop
+cp ./system-config/keyswap.timer ~/.config/systemd/user/keyswap.timer
 cp ./kintox11/binary/kintox11 ~/.config/kinto/kintox11
 cp ./system-config/xactive.sh ~/.config/kinto/xactive.sh
 cp ./system-config/caret_status.sh ~/.config/kinto/caret_status.sh
 cp ./system-config/cleanup.sh ~/.config/kinto/cleanup.sh
 cp ./system-config/.firefox-nw ~/.config/kinto/.firefox-nw
 sed -i "s/{username}/`whoami`/g" ~/.config/systemd/user/keyswap.service
+sed -i "s/{displayid}/`echo "$DISPLAY"`/g" ~/.config/systemd/user/keyswap.service
+if [ "${#DISPLAY}" -gt 2 ]
+	then
+	sed -i "s/#Environment/Environment/g" ~/.config/systemd/user/keyswap.service
+fi
 systemctl --user daemon-reload
-systemctl --user enable keyswap
-systemctl --user start keyswap
+sed -i "s/ExecStart=/ExecStart=${swapcmd}/g" ~/.config/systemd/user/keyswap.service
+systemctl --user enable keyswap.timer
+systemctl --user start keyswap.timer

setup.py

@@ -25,15 +25,19 @@ def requirements(pkgm):
 
 def install_ibus():
 	print(bcolors.CYELLOW + "You need to set IBus as the default Input Method for full word-wise support and re-run this installer.\n" + bcolors.ENDC)
+	print(bcolors.CYELLOW + "Confirm the IBus Setup by saying Yes and then closing the window.\n" + bcolors.ENDC)
+	print("ibus-setup\n")
 	print("im-config -n ibus\n")
 	run_install = yn_choice(bcolors.CYELLOW + "Would you like to run it now? (Will require logoff and logon.)\n" + bcolors.ENDC)
 	if(run_install):
+		os.system("ibus-setup")
 		os.system("im-config -n ibus")
 		print("\n")
 		input("IBus has been set as the default Input Method.\nPress any key to exit and re-run after logoff & logon...")
 		sys.exit()
 
-check_x11 = cmdline("env | grep -i x11").strip()
+# check_x11 = cmdline("env | grep -i x11").strip()
+check_x11 = cmdline("env | grep -i x11 || loginctl show-session \"$XDG_SESSION_ID\" -p Type | awk -F= '{print $2}'").strip()
 
 if len(check_x11) == 0:
 	print("You are not using x11, please logout and back in using x11/Xorg")
@@ -41,22 +45,21 @@ if len(check_x11) == 0:
 
 check_xbind = cmdline("which xbindkeys 2>/dev/null").strip()
 check_xdotool = cmdline("which xdotool 2>/dev/null").strip()
+check_ibus = cmdline("which ibus-setup 2>/dev/null").strip()
 
-pkgm = cmdline("which apt 2>/dev/null").strip()
+pkgm = cmdline("which apt-get 2>/dev/null").strip()
 
 if len(pkgm) == 0:
 	pkgm = cmdline("which dnf 2>/dev/null").strip()
 	if len(pkgm) > 0:
-		pkgm += " install -y "
+		pkgm += " check-update;sudo dnf install -y "
 else:
-	pkgm += " install -y "
+	pkgm += " update; sudo apt-get install -y "
 
 if len(pkgm) == 0:
 	pkgm = cmdline("which pacman 2>/dev/null").strip()
 	if len(pkgm) > 0:
-		pkgm += " -S "
-else:
-	print("hello")
+		pkgm += " -Syy; sudo pacman -S "
 
 
 if len(pkgm) == 0:
@@ -67,14 +70,18 @@ if len(pkgm) == 0:
 runpkg = 0
 run_pkg = ""
 
-if len(check_xbind) > 0 and len(check_xdotool) > 0:
-	print("Xbindkeys, and xdotool requirement is installed.")
+if len(check_xbind) > 0 and len(check_xdotool) > 0 and len(check_ibus) > 0:
+	print("Xbindkeys, xdotool and IBus requirement is installed.")
 if len(check_xbind) == 0:
 	run_pkg = "xbindkeys"
 	runpkg = 1
 if len(check_xdotool) == 0:
 	run_pkg += " xdotool"
 	runpkg = 1
+if len(check_ibus) == 0:
+	# may differ with distro, but for now
+	run_pkg += " ibus"
+	runpkg = 1
 
 if runpkg != 0:
 	requirements(pkgm)

system-config/keyswap.service

@@ -5,7 +5,8 @@ PartOf=graphical-session.target
 [Service]
 Type=simple
 Restart=always
-#Environment=DISPLAY=:0.0
+# eg DISPLAY=:0.0
+#Environment=DISPLAY={displayid}
 RestartSec=1
 WorkingDirectory=/home/{username}/.config/kinto
 ExecStart=/bin/bash -c "/home/{username}/.config/kinto/xactive.sh carrots"

system-config/keyswap.timer

@@ -0,0 +1,11 @@
+# keyswap.timer
+[Unit]
+Description=Runs the keyswap.service 5 seconds after boot up
+
+[Timer]
+#OnBootSec=5s
+OnActiveSec=5s
+Unit=keyswap.service
+
+[Install]
+WantedBy=default.target

system-config/kinto.desktop

@@ -2,7 +2,7 @@
 Name=Kinto
 GenericName=Kinto
 Comment=Make Linux Type Like it's a Mac
-Exec=/usr/bin/systemctl --user start keyswap
+Exec=/bin/sleep 5 /usr/bin/systemctl --user start keyswap
 Terminal=false
 Type=Application
 X-GNOME-Autostart-enabled=true

user_config.json

@@ -36,7 +36,7 @@
         "symbols": "",
         "types": "",
         "de": [],
-        "appnames": [ "Chromium","Chromium-browser","Google-chrome" ]
+        "appnames": [ "Chromium","Chromium-browser","Google-chrome","Epiphany" ]
     }],
 	"init": [],
 	"detypes":["gnome2","gnome3","kde4","kde5","xfce","i3wm"],