kbdmap.c revision 228990 
1/*-
2 * Copyright (c) 2002 Jonathan Belson <jon@witchspace.com>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: head/usr.sbin/kbdmap/kbdmap.c 228990 2011-12-30 10:58:14Z uqs $");
29
30#include <sys/types.h>
31#include <sys/queue.h>
32
33#include <assert.h>
34#include <ctype.h>
35#include <dirent.h>
36#include <limits.h>
37#include <stdio.h>
38#include <stdlib.h>
39#include <string.h>
40#include <stringlist.h>
41#include <unistd.h>
42
43#include "kbdmap.h"
44
45
46static const char *lang_default = DEFAULT_LANG;
47static const char *font;
48static const char *lang;
49static const char *program;
50static const char *keymapdir = DEFAULT_KEYMAP_DIR;
51static const char *fontdir = DEFAULT_FONT_DIR;
52static const char *sysconfig = DEFAULT_SYSCONFIG;
53static const char *font_default = DEFAULT_FONT;
54static const char *font_current;
55static const char *dir;
56static const char *menu = "";
57
58static int x11;
59static int show;
60static int verbose;
61static int print;
62
63
64struct keymap {
65	char	*desc;
66	char	*keym;
67	int	mark;
68	SLIST_ENTRY(keymap) entries;
69};
70static SLIST_HEAD(slisthead, keymap) head = SLIST_HEAD_INITIALIZER(head);
71
72
73/*
74 * Get keymap entry for 'key', or NULL of not found
75 */
76static struct keymap *
77get_keymap(const char *key)
78{
79	struct keymap *km;
80
81	SLIST_FOREACH(km, &head, entries)
82		if (!strcmp(km->keym, key))
83			return km;
84
85	return NULL;
86}
87
88/*
89 * Count the number of keymaps we found
90 */
91static int
92get_num_keymaps(void)
93{
94	struct keymap *km;
95	int count = 0;
96
97	SLIST_FOREACH(km, &head, entries)
98		count++;
99
100	return count;
101}
102
103/*
104 * Remove any keymap with given keym
105 */
106static void
107remove_keymap(const char *keym)
108{
109	struct keymap *km;
110
111	SLIST_FOREACH(km, &head, entries) {
112		if (!strcmp(keym, km->keym)) {
113			SLIST_REMOVE(&head, km, keymap, entries);
114			free(km);
115			break;
116		}
117	}
118}
119
120/*
121 * Add to hash with 'key'
122 */
123static void
124add_keymap(const char *desc, int mark, const char *keym)
125{
126	struct keymap *km, *km_new;
127
128	/* Is there already an entry with this key? */
129	SLIST_FOREACH(km, &head, entries) {
130		if (!strcmp(km->keym, keym)) {
131			/* Reuse this entry */
132			free(km->desc);
133			km->desc = strdup(desc);
134			km->mark = mark;
135			return;
136		}
137	}
138
139	km_new = (struct keymap *) malloc (sizeof(struct keymap));
140	km_new->desc = strdup(desc);
141	km_new->keym = strdup(keym);
142	km_new->mark = mark;
143
144	/* Add to keymap list */
145	SLIST_INSERT_HEAD(&head, km_new, entries);
146}
147
148/*
149 * Figure out the default language to use.
150 */
151static const char *
152get_locale(void)
153{
154	const char *locale;
155
156	if ((locale = getenv("LC_ALL")) == NULL &&
157	    (locale = getenv("LC_CTYPE")) == NULL &&
158	    (locale = getenv("LANG")) == NULL)
159		locale = lang_default;
160
161	/* Check for alias */
162	if (!strcmp(locale, "C"))
163		locale = DEFAULT_LANG;
164
165	return locale;
166}
167
168/*
169 * Extract filename part
170 */
171static const char *
172extract_name(const char *name)
173{
174	char *p;
175
176	p = strrchr(name, '/');
177	if (p != NULL && p[1] != '\0')
178		return p + 1;
179
180	return name;
181}
182
183/*
184 * Return file extension or NULL
185 */
186static char *
187get_extension(const char *name)
188{
189	char *p;
190
191	p = strrchr(name, '.');
192
193	if (p != NULL && p[1] != '\0')
194		return p;
195
196	return NULL;
197}
198
199/*
200 * Read font from /etc/rc.conf else return default.
201 * Freeing the memory is the caller's responsibility.
202 */
203static char *
204get_font(void)
205{
206	char line[256], buf[20];
207	char *fnt = NULL;
208
209	FILE *fp = fopen(sysconfig, "r");
210	if (fp) {
211		while (fgets(line, sizeof(line), fp)) {
212			int a, b, matches;
213
214			if (line[0] == '#')
215				continue;
216
217			matches = sscanf(line,
218			    " font%dx%d = \"%20[-.0-9a-zA-Z_]",
219			    &a, &b, buf);
220			if (matches==3) {
221				if (strcmp(buf, "NO")) {
222					if (fnt)
223						free(fnt);
224					fnt = (char *) malloc(strlen(buf) + 1);
225					strcpy(fnt, buf);
226				}
227			}
228		}
229		fclose(fp);
230	} else
231		fprintf(stderr, "Could not open %s for reading\n", sysconfig);
232
233	return fnt;
234}
235
236/*
237 * Set a font using 'vidcontrol'
238 */
239static void
240vidcontrol(const char *fnt)
241{
242	char *tmp, *p, *q;
243	char ch;
244	int i;
245
246	/* syscons test failed */
247	if (x11)
248		return;
249
250	tmp = strdup(fnt);
251
252	/* Extract font size */
253	p = strrchr(tmp, '-');
254	if (p && p[1] != '\0') {
255		p++;
256		/* Remove any '.fnt' extension */
257		if ((q = strstr(p, ".fnt")))
258			*q = '\0';
259
260		/*
261		 * Check font size is valid, with no trailing characters
262		 *  ('&ch' should not be matched)
263		 */
264		if (sscanf(p, "%dx%d%c", &i, &i, &ch) != 2)
265			fprintf(stderr, "Which font size? %s\n", fnt);
266		else {
267			char *cmd;
268			asprintf(&cmd, "vidcontrol -f %s %s", p, fnt);
269			if (verbose)
270				fprintf(stderr, "%s\n", cmd);
271			system(cmd);
272			free(cmd);
273		}
274	} else
275		fprintf(stderr, "Which font size? %s\n", fnt);
276
277	free(tmp);
278}
279
280/*
281 * Execute 'kbdcontrol' with the appropriate arguments
282 */
283static void
284do_kbdcontrol(struct keymap *km)
285{
286	char *kbd_cmd;
287	asprintf(&kbd_cmd, "kbdcontrol -l %s/%s", dir, km->keym);
288
289	if (!x11)
290		system(kbd_cmd);
291
292	fprintf(stderr, "keymap=\"%s\"\n", km->keym);
293	free(kbd_cmd);
294}
295
296/*
297 * Call 'vidcontrol' with the appropriate arguments
298 */
299static void
300do_vidfont(struct keymap *km)
301{
302	char *vid_cmd, *tmp, *p, *q;
303
304	asprintf(&vid_cmd, "%s/%s", dir, km->keym);
305	vidcontrol(vid_cmd);
306	free(vid_cmd);
307
308	tmp = strdup(km->keym);
309	p = strrchr(tmp, '-');
310	if (p && p[1]!='\0') {
311		p++;
312		q = get_extension(p);
313		if (q) {
314			*q = '\0';
315			printf("font%s=%s\n", p, km->keym);
316		}
317	}
318	free(tmp);
319}
320
321/*
322 * Display dialog from 'keymaps[]'
323 */
324static void
325show_dialog(struct keymap **km_sorted, int num_keymaps)
326{
327	FILE *fp;
328	char *cmd, *dialog;
329	char tmp_name[] = "/tmp/_kbd_lang.XXXX";
330	const char *ext;
331	int fd, i, size;
332
333	fd = mkstemp(tmp_name);
334	if (fd == -1) {
335		fprintf(stderr, "Could not open temporary file \"%s\"\n",
336		    tmp_name);
337		exit(1);
338	}
339	asprintf(&dialog, "/usr/bin/dialog --clear --title \"Keyboard Menu\" "
340			  "--menu \"%s\" 0 0 0", menu);
341
342	ext = extract_name(dir);
343
344	/* start right font, assume that current font is equal
345	 * to default font in /etc/rc.conf
346	 *
347	 * $font is the font which require the language $lang; e.g.
348	 * russian *need* a koi8 font
349	 * $font_current is the current font from /etc/rc.conf
350	 */
351	if (font && strcmp(font, font_current))
352		vidcontrol(font);
353
354	/* Build up the command */
355	size = 0;
356	for (i=0; i<num_keymaps; i++) {
357		/*
358		 * Each 'font' is passed as ' "font" ""', so allow the
359		 * extra space
360		 */
361		size += strlen(km_sorted[i]->desc) + 6;
362	}
363
364	/* Allow the space for '2> tmpfilename' redirection */
365	size += strlen(tmp_name) + 3;
366
367	cmd = (char *) malloc(strlen(dialog) + size + 1);
368	strcpy(cmd, dialog);
369
370	for (i=0; i<num_keymaps; i++) {
371		strcat(cmd, " \"");
372		strcat(cmd, km_sorted[i]->desc);
373		strcat(cmd, "\"");
374		strcat(cmd, " \"\"");
375	}
376
377	strcat(cmd, " 2>");
378	strcat(cmd, tmp_name);
379
380	/* Show the dialog.. */
381	system(cmd);
382
383	fp = fopen(tmp_name, "r");
384	if (fp) {
385		char choice[64];
386		if (fgets(choice, sizeof(choice), fp) != NULL) {
387			/* Find key for desc */
388			for (i=0; i<num_keymaps; i++) {
389				if (!strcmp(choice, km_sorted[i]->desc)) {
390					if (!strcmp(program, "kbdmap"))
391						do_kbdcontrol(km_sorted[i]);
392					else
393						do_vidfont(km_sorted[i]);
394					break;
395				}
396			}
397		} else {
398			if (font != NULL && strcmp(font, font_current))
399				/* Cancelled, restore old font */
400				vidcontrol(font_current);
401		}
402		fclose(fp);
403	} else
404		fprintf(stderr, "Failed to open temporary file");
405
406	/* Tidy up */
407	remove(tmp_name);
408	free(cmd);
409	free(dialog);
410	close(fd);
411}
412
413/*
414 * Search for 'token' in comma delimited array 'buffer'.
415 * Return true for found, false for not found.
416 */
417static int
418find_token(const char *buffer, const char *token)
419{
420	char *buffer_tmp, *buffer_copy, *inputstring;
421	char **ap;
422	int found;
423
424	buffer_copy = strdup(buffer);
425	buffer_tmp = buffer_copy;
426	inputstring = buffer_copy;
427	ap = &buffer_tmp;
428
429	found = 0;
430
431	while ((*ap = strsep(&inputstring, ",")) != NULL) {
432		if (strcmp(buffer_tmp, token) == 0) {
433			found = 1;
434			break;
435		}
436	}
437
438	free(buffer_copy);
439
440	return found;
441}
442
443/*
444 * Compare function for qsort
445 */
446static int
447compare_keymap(const void *a, const void *b)
448{
449
450	/* We've been passed pointers to pointers, so: */
451	const struct keymap *km1 = *((const struct keymap * const *) a);
452	const struct keymap *km2 = *((const struct keymap * const *) b);
453
454	return strcmp(km1->desc, km2->desc);
455}
456
457/*
458 * Compare function for qsort
459 */
460static int
461compare_lang(const void *a, const void *b)
462{
463	const char *l1 = *((const char * const *) a);
464	const char *l2 = *((const char * const *) b);
465
466	return strcmp(l1, l2);
467}
468
469/*
470 * Change '8x8' to '8x08' so qsort will put it before eg. '8x14'
471 */
472static void
473kludge_desc(struct keymap **km_sorted, int num_keymaps)
474{
475	int i;
476
477	for (i=0; i<num_keymaps; i++) {
478		char *p;
479		char *km = km_sorted[i]->desc;
480		if ((p = strstr(km, "8x8")) != NULL) {
481			int len;
482			int j;
483			int offset;
484
485			offset = p - km;
486
487			/* Make enough space for the extra '0' */
488			len = strlen(km);
489			km = realloc(km, len + 2);
490
491			for (j=len; j!=offset+1; j--)
492				km[j + 1] = km[j];
493
494			km[offset+2] = '0';
495
496			km_sorted[i]->desc = km;
497		}
498	}
499}
500
501/*
502 * Reverse 'kludge_desc()' - change '8x08' back to '8x8'
503 */
504static void
505unkludge_desc(struct keymap **km_sorted, int num_keymaps)
506{
507	int i;
508
509	for (i=0; i<num_keymaps; i++) {
510		char *p;
511		char *km = km_sorted[i]->desc;
512		if ((p = strstr(km, "8x08")) != NULL) {
513			p += 2;
514			while (*p++)
515				p[-1] = p[0];
516
517			km = realloc(km, p - km - 1);
518			km_sorted[i]->desc = km;
519		}
520	}
521}
522
523/*
524 * Return 0 if file exists and is readable, else -1
525 */
526static int
527check_file(const char *keym)
528{
529	int status = 0;
530
531	if (access(keym, R_OK) == -1) {
532		char *fn;
533		asprintf(&fn, "%s/%s", dir, keym);
534		if (access(fn, R_OK) == -1) {
535			if (verbose)
536				fprintf(stderr, "%s not found!\n", fn);
537			status = -1;
538		}
539		free(fn);
540	} else {
541		if (verbose)
542			fprintf(stderr, "No read permission for %s!\n", keym);
543		status = -1;
544	}
545
546	return status;
547}
548
549/*
550 * Read options from the relevant configuration file, then
551 *  present to user.
552 */
553static void
554menu_read(void)
555{
556	const char *lg;
557	char *p;
558	int mark, num_keymaps, items, i;
559	char buffer[256], filename[PATH_MAX];
560	char keym[64], lng[64], desc[64];
561	char dialect[64], lang_abk[64];
562	struct keymap *km;
563	struct keymap **km_sorted;
564	struct dirent *dp;
565	StringList *lang_list;
566	FILE *fp;
567	DIR *dirp;
568
569	lang_list = sl_init();
570
571	sprintf(filename, "%s/INDEX.%s", dir, extract_name(dir));
572
573	/* en_US.ISO8859-1 -> en_..\.ISO8859-1 */
574	strlcpy(dialect, lang, sizeof(dialect));
575	if (strlen(dialect) >= 6 && dialect[2] == '_') {
576		dialect[3] = '.';
577		dialect[4] = '.';
578	}
579
580
581	/* en_US.ISO8859-1 -> en */
582	strlcpy(lang_abk, lang, sizeof(lang_abk));
583	if (strlen(lang_abk) >= 3 && lang_abk[2] == '_')
584		lang_abk[2] = '\0';
585
586	fprintf(stderr, "lang_default = %s\n", lang_default);
587	fprintf(stderr, "dialect = %s\n", dialect);
588	fprintf(stderr, "lang_abk = %s\n", lang_abk);
589
590	fp = fopen(filename, "r");
591	if (fp) {
592		int matches;
593		while (fgets(buffer, sizeof(buffer), fp)) {
594			p = buffer;
595			if (p[0] == '#')
596				continue;
597
598			while (isspace(*p))
599				p++;
600
601			if (*p == '\0')
602				continue;
603
604			/* Parse input, removing newline */
605			matches = sscanf(p, "%64[^:]:%64[^:]:%64[^:\n]",
606			    keym, lng, desc);
607			if (matches == 3) {
608				if (strcmp(keym, "FONT")
609				    && strcmp(keym, "MENU")) {
610					/* Check file exists & is readable */
611					if (check_file(keym) == -1)
612						continue;
613				}
614			}
615
616			if (show) {
617				/*
618				 * Take note of supported languages, which
619				 * might be in a comma-delimited list
620				 */
621				char *tmp = strdup(lng);
622				char *delim = tmp;
623
624				for (delim = tmp; ; ) {
625					char ch = *delim++;
626					if (ch == ',' || ch == '\0') {
627						delim[-1] = '\0';
628						if (!sl_find(lang_list, tmp))
629							sl_add(lang_list, tmp);
630						if (ch == '\0')
631							break;
632						tmp = delim;
633					}
634				}
635			}
636			/* Set empty language to default language */
637			if (lng[0] == '\0')
638				lg = lang_default;
639			else
640				lg = lng;
641
642
643			/* 4) Your choice if it exists
644			 * 3) Long match eg. en_GB.ISO8859-1 is equal to
645			 *      en_..\.ISO8859-1
646			 * 2) short match 'de'
647			 * 1) default langlist 'en'
648			 * 0) any language
649			 *
650			 * Language may be a comma separated list
651			 * A higher match overwrites a lower
652			 * A later entry overwrites a previous if it exists
653			 *     twice in the database
654			 */
655
656			/* Check for favoured language */
657			km = get_keymap(keym);
658			mark = (km) ? km->mark : 0;
659
660			if (find_token(lg, lang))
661				add_keymap(desc, 4, keym);
662			else if (mark <= 3 && find_token(lg, dialect))
663				add_keymap(desc, 3, keym);
664			else if (mark <= 2 && find_token(lg, lang_abk))
665				add_keymap(desc, 2, keym);
666			else if (mark <= 1 && find_token(lg, lang_default))
667				add_keymap(desc, 1, keym);
668			else if (mark <= 0)
669				add_keymap(desc, 0, keym);
670		}
671		fclose(fp);
672
673	} else
674		printf("Could not open file\n");
675
676	if (show) {
677		qsort(lang_list->sl_str, lang_list->sl_cur, sizeof(char*),
678		    compare_lang);
679		printf("Currently supported languages: ");
680		for (i=0; i< (int) lang_list->sl_cur; i++)
681			printf("%s ", lang_list->sl_str[i]);
682		puts("");
683		exit(0);
684	}
685
686	km = get_keymap("MENU");
687	if (km)
688		/* Take note of menu title */
689		menu = strdup(km->desc);
690	km = get_keymap("FONT");
691	if (km)
692		/* Take note of language font */
693		font = strdup(km->desc);
694
695	/* Remove unwanted items from list */
696	remove_keymap("MENU");
697	remove_keymap("FONT");
698
699	/* Look for keymaps not in database */
700	dirp = opendir(dir);
701	if (dirp) {
702		while ((dp = readdir(dirp)) != NULL) {
703			const char *ext = get_extension(dp->d_name);
704			if (ext) {
705				if ((!strcmp(ext, ".fnt") ||
706				    !strcmp(ext, ".kbd")) &&
707				    !get_keymap(dp->d_name)) {
708					char *q;
709
710					/* Remove any .fnt or .kbd extension */
711					q = strdup(dp->d_name);
712					*(get_extension(q)) = '\0';
713					add_keymap(q, 0, dp->d_name);
714					free(q);
715
716					if (verbose)
717						fprintf(stderr,
718						    "'%s' not in database\n",
719						    dp->d_name);
720				}
721			}
722		}
723		closedir(dirp);
724	} else
725		fprintf(stderr, "Could not open directory '%s'\n", dir);
726
727	/* Sort items in keymap */
728	num_keymaps = get_num_keymaps();
729
730	km_sorted = (struct keymap **)
731	    malloc(num_keymaps*sizeof(struct keymap *));
732
733	/* Make array of pointers to items in hash */
734	items = 0;
735	SLIST_FOREACH(km, &head, entries)
736		km_sorted[items++] = km;
737
738	/* Change '8x8' to '8x08' so sort works as we might expect... */
739	kludge_desc(km_sorted, num_keymaps);
740
741	qsort(km_sorted, num_keymaps, sizeof(struct keymap *), compare_keymap);
742
743	/* ...change back again */
744	unkludge_desc(km_sorted, num_keymaps);
745
746	if (print) {
747		for (i=0; i<num_keymaps; i++)
748			printf("%s\n", km_sorted[i]->desc);
749		exit(0);
750	}
751
752	show_dialog(km_sorted, num_keymaps);
753
754	free(km_sorted);
755}
756
757/*
758 * Display usage information and exit
759 */
760static void
761usage(void)
762{
763
764	fprintf(stderr, "usage: %s\t[-K] [-V] [-d|-default] [-h|-help] "
765	    "[-l|-lang language]\n\t\t[-p|-print] [-r|-restore] [-s|-show] "
766	    "[-v|-verbose]\n", program);
767	exit(1);
768}
769
770static void
771parse_args(int argc, char **argv)
772{
773	int i;
774
775	for (i=1; i<argc; i++) {
776		if (argv[i][0] != '-')
777			usage();
778		else if (!strcmp(argv[i], "-help") || !strcmp(argv[i], "-h"))
779			usage();
780		else if (!strcmp(argv[i], "-verbose") || !strcmp(argv[i], "-v"))
781			verbose = 1;
782		else if (!strcmp(argv[i], "-lang") || !strcmp(argv[i], "-l"))
783			if (i + 1 == argc)
784				usage();
785			else
786				lang = argv[++i];
787		else if (!strcmp(argv[i], "-default") || !strcmp(argv[i], "-d"))
788			lang = lang_default;
789		else if (!strcmp(argv[i], "-show") || !strcmp(argv[i], "-s"))
790			show = 1;
791		else if (!strcmp(argv[i], "-print") || !strcmp(argv[i], "-p"))
792			print = 1;
793		else if (!strcmp(argv[i], "-restore") ||
794		    !strcmp(argv[i], "-r")) {
795			vidcontrol(font_current);
796			exit(0);
797		} else if (!strcmp(argv[i], "-K"))
798			dir = keymapdir;
799		else if (!strcmp(argv[i], "-V"))
800			dir = fontdir;
801		else
802			usage();
803	}
804}
805
806/*
807 * A front-end for the 'vidfont' and 'kbdmap' programs.
808 */
809int
810main(int argc, char **argv)
811{
812
813	x11 = system("kbdcontrol -d >/dev/null");
814
815	if (x11) {
816		fprintf(stderr, "You are not on a virtual console - "
817				"expect certain strange side-effects\n");
818		sleep(2);
819	}
820
821	SLIST_INIT(&head);
822
823	lang = get_locale();
824
825	program = extract_name(argv[0]);
826
827	font_current = get_font();
828	if (font_current == NULL)
829		font_current = font_default;
830
831	if (strcmp(program, "kbdmap"))
832		dir = fontdir;
833	else
834		dir = keymapdir;
835
836	/* Parse command line arguments */
837	parse_args(argc, argv);
838
839	/* Read and display options */
840	menu_read();
841
842	return 0;
843}
844