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