src/locale/localectl.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2
   3 #include <ftw.h>
   4 #include <getopt.h>
   5 #include <locale.h>
   6 #include <stdbool.h>
   7 #include <stdlib.h>
   8 #include <string.h>
   9
  10 #include "sd-bus.h"
  11
  12 #include "bus-error.h"
  13 #include "bus-util.h"
  14 #include "def.h"
  15 #include "fd-util.h"
  16 #include "fileio.h"
  17 #include "locale-util.h"
  18 #include "pager.h"
  19 #include "proc-cmdline.h"
  20 #include "set.h"
  21 #include "spawn-polkit-agent.h"
  22 #include "strv.h"
  23 #include "terminal-util.h"
  24 #include "util.h"
  25 #include "verbs.h"
  26 #include "virt.h"
  27
  28 static PagerFlags arg_pager_flags = 0;
  29 static bool arg_ask_password = true;
  30 static BusTransport arg_transport = BUS_TRANSPORT_LOCAL;
  31 static char *arg_host = NULL;
  32 static bool arg_convert = true;
  33
  34 typedef struct StatusInfo {
  35         char **locale;
  36         const char *vconsole_keymap;
  37         const char *vconsole_keymap_toggle;
  38         const char *x11_layout;
  39         const char *x11_model;
  40         const char *x11_variant;
  41         const char *x11_options;
  42 } StatusInfo;
  43
  44 static void status_info_clear(StatusInfo *info) {
  45         if (info) {
  46                 strv_free(info->locale);
  47                 zero(*info);
  48         }
  49 }
  50
  51 static void print_overridden_variables(void) {
  52         _cleanup_(locale_variables_freep) char *variables[_VARIABLE_LC_MAX] = {};
  53         bool print_warning = true;
  54         LocaleVariable j;
  55         int r;
  56
  57         if (arg_transport != BUS_TRANSPORT_LOCAL)
  58                 return;
  59
  60         r = proc_cmdline_get_key_many(
  61                         PROC_CMDLINE_STRIP_RD_PREFIX,
  62                         "locale.LANG",              &variables[VARIABLE_LANG],
  63                         "locale.LANGUAGE",          &variables[VARIABLE_LANGUAGE],
  64                         "locale.LC_CTYPE",          &variables[VARIABLE_LC_CTYPE],
  65                         "locale.LC_NUMERIC",        &variables[VARIABLE_LC_NUMERIC],
  66                         "locale.LC_TIME",           &variables[VARIABLE_LC_TIME],
  67                         "locale.LC_COLLATE",        &variables[VARIABLE_LC_COLLATE],
  68                         "locale.LC_MONETARY",       &variables[VARIABLE_LC_MONETARY],
  69                         "locale.LC_MESSAGES",       &variables[VARIABLE_LC_MESSAGES],
  70                         "locale.LC_PAPER",          &variables[VARIABLE_LC_PAPER],
  71                         "locale.LC_NAME",           &variables[VARIABLE_LC_NAME],
  72                         "locale.LC_ADDRESS",        &variables[VARIABLE_LC_ADDRESS],
  73                         "locale.LC_TELEPHONE",      &variables[VARIABLE_LC_TELEPHONE],
  74                         "locale.LC_MEASUREMENT",    &variables[VARIABLE_LC_MEASUREMENT],
  75                         "locale.LC_IDENTIFICATION", &variables[VARIABLE_LC_IDENTIFICATION]);
  76         if (r < 0 && r != -ENOENT) {
  77                 log_warning_errno(r, "Failed to read /proc/cmdline: %m");
  78                 return;
  79         }
  80
  81         for (j = 0; j < _VARIABLE_LC_MAX; j++)
  82                 if (variables[j]) {
  83                         if (print_warning) {
  84                                 log_warning("Warning: Settings on kernel command line override system locale settings in /etc/locale.conf.\n"
  85                                             "    Command Line: %s=%s", locale_variable_to_string(j), variables[j]);
  86
  87                                 print_warning = false;
  88                         } else
  89                                 log_warning("                  %s=%s", locale_variable_to_string(j), variables[j]);
  90                 }
  91 }
  92
  93 static void print_status_info(StatusInfo *i) {
  94         assert(i);
  95
  96         if (strv_isempty(i->locale))
  97                 puts("   System Locale: n/a");
  98         else {
  99                 char **j;
 100
 101                 printf("   System Locale: %s\n", i->locale[0]);
 102                 STRV_FOREACH(j, i->locale + 1)
 103                         printf("                  %s\n", *j);
 104         }
 105
 106         printf("       VC Keymap: %s\n", strna(i->vconsole_keymap));
 107         if (!isempty(i->vconsole_keymap_toggle))
 108                 printf("VC Toggle Keymap: %s\n", i->vconsole_keymap_toggle);
 109
 110         printf("      X11 Layout: %s\n", strna(i->x11_layout));
 111         if (!isempty(i->x11_model))
 112                 printf("       X11 Model: %s\n", i->x11_model);
 113         if (!isempty(i->x11_variant))
 114                 printf("     X11 Variant: %s\n", i->x11_variant);
 115         if (!isempty(i->x11_options))
 116                 printf("     X11 Options: %s\n", i->x11_options);
 117 }
 118
 119 static int show_status(int argc, char **argv, void *userdata) {
 120         _cleanup_(status_info_clear) StatusInfo info = {};
 121         static const struct bus_properties_map map[]  = {
 122                 { "VConsoleKeymap",       "s",  NULL, offsetof(StatusInfo, vconsole_keymap) },
 123                 { "VConsoleKeymapToggle", "s",  NULL, offsetof(StatusInfo, vconsole_keymap_toggle) },
 124                 { "X11Layout",            "s",  NULL, offsetof(StatusInfo, x11_layout) },
 125                 { "X11Model",             "s",  NULL, offsetof(StatusInfo, x11_model) },
 126                 { "X11Variant",           "s",  NULL, offsetof(StatusInfo, x11_variant) },
 127                 { "X11Options",           "s",  NULL, offsetof(StatusInfo, x11_options) },
 128                 { "Locale",               "as", NULL, offsetof(StatusInfo, locale) },
 129                 {}
 130         };
 131
 132         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 133         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
 134         sd_bus *bus = userdata;
 135         int r;
 136
 137         assert(bus);
 138
 139         r = bus_map_all_properties(bus,
 140                                    "org.freedesktop.locale1",
 141                                    "/org/freedesktop/locale1",
 142                                    map,
 143                                    0,
 144                                    &error,
 145                                    &m,
 146                                    &info);
 147         if (r < 0)
 148                 return log_error_errno(r, "Could not get properties: %s", bus_error_message(&error, r));
 149
 150         print_overridden_variables();
 151         print_status_info(&info);
 152
 153         return r;
 154 }
 155
 156 static int set_locale(int argc, char **argv, void *userdata) {
 157         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
 158         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 159         sd_bus *bus = userdata;
 160         int r;
 161
 162         assert(bus);
 163
 164         polkit_agent_open_if_enabled(arg_transport, arg_ask_password);
 165
 166         r = sd_bus_message_new_method_call(
 167                         bus,
 168                         &m,
 169                         "org.freedesktop.locale1",
 170                         "/org/freedesktop/locale1",
 171                         "org.freedesktop.locale1",
 172                         "SetLocale");
 173         if (r < 0)
 174                 return bus_log_create_error(r);
 175
 176         r = sd_bus_message_append_strv(m, argv + 1);
 177         if (r < 0)
 178                 return bus_log_create_error(r);
 179
 180         r = sd_bus_message_append(m, "b", arg_ask_password);
 181         if (r < 0)
 182                 return bus_log_create_error(r);
 183
 184         r = sd_bus_call(bus, m, 0, &error, NULL);
 185         if (r < 0)
 186                 return log_error_errno(r, "Failed to issue method call: %s", bus_error_message(&error, -r));
 187
 188         return 0;
 189 }
 190
 191 static int list_locales(int argc, char **argv, void *userdata) {
 192         _cleanup_strv_free_ char **l = NULL;
 193         int r;
 194
 195         r = get_locales(&l);
 196         if (r < 0)
 197                 return log_error_errno(r, "Failed to read list of locales: %m");
 198
 199         (void) pager_open(arg_pager_flags);
 200         strv_print(l);
 201
 202         return 0;
 203 }
 204
 205 static int set_vconsole_keymap(int argc, char **argv, void *userdata) {
 206         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 207         const char *map, *toggle_map;
 208         sd_bus *bus = userdata;
 209         int r;
 210
 211         assert(bus);
 212
 213         polkit_agent_open_if_enabled(arg_transport, arg_ask_password);
 214
 215         map = argv[1];
 216         toggle_map = argc > 2 ? argv[2] : "";
 217
 218         r = sd_bus_call_method(
 219                         bus,
 220                         "org.freedesktop.locale1",
 221                         "/org/freedesktop/locale1",
 222                         "org.freedesktop.locale1",
 223                         "SetVConsoleKeyboard",
 224                         &error,
 225                         NULL,
 226                         "ssbb", map, toggle_map, arg_convert, arg_ask_password);
 227         if (r < 0)
 228                 return log_error_errno(r, "Failed to set keymap: %s", bus_error_message(&error, -r));
 229
 230         return 0;
 231 }
 232
 233 static int list_vconsole_keymaps(int argc, char **argv, void *userdata) {
 234         _cleanup_strv_free_ char **l = NULL;
 235         int r;
 236
 237         r = get_keymaps(&l);
 238         if (r < 0)
 239                 return log_error_errno(r, "Failed to read list of keymaps: %m");
 240
 241         (void) pager_open(arg_pager_flags);
 242
 243         strv_print(l);
 244
 245         return 0;
 246 }
 247
 248 static int set_x11_keymap(int argc, char **argv, void *userdata) {
 249         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 250         const char *layout, *model, *variant, *options;
 251         sd_bus *bus = userdata;
 252         int r;
 253
 254         polkit_agent_open_if_enabled(arg_transport, arg_ask_password);
 255
 256         layout = argv[1];
 257         model = argc > 2 ? argv[2] : "";
 258         variant = argc > 3 ? argv[3] : "";
 259         options = argc > 4 ? argv[4] : "";
 260
 261         r = sd_bus_call_method(
 262                         bus,
 263                         "org.freedesktop.locale1",
 264                         "/org/freedesktop/locale1",
 265                         "org.freedesktop.locale1",
 266                         "SetX11Keyboard",
 267                         &error,
 268                         NULL,
 269                         "ssssbb", layout, model, variant, options,
 270                                   arg_convert, arg_ask_password);
 271         if (r < 0)
 272                 return log_error_errno(r, "Failed to set keymap: %s", bus_error_message(&error, -r));
 273
 274         return 0;
 275 }
 276
 277 static int list_x11_keymaps(int argc, char **argv, void *userdata) {
 278         _cleanup_fclose_ FILE *f = NULL;
 279         _cleanup_strv_free_ char **list = NULL;
 280         enum {
 281                 NONE,
 282                 MODELS,
 283                 LAYOUTS,
 284                 VARIANTS,
 285                 OPTIONS
 286         } state = NONE, look_for;
 287         int r;
 288
 289         f = fopen("/usr/share/X11/xkb/rules/base.lst", "re");
 290         if (!f)
 291                 return log_error_errno(errno, "Failed to open keyboard mapping list. %m");
 292
 293         if (streq(argv[0], "list-x11-keymap-models"))
 294                 look_for = MODELS;
 295         else if (streq(argv[0], "list-x11-keymap-layouts"))
 296                 look_for = LAYOUTS;
 297         else if (streq(argv[0], "list-x11-keymap-variants"))
 298                 look_for = VARIANTS;
 299         else if (streq(argv[0], "list-x11-keymap-options"))
 300                 look_for = OPTIONS;
 301         else
 302                 assert_not_reached("Wrong parameter");
 303
 304         for (;;) {
 305                 _cleanup_free_ char *line = NULL;
 306                 char *l, *w;
 307
 308                 r = read_line(f, LONG_LINE_MAX, &line);
 309                 if (r < 0)
 310                         return log_error_errno(r, "Failed to read keyboard mapping list: %m");
 311                 if (r == 0)
 312                         break;
 313
 314                 l = strstrip(line);
 315
 316                 if (isempty(l))
 317                         continue;
 318
 319                 if (l[0] == '!') {
 320                         if (startswith(l, "! model"))
 321                                 state = MODELS;
 322                         else if (startswith(l, "! layout"))
 323                                 state = LAYOUTS;
 324                         else if (startswith(l, "! variant"))
 325                                 state = VARIANTS;
 326                         else if (startswith(l, "! option"))
 327                                 state = OPTIONS;
 328                         else
 329                                 state = NONE;
 330
 331                         continue;
 332                 }
 333
 334                 if (state != look_for)
 335                         continue;
 336
 337                 w = l + strcspn(l, WHITESPACE);
 338
 339                 if (argc > 1) {
 340                         char *e;
 341
 342                         if (*w == 0)
 343                                 continue;
 344
 345                         *w = 0;
 346                         w++;
 347                         w += strspn(w, WHITESPACE);
 348
 349                         e = strchr(w, ':');
 350                         if (!e)
 351                                 continue;
 352
 353                         *e = 0;
 354
 355                         if (!streq(w, argv[1]))
 356                                 continue;
 357                 } else
 358                         *w = 0;
 359
 360                 r = strv_extend(&list, l);
 361                 if (r < 0)
 362                         return log_oom();
 363         }
 364
 365         if (strv_isempty(list)) {
 366                 log_error("Couldn't find any entries.");
 367                 return -ENOENT;
 368         }
 369
 370         strv_sort(list);
 371         strv_uniq(list);
 372
 373         (void) pager_open(arg_pager_flags);
 374
 375         strv_print(list);
 376         return 0;
 377 }
 378
 379 static int help(void) {
 380         _cleanup_free_ char *link = NULL;
 381         int r;
 382
 383         r = terminal_urlify_man("localectl", "1", &link);
 384         if (r < 0)
 385                 return log_oom();
 386
 387         printf("%s [OPTIONS...] COMMAND ...\n\n"
 388                "Query or change system locale and keyboard settings.\n\n"
 389                "  -h --help                Show this help\n"
 390                "     --version             Show package version\n"
 391                "     --no-pager            Do not pipe output into a pager\n"
 392                "     --no-ask-password     Do not prompt for password\n"
 393                "  -H --host=[USER@]HOST    Operate on remote host\n"
 394                "  -M --machine=CONTAINER   Operate on local container\n"
 395                "     --no-convert          Don't convert keyboard mappings\n\n"
 396                "Commands:\n"
 397                "  status                   Show current locale settings\n"
 398                "  set-locale LOCALE...     Set system locale\n"
 399                "  list-locales             Show known locales\n"
 400                "  set-keymap MAP [MAP]     Set console and X11 keyboard mappings\n"
 401                "  list-keymaps             Show known virtual console keyboard mappings\n"
 402                "  set-x11-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]\n"
 403                "                           Set X11 and console keyboard mappings\n"
 404                "  list-x11-keymap-models   Show known X11 keyboard mapping models\n"
 405                "  list-x11-keymap-layouts  Show known X11 keyboard mapping layouts\n"
 406                "  list-x11-keymap-variants [LAYOUT]\n"
 407                "                           Show known X11 keyboard mapping variants\n"
 408                "  list-x11-keymap-options  Show known X11 keyboard mapping options\n"
 409                "\nSee the %s for details.\n"
 410                , program_invocation_short_name
 411                , link
 412         );
 413
 414         return 0;
 415 }
 416
 417 static int verb_help(int argc, char **argv, void *userdata) {
 418         return help();
 419 }
 420
 421 static int parse_argv(int argc, char *argv[]) {
 422
 423         enum {
 424                 ARG_VERSION = 0x100,
 425                 ARG_NO_PAGER,
 426                 ARG_NO_CONVERT,
 427                 ARG_NO_ASK_PASSWORD
 428         };
 429
 430         static const struct option options[] = {
 431                 { "help",            no_argument,       NULL, 'h'                 },
 432                 { "version",         no_argument,       NULL, ARG_VERSION         },
 433                 { "no-pager",        no_argument,       NULL, ARG_NO_PAGER        },
 434                 { "host",            required_argument, NULL, 'H'                 },
 435                 { "machine",         required_argument, NULL, 'M'                 },
 436                 { "no-ask-password", no_argument,       NULL, ARG_NO_ASK_PASSWORD },
 437                 { "no-convert",      no_argument,       NULL, ARG_NO_CONVERT      },
 438                 {}
 439         };
 440
 441         int c;
 442
 443         assert(argc >= 0);
 444         assert(argv);
 445
 446         while ((c = getopt_long(argc, argv, "hH:M:", options, NULL)) >= 0)
 447
 448                 switch (c) {
 449
 450                 case 'h':
 451                         return help();
 452
 453                 case ARG_VERSION:
 454                         return version();
 455
 456                 case ARG_NO_CONVERT:
 457                         arg_convert = false;
 458                         break;
 459
 460                 case ARG_NO_PAGER:
 461                         arg_pager_flags |= PAGER_DISABLE;
 462                         break;
 463
 464                 case ARG_NO_ASK_PASSWORD:
 465                         arg_ask_password = false;
 466                         break;
 467
 468                 case 'H':
 469                         arg_transport = BUS_TRANSPORT_REMOTE;
 470                         arg_host = optarg;
 471                         break;
 472
 473                 case 'M':
 474                         arg_transport = BUS_TRANSPORT_MACHINE;
 475                         arg_host = optarg;
 476                         break;
 477
 478                 case '?':
 479                         return -EINVAL;
 480
 481                 default:
 482                         assert_not_reached("Unhandled option");
 483                 }
 484
 485         return 1;
 486 }
 487
 488 static int localectl_main(sd_bus *bus, int argc, char *argv[]) {
 489
 490         static const Verb verbs[] = {
 491                 { "status",                   VERB_ANY, 1,        VERB_DEFAULT, show_status           },
 492                 { "set-locale",               2,        VERB_ANY, 0,            set_locale            },
 493                 { "list-locales",             VERB_ANY, 1,        0,            list_locales          },
 494                 { "set-keymap",               2,        3,        0,            set_vconsole_keymap   },
 495                 { "list-keymaps",             VERB_ANY, 1,        0,            list_vconsole_keymaps },
 496                 { "set-x11-keymap",           2,        5,        0,            set_x11_keymap        },
 497                 { "list-x11-keymap-models",   VERB_ANY, 1,        0,            list_x11_keymaps      },
 498                 { "list-x11-keymap-layouts",  VERB_ANY, 1,        0,            list_x11_keymaps      },
 499                 { "list-x11-keymap-variants", VERB_ANY, 2,        0,            list_x11_keymaps      },
 500                 { "list-x11-keymap-options",  VERB_ANY, 1,        0,            list_x11_keymaps      },
 501                 { "help",                     VERB_ANY, VERB_ANY, 0,            verb_help             }, /* Not documented, but supported since it is created. */
 502                 {}
 503         };
 504
 505         return dispatch_verb(argc, argv, verbs, bus);
 506 }
 507
 508 int main(int argc, char*argv[]) {
 509         sd_bus *bus = NULL;
 510         int r;
 511
 512         setlocale(LC_ALL, "");
 513         log_parse_environment();
 514         log_open();
 515
 516         r = parse_argv(argc, argv);
 517         if (r <= 0)
 518                 goto finish;
 519
 520         r = bus_connect_transport(arg_transport, arg_host, false, &bus);
 521         if (r < 0) {
 522                 log_error_errno(r, "Failed to create bus connection: %m");
 523                 goto finish;
 524         }
 525
 526         r = localectl_main(bus, argc, argv);
 527
 528 finish:
 529         /* make sure we terminate the bus connection first, and then close the
 530          * pager, see issue #3543 for the details. */
 531         sd_bus_flush_close_unref(bus);
 532         pager_close();
 533
 534         return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
 535 }