1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2012 Lennart Poettering
7 Copyright 2013 Kay Sievers
9 systemd is free software; you can redistribute it and/or modify it
10 under the terms of the GNU Lesser General Public License as published by
11 the Free Software Foundation; either version 2.1 of the License, or
12 (at your option) any later version.
14 systemd is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Lesser General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with systemd; If not, see <http://www.gnu.org/licenses/>.
35 #include "bus-error.h"
36 #include "bus-message.h"
38 #include "spawn-polkit-agent.h"
43 #include "path-util.h"
46 static bool arg_no_pager = false;
47 static bool arg_ask_password = true;
48 static BusTransport arg_transport = BUS_TRANSPORT_LOCAL;
49 static char *arg_host = NULL;
50 static bool arg_convert = true;
52 static void pager_open_if_enabled(void) {
60 static void polkit_agent_open_if_enabled(void) {
62 /* Open the polkit agent as a child process if necessary */
63 if (!arg_ask_password)
66 if (arg_transport != BUS_TRANSPORT_LOCAL)
72 typedef struct StatusInfo {
74 const char *vconsole_keymap;
75 const char *vconsole_keymap_toggle;
76 const char *x11_layout;
77 const char *x11_model;
78 const char *x11_variant;
79 const char *x11_options;
82 static void print_status_info(StatusInfo *i) {
85 if (strv_isempty(i->locale))
86 puts(" System Locale: n/a\n");
90 printf(" System Locale: %s\n", i->locale[0]);
91 STRV_FOREACH(j, i->locale + 1)
95 printf(" VC Keymap: %s\n", strna(i->vconsole_keymap));
96 if (!isempty(i->vconsole_keymap_toggle))
97 printf("VC Toggle Keymap: %s\n", i->vconsole_keymap_toggle);
99 printf(" X11 Layout: %s\n", strna(i->x11_layout));
100 if (!isempty(i->x11_model))
101 printf(" X11 Model: %s\n", i->x11_model);
102 if (!isempty(i->x11_variant))
103 printf(" X11 Variant: %s\n", i->x11_variant);
104 if (!isempty(i->x11_options))
105 printf(" X11 Options: %s\n", i->x11_options);
108 static int show_status(sd_bus *bus, char **args, unsigned n) {
109 StatusInfo info = {};
110 static const struct bus_properties_map map[] = {
111 { "VConsoleKeymap", "s", NULL, offsetof(StatusInfo, vconsole_keymap) },
112 { "VConsoleKeymap", "s", NULL, offsetof(StatusInfo, vconsole_keymap) },
113 { "VConsoleKeymapToggle", "s", NULL, offsetof(StatusInfo, vconsole_keymap_toggle) },
114 { "X11Layout", "s", NULL, offsetof(StatusInfo, x11_layout) },
115 { "X11Model", "s", NULL, offsetof(StatusInfo, x11_model) },
116 { "X11Variant", "s", NULL, offsetof(StatusInfo, x11_variant) },
117 { "X11Options", "s", NULL, offsetof(StatusInfo, x11_options) },
118 { "Locale", "as", NULL, offsetof(StatusInfo, locale) },
125 r = bus_map_all_properties(bus,
126 "org.freedesktop.locale1",
127 "/org/freedesktop/locale1",
133 print_status_info(&info);
136 strv_free(info.locale);
140 static int set_locale(sd_bus *bus, char **args, unsigned n) {
141 _cleanup_bus_message_unref_ sd_bus_message *m = NULL;
142 _cleanup_bus_message_unref_ sd_bus_message *reply = NULL;
143 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
149 polkit_agent_open_if_enabled();
151 r = sd_bus_message_new_method_call(bus,
152 "org.freedesktop.locale1",
153 "/org/freedesktop/locale1",
154 "org.freedesktop.locale1",
157 return bus_log_create_error(r);
159 r = sd_bus_message_append_strv(m, args + 1);
161 return bus_log_create_error(r);
163 r = sd_bus_message_append(m, "b", arg_ask_password);
165 return bus_log_create_error(r);
167 r = sd_bus_send_with_reply_and_block(bus, m, 0, &error, NULL);
169 log_error("Failed to issue method call: %s", bus_error_message(&error, -r));
176 static int add_locales_from_archive(Set *locales) {
177 /* Stolen from glibc... */
183 /* Name hash table. */
184 uint32_t namehash_offset;
185 uint32_t namehash_used;
186 uint32_t namehash_size;
188 uint32_t string_offset;
189 uint32_t string_used;
190 uint32_t string_size;
191 /* Table with locale records. */
192 uint32_t locrectab_offset;
193 uint32_t locrectab_used;
194 uint32_t locrectab_size;
195 /* MD5 sum hash table. */
196 uint32_t sumhash_offset;
197 uint32_t sumhash_used;
198 uint32_t sumhash_size;
202 /* Hash value of the name. */
204 /* Offset of the name in the string table. */
205 uint32_t name_offset;
206 /* Offset of the locale record. */
207 uint32_t locrec_offset;
210 const struct locarhead *h;
211 const struct namehashent *e;
212 const void *p = MAP_FAILED;
213 _cleanup_close_ int fd = -1;
219 fd = open("/usr/lib/locale/locale-archive", O_RDONLY|O_NOCTTY|O_CLOEXEC);
222 log_error("Failed to open locale archive: %m");
227 if (fstat(fd, &st) < 0) {
228 log_error("fstat() failed: %m");
233 if (!S_ISREG(st.st_mode)) {
234 log_error("Archive file is not regular");
239 if (st.st_size < (off_t) sizeof(struct locarhead)) {
240 log_error("Archive has invalid size");
245 p = mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, fd, 0);
246 if (p == MAP_FAILED) {
247 log_error("Failed to map archive: %m");
252 h = (const struct locarhead *) p;
253 if (h->magic != 0xde020109 ||
254 h->namehash_offset + h->namehash_size > st.st_size ||
255 h->string_offset + h->string_size > st.st_size ||
256 h->locrectab_offset + h->locrectab_size > st.st_size ||
257 h->sumhash_offset + h->sumhash_size > st.st_size) {
258 log_error("Invalid archive file.");
263 e = (const struct namehashent*) ((const uint8_t*) p + h->namehash_offset);
264 for (i = 0; i < h->namehash_size; i++) {
267 if (e[i].locrec_offset == 0)
270 if (!utf8_is_valid((char*) p + e[i].name_offset))
273 z = strdup((char*) p + e[i].name_offset);
279 r = set_consume(locales, z);
281 log_error("Failed to add locale: %s", strerror(-r));
290 munmap((void*) p, sz);
295 static int add_locales_from_libdir (Set *locales) {
296 _cleanup_closedir_ DIR *dir;
297 struct dirent *entry;
300 dir = opendir("/usr/lib/locale");
302 log_error("Failed to open locale directory: %m");
307 while ((entry = readdir(dir))) {
310 if (entry->d_type != DT_DIR)
313 if (ignore_file(entry->d_name))
316 z = strdup(entry->d_name);
320 r = set_consume(locales, z);
321 if (r < 0 && r != -EEXIST) {
322 log_error("Failed to add locale: %s", strerror(-r));
330 log_error("Failed to read locale directory: %m");
337 static int list_locales(sd_bus *bus, char **args, unsigned n) {
338 _cleanup_set_free_ Set *locales;
339 _cleanup_strv_free_ char **l = NULL;
342 locales = set_new(string_hash_func, string_compare_func);
346 r = add_locales_from_archive(locales);
347 if (r < 0 && r != -ENOENT)
350 r = add_locales_from_libdir(locales);
354 l = set_get_strv(locales);
360 pager_open_if_enabled();
367 static int set_vconsole_keymap(sd_bus *bus, char **args, unsigned n) {
368 _cleanup_bus_message_unref_ sd_bus_message *reply = NULL;
369 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
370 const char *map, *toggle_map;
377 log_error("Too many arguments.");
381 polkit_agent_open_if_enabled();
384 toggle_map = n > 2 ? args[2] : "";
386 r = sd_bus_call_method(
388 "org.freedesktop.locale1",
389 "/org/freedesktop/locale1",
390 "org.freedesktop.locale1",
391 "SetVConsoleKeyboard",
394 "ssbb", map, toggle_map, arg_convert, arg_ask_password);
396 log_error("Failed to set keymap: %s", bus_error_message(&error, -r));
401 static Set *keymaps = NULL;
405 const struct stat *sb,
407 struct FTW *ftwbuf) {
415 if (!endswith(fpath, ".map") &&
416 !endswith(fpath, ".map.gz"))
419 p = strdup(path_get_file_name(fpath));
423 e = endswith(p, ".map");
427 e = endswith(p, ".map.gz");
431 r = set_consume(keymaps, p);
432 if (r < 0 && r != -EEXIST) {
433 log_error("Can't add keymap: %s", strerror(-r));
440 static int list_vconsole_keymaps(sd_bus *bus, char **args, unsigned n) {
441 _cleanup_strv_free_ char **l = NULL;
443 keymaps = set_new(string_hash_func, string_compare_func);
447 nftw("/usr/share/keymaps/", nftw_cb, 20, FTW_MOUNT|FTW_PHYS);
448 nftw("/usr/share/kbd/keymaps/", nftw_cb, 20, FTW_MOUNT|FTW_PHYS);
449 nftw("/usr/lib/kbd/keymaps/", nftw_cb, 20, FTW_MOUNT|FTW_PHYS);
450 nftw("/lib/kbd/keymaps/", nftw_cb, 20, FTW_MOUNT|FTW_PHYS);
452 l = set_get_strv(keymaps);
454 set_free_free(keymaps);
460 if (strv_isempty(l)) {
461 log_error("Couldn't find any console keymaps.");
467 pager_open_if_enabled();
474 static int set_x11_keymap(sd_bus *bus, char **args, unsigned n) {
475 _cleanup_bus_message_unref_ sd_bus_message *reply = NULL;
476 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
477 const char *layout, *model, *variant, *options;
484 log_error("Too many arguments.");
488 polkit_agent_open_if_enabled();
491 model = n > 2 ? args[2] : "";
492 variant = n > 3 ? args[3] : "";
493 options = n > 4 ? args[4] : "";
495 r = sd_bus_call_method(
497 "org.freedesktop.locale1",
498 "/org/freedesktop/locale1",
499 "org.freedesktop.locale1",
503 "ssssbb", layout, model, variant, options,
504 arg_convert, arg_ask_password);
506 log_error("Failed to set keymap: %s", bus_error_message(&error, -r));
511 static int list_x11_keymaps(sd_bus *bus, char **args, unsigned n) {
512 _cleanup_fclose_ FILE *f = NULL;
513 _cleanup_strv_free_ char **list = NULL;
521 } state = NONE, look_for;
525 log_error("Too many arguments.");
529 f = fopen("/usr/share/X11/xkb/rules/base.lst", "re");
531 log_error("Failed to open keyboard mapping list. %m");
535 if (streq(args[0], "list-x11-keymap-models"))
537 else if (streq(args[0], "list-x11-keymap-layouts"))
539 else if (streq(args[0], "list-x11-keymap-variants"))
541 else if (streq(args[0], "list-x11-keymap-options"))
544 assert_not_reached("Wrong parameter");
546 FOREACH_LINE(line, f, break) {
555 if (startswith(l, "! model"))
557 else if (startswith(l, "! layout"))
559 else if (startswith(l, "! variant"))
561 else if (startswith(l, "! option"))
569 if (state != look_for)
572 w = l + strcspn(l, WHITESPACE);
582 w += strspn(w, WHITESPACE);
590 if (!streq(w, args[1]))
595 r = strv_extend(&list, l);
600 if (strv_isempty(list)) {
601 log_error("Couldn't find any entries.");
608 pager_open_if_enabled();
614 static int help(void) {
616 printf("%s [OPTIONS...] COMMAND ...\n\n"
617 "Query or change system locale and keyboard settings.\n\n"
618 " -h --help Show this help\n"
619 " --version Show package version\n"
620 " --no-pager Do not pipe output into a pager\n"
621 " --no-ask-password Do not prompt for password\n"
622 " -H --host=[USER@]HOST Operate on remote host\n"
623 " -M --machine=CONTAINER Operate on local container\n"
624 " --no-convert Don't convert keyboard mappings\n\n"
626 " status Show current locale settings\n"
627 " set-locale LOCALE... Set system locale\n"
628 " list-locales Show known locales\n"
629 " set-keymap MAP [MAP] Set virtual console keyboard mapping\n"
630 " list-keymaps Show known virtual console keyboard mappings\n"
631 " set-x11-keymap LAYOUT [MODEL] [VARIANT] [OPTIONS]\n"
632 " Set X11 keyboard mapping\n"
633 " list-x11-keymap-models Show known X11 keyboard mapping models\n"
634 " list-x11-keymap-layouts Show known X11 keyboard mapping layouts\n"
635 " list-x11-keymap-variants [LAYOUT]\n"
636 " Show known X11 keyboard mapping variants\n"
637 " list-x11-keymap-options Show known X11 keyboard mapping options\n",
638 program_invocation_short_name);
643 static int parse_argv(int argc, char *argv[]) {
652 static const struct option options[] = {
653 { "help", no_argument, NULL, 'h' },
654 { "version", no_argument, NULL, ARG_VERSION },
655 { "no-pager", no_argument, NULL, ARG_NO_PAGER },
656 { "host", required_argument, NULL, 'H' },
657 { "machine", required_argument, NULL, 'M' },
658 { "no-ask-password", no_argument, NULL, ARG_NO_ASK_PASSWORD },
659 { "no-convert", no_argument, NULL, ARG_NO_CONVERT },
668 while ((c = getopt_long(argc, argv, "hH:M:", options, NULL)) >= 0) {
676 puts(PACKAGE_STRING);
677 puts(SYSTEMD_FEATURES);
688 case ARG_NO_ASK_PASSWORD:
689 arg_ask_password = false;
693 arg_transport = BUS_TRANSPORT_REMOTE;
698 arg_transport = BUS_TRANSPORT_CONTAINER;
706 assert_not_reached("Unhandled option");
713 static int localectl_main(sd_bus *bus, int argc, char *argv[]) {
715 static const struct {
723 int (* const dispatch)(sd_bus *bus, char **args, unsigned n);
725 { "status", LESS, 1, show_status },
726 { "set-locale", MORE, 2, set_locale },
727 { "list-locales", EQUAL, 1, list_locales },
728 { "set-keymap", MORE, 2, set_vconsole_keymap },
729 { "list-keymaps", EQUAL, 1, list_vconsole_keymaps },
730 { "set-x11-keymap", MORE, 2, set_x11_keymap },
731 { "list-x11-keymap-models", EQUAL, 1, list_x11_keymaps },
732 { "list-x11-keymap-layouts", EQUAL, 1, list_x11_keymaps },
733 { "list-x11-keymap-variants", LESS, 2, list_x11_keymaps },
734 { "list-x11-keymap-options", EQUAL, 1, list_x11_keymaps },
743 left = argc - optind;
746 /* Special rule: no arguments means "status" */
749 if (streq(argv[optind], "help")) {
754 for (i = 0; i < ELEMENTSOF(verbs); i++)
755 if (streq(argv[optind], verbs[i].verb))
758 if (i >= ELEMENTSOF(verbs)) {
759 log_error("Unknown operation %s", argv[optind]);
764 switch (verbs[i].argc_cmp) {
767 if (left != verbs[i].argc) {
768 log_error("Invalid number of arguments.");
775 if (left < verbs[i].argc) {
776 log_error("Too few arguments.");
783 if (left > verbs[i].argc) {
784 log_error("Too many arguments.");
791 assert_not_reached("Unknown comparison operator.");
794 return verbs[i].dispatch(bus, argv + optind, left);
797 int main(int argc, char*argv[]) {
798 _cleanup_bus_unref_ sd_bus *bus = NULL;
801 setlocale(LC_ALL, "");
802 log_parse_environment();
805 r = parse_argv(argc, argv);
809 r = bus_open_transport(arg_transport, arg_host, false, &bus);
811 log_error("Failed to create bus connection: %s", strerror(-r));
815 r = localectl_main(bus, argc, argv);
820 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;