src/timedate/timedatectl.c

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2012 Lennart Poettering
   7   Copyright 2013 Kay Sievers
   8
   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.
  13
  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.
  18
  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/>.
  21 ***/
  22
  23 #include <getopt.h>
  24 #include <locale.h>
  25 #include <stdbool.h>
  26 #include <stdlib.h>
  27
  28 #include "sd-bus.h"
  29
  30 #include "bus-error.h"
  31 #include "bus-util.h"
  32 #include "pager.h"
  33 #include "spawn-polkit-agent.h"
  34 #include "strv.h"
  35 #include "terminal-util.h"
  36 #include "util.h"
  37
  38 static bool arg_no_pager = false;
  39 static bool arg_ask_password = true;
  40 static BusTransport arg_transport = BUS_TRANSPORT_LOCAL;
  41 static char *arg_host = NULL;
  42 static bool arg_adjust_system_clock = false;
  43
  44 static void pager_open_if_enabled(void) {
  45
  46         if (arg_no_pager)
  47                 return;
  48
  49         pager_open(false);
  50 }
  51
  52 static void polkit_agent_open_if_enabled(void) {
  53
  54         /* Open the polkit agent as a child process if necessary */
  55         if (!arg_ask_password)
  56                 return;
  57
  58         if (arg_transport != BUS_TRANSPORT_LOCAL)
  59                 return;
  60
  61         polkit_agent_open();
  62 }
  63
  64 typedef struct StatusInfo {
  65         usec_t time;
  66         char *timezone;
  67
  68         usec_t rtc_time;
  69         bool rtc_local;
  70
  71         bool ntp_enabled;
  72         bool ntp_capable;
  73         bool ntp_synced;
  74 } StatusInfo;
  75
  76 static void status_info_clear(StatusInfo *info) {
  77         if (info) {
  78                 free(info->timezone);
  79                 zero(*info);
  80         }
  81 }
  82
  83 static void print_status_info(const StatusInfo *i) {
  84         char a[FORMAT_TIMESTAMP_MAX];
  85         struct tm tm;
  86         time_t sec;
  87         bool have_time = false;
  88         const char *old_tz = NULL, *tz;
  89         int r;
  90
  91         assert(i);
  92
  93         /* Save the old $TZ */
  94         tz = getenv("TZ");
  95         if (tz)
  96                 old_tz = strdupa(tz);
  97
  98         /* Set the new $TZ */
  99         if (setenv("TZ", isempty(i->timezone) ? "UTC" : i->timezone, true) < 0)
 100                 log_warning_errno(errno, "Failed to set TZ environment variable, ignoring: %m");
 101         else
 102                 tzset();
 103
 104         if (i->time != 0) {
 105                 sec = (time_t) (i->time / USEC_PER_SEC);
 106                 have_time = true;
 107         } else if (IN_SET(arg_transport, BUS_TRANSPORT_LOCAL, BUS_TRANSPORT_MACHINE)) {
 108                 sec = time(NULL);
 109                 have_time = true;
 110         } else
 111                 log_warning("Could not get time from timedated and not operating locally, ignoring.");
 112
 113         if (have_time) {
 114                 xstrftime(a, "%a %Y-%m-%d %H:%M:%S %Z", localtime_r(&sec, &tm));
 115                 printf("      Local time: %.*s\n", (int) sizeof(a), a);
 116
 117                 xstrftime(a, "%a %Y-%m-%d %H:%M:%S UTC", gmtime_r(&sec, &tm));
 118                 printf("  Universal time: %.*s\n", (int) sizeof(a), a);
 119         } else {
 120                 printf("      Local time: %s\n", "n/a");
 121                 printf("  Universal time: %s\n", "n/a");
 122         }
 123
 124         if (i->rtc_time > 0) {
 125                 time_t rtc_sec;
 126
 127                 rtc_sec = (time_t) (i->rtc_time / USEC_PER_SEC);
 128                 xstrftime(a, "%a %Y-%m-%d %H:%M:%S", gmtime_r(&rtc_sec, &tm));
 129                 printf("        RTC time: %.*s\n", (int) sizeof(a), a);
 130         } else
 131                 printf("        RTC time: %s\n", "n/a");
 132
 133         if (have_time)
 134                 xstrftime(a, "%Z, %z", localtime_r(&sec, &tm));
 135
 136         /* Restore the $TZ */
 137         if (old_tz)
 138                 r = setenv("TZ", old_tz, true);
 139         else
 140                 r = unsetenv("TZ");
 141         if (r < 0)
 142                 log_warning_errno(errno, "Failed to set TZ environment variable, ignoring: %m");
 143         else
 144                 tzset();
 145
 146         printf("       Time zone: %s (%.*s)\n"
 147                " Network time on: %s\n"
 148                "NTP synchronized: %s\n"
 149                " RTC in local TZ: %s\n",
 150                strna(i->timezone), (int) sizeof(a), have_time ? a : "n/a",
 151                i->ntp_capable ? yes_no(i->ntp_enabled) : "n/a",
 152                yes_no(i->ntp_synced),
 153                yes_no(i->rtc_local));
 154
 155         if (i->rtc_local)
 156                 fputs("\n" ANSI_HIGHLIGHT
 157                       "Warning: The system is configured to read the RTC time in the local time zone.\n"
 158                       "         This mode can not be fully supported. It will create various problems\n"
 159                       "         with time zone changes and daylight saving time adjustments. The RTC\n"
 160                       "         time is never updated, it relies on external facilities to maintain it.\n"
 161                       "         If at all possible, use RTC in UTC by calling\n"
 162                       "         'timedatectl set-local-rtc 0'." ANSI_NORMAL "\n", stdout);
 163 }
 164
 165 static int show_status(sd_bus *bus, char **args, unsigned n) {
 166         _cleanup_(status_info_clear) StatusInfo info = {};
 167         static const struct bus_properties_map map[]  = {
 168                 { "Timezone",        "s", NULL, offsetof(StatusInfo, timezone) },
 169                 { "LocalRTC",        "b", NULL, offsetof(StatusInfo, rtc_local) },
 170                 { "NTP",             "b", NULL, offsetof(StatusInfo, ntp_enabled) },
 171                 { "CanNTP",          "b", NULL, offsetof(StatusInfo, ntp_capable) },
 172                 { "NTPSynchronized", "b", NULL, offsetof(StatusInfo, ntp_synced) },
 173                 { "TimeUSec",        "t", NULL, offsetof(StatusInfo, time) },
 174                 { "RTCTimeUSec",     "t", NULL, offsetof(StatusInfo, rtc_time) },
 175                 {}
 176         };
 177         int r;
 178
 179         assert(bus);
 180
 181         r = bus_map_all_properties(bus,
 182                                    "org.freedesktop.timedate1",
 183                                    "/org/freedesktop/timedate1",
 184                                    map,
 185                                    &info);
 186         if (r < 0)
 187                 return log_error_errno(r, "Failed to query server: %m");
 188
 189         print_status_info(&info);
 190
 191         return r;
 192 }
 193
 194 static int set_time(sd_bus *bus, char **args, unsigned n) {
 195         _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
 196         bool relative = false, interactive = arg_ask_password;
 197         usec_t t;
 198         int r;
 199
 200         assert(args);
 201         assert(n == 2);
 202
 203         polkit_agent_open_if_enabled();
 204
 205         r = parse_timestamp(args[1], &t);
 206         if (r < 0) {
 207                 log_error("Failed to parse time specification: %s", args[1]);
 208                 return r;
 209         }
 210
 211         r = sd_bus_call_method(bus,
 212                                "org.freedesktop.timedate1",
 213                                "/org/freedesktop/timedate1",
 214                                "org.freedesktop.timedate1",
 215                                "SetTime",
 216                                &error,
 217                                NULL,
 218                                "xbb", (int64_t)t, relative, interactive);
 219         if (r < 0)
 220                 log_error("Failed to set time: %s", bus_error_message(&error, -r));
 221
 222         return r;
 223 }
 224
 225 static int set_timezone(sd_bus *bus, char **args, unsigned n) {
 226         _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
 227         int r;
 228
 229         assert(args);
 230         assert(n == 2);
 231
 232         polkit_agent_open_if_enabled();
 233
 234         r = sd_bus_call_method(bus,
 235                                "org.freedesktop.timedate1",
 236                                "/org/freedesktop/timedate1",
 237                                "org.freedesktop.timedate1",
 238                                "SetTimezone",
 239                                &error,
 240                                NULL,
 241                                "sb", args[1], arg_ask_password);
 242         if (r < 0)
 243                 log_error("Failed to set time zone: %s", bus_error_message(&error, -r));
 244
 245         return r;
 246 }
 247
 248 static int set_local_rtc(sd_bus *bus, char **args, unsigned n) {
 249         _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
 250         int r, b;
 251
 252         assert(args);
 253         assert(n == 2);
 254
 255         polkit_agent_open_if_enabled();
 256
 257         b = parse_boolean(args[1]);
 258         if (b < 0) {
 259                 log_error("Failed to parse local RTC setting: %s", args[1]);
 260                 return b;
 261         }
 262
 263         r = sd_bus_call_method(bus,
 264                                "org.freedesktop.timedate1",
 265                                "/org/freedesktop/timedate1",
 266                                "org.freedesktop.timedate1",
 267                                "SetLocalRTC",
 268                                &error,
 269                                NULL,
 270                                "bbb", b, arg_adjust_system_clock, arg_ask_password);
 271         if (r < 0)
 272                 log_error("Failed to set local RTC: %s", bus_error_message(&error, -r));
 273
 274         return r;
 275 }
 276
 277 static int set_ntp(sd_bus *bus, char **args, unsigned n) {
 278         _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
 279         int b, r;
 280
 281         assert(args);
 282         assert(n == 2);
 283
 284         polkit_agent_open_if_enabled();
 285
 286         b = parse_boolean(args[1]);
 287         if (b < 0) {
 288                 log_error("Failed to parse NTP setting: %s", args[1]);
 289                 return b;
 290         }
 291
 292         r = sd_bus_call_method(bus,
 293                                "org.freedesktop.timedate1",
 294                                "/org/freedesktop/timedate1",
 295                                "org.freedesktop.timedate1",
 296                                "SetNTP",
 297                                &error,
 298                                NULL,
 299                                "bb", b, arg_ask_password);
 300         if (r < 0)
 301                 log_error("Failed to set ntp: %s", bus_error_message(&error, -r));
 302
 303         return r;
 304 }
 305
 306 static int list_timezones(sd_bus *bus, char **args, unsigned n) {
 307         _cleanup_strv_free_ char **zones = NULL;
 308         int r;
 309
 310         assert(args);
 311         assert(n == 1);
 312
 313         r = get_timezones(&zones);
 314         if (r < 0)
 315                 return log_error_errno(r, "Failed to read list of time zones: %m");
 316
 317         pager_open_if_enabled();
 318         strv_print(zones);
 319
 320         return 0;
 321 }
 322
 323 static void help(void) {
 324         printf("%s [OPTIONS...] COMMAND ...\n\n"
 325                "Query or change system time and date settings.\n\n"
 326                "  -h --help                Show this help message\n"
 327                "     --version             Show package version\n"
 328                "     --no-pager            Do not pipe output into a pager\n"
 329                "     --no-ask-password     Do not prompt for password\n"
 330                "  -H --host=[USER@]HOST    Operate on remote host\n"
 331                "  -M --machine=CONTAINER   Operate on local container\n"
 332                "     --adjust-system-clock Adjust system clock when changing local RTC mode\n\n"
 333                "Commands:\n"
 334                "  status                   Show current time settings\n"
 335                "  set-time TIME            Set system time\n"
 336                "  set-timezone ZONE        Set system time zone\n"
 337                "  list-timezones           Show known time zones\n"
 338                "  set-local-rtc BOOL       Control whether RTC is in local time\n"
 339                "  set-ntp BOOL             Enable or disable network time synchronization\n",
 340                program_invocation_short_name);
 341 }
 342
 343 static int parse_argv(int argc, char *argv[]) {
 344
 345         enum {
 346                 ARG_VERSION = 0x100,
 347                 ARG_NO_PAGER,
 348                 ARG_ADJUST_SYSTEM_CLOCK,
 349                 ARG_NO_ASK_PASSWORD
 350         };
 351
 352         static const struct option options[] = {
 353                 { "help",                no_argument,       NULL, 'h'                     },
 354                 { "version",             no_argument,       NULL, ARG_VERSION             },
 355                 { "no-pager",            no_argument,       NULL, ARG_NO_PAGER            },
 356                 { "host",                required_argument, NULL, 'H'                     },
 357                 { "machine",             required_argument, NULL, 'M'                     },
 358                 { "no-ask-password",     no_argument,       NULL, ARG_NO_ASK_PASSWORD     },
 359                 { "adjust-system-clock", no_argument,       NULL, ARG_ADJUST_SYSTEM_CLOCK },
 360                 {}
 361         };
 362
 363         int c;
 364
 365         assert(argc >= 0);
 366         assert(argv);
 367
 368         while ((c = getopt_long(argc, argv, "hH:M:", options, NULL)) >= 0)
 369
 370                 switch (c) {
 371
 372                 case 'h':
 373                         help();
 374                         return 0;
 375
 376                 case ARG_VERSION:
 377                         return version();
 378
 379                 case 'H':
 380                         arg_transport = BUS_TRANSPORT_REMOTE;
 381                         arg_host = optarg;
 382                         break;
 383
 384                 case 'M':
 385                         arg_transport = BUS_TRANSPORT_MACHINE;
 386                         arg_host = optarg;
 387                         break;
 388
 389                 case ARG_NO_ASK_PASSWORD:
 390                         arg_ask_password = false;
 391                         break;
 392
 393                 case ARG_ADJUST_SYSTEM_CLOCK:
 394                         arg_adjust_system_clock = true;
 395                         break;
 396
 397                 case ARG_NO_PAGER:
 398                         arg_no_pager = true;
 399                         break;
 400
 401                 case '?':
 402                         return -EINVAL;
 403
 404                 default:
 405                         assert_not_reached("Unhandled option");
 406                 }
 407
 408         return 1;
 409 }
 410
 411 static int timedatectl_main(sd_bus *bus, int argc, char *argv[]) {
 412
 413         static const struct {
 414                 const char* verb;
 415                 const enum {
 416                         MORE,
 417                         LESS,
 418                         EQUAL
 419                 } argc_cmp;
 420                 const int argc;
 421                 int (* const dispatch)(sd_bus *bus, char **args, unsigned n);
 422         } verbs[] = {
 423                 { "status",                LESS,   1, show_status      },
 424                 { "set-time",              EQUAL,  2, set_time         },
 425                 { "set-timezone",          EQUAL,  2, set_timezone     },
 426                 { "list-timezones",        EQUAL,  1, list_timezones   },
 427                 { "set-local-rtc",         EQUAL,  2, set_local_rtc    },
 428                 { "set-ntp",               EQUAL,  2, set_ntp,         },
 429         };
 430
 431         int left;
 432         unsigned i;
 433
 434         assert(argc >= 0);
 435         assert(argv);
 436
 437         left = argc - optind;
 438
 439         if (left <= 0)
 440                 /* Special rule: no arguments means "status" */
 441                 i = 0;
 442         else {
 443                 if (streq(argv[optind], "help")) {
 444                         help();
 445                         return 0;
 446                 }
 447
 448                 for (i = 0; i < ELEMENTSOF(verbs); i++)
 449                         if (streq(argv[optind], verbs[i].verb))
 450                                 break;
 451
 452                 if (i >= ELEMENTSOF(verbs)) {
 453                         log_error("Unknown operation %s", argv[optind]);
 454                         return -EINVAL;
 455                 }
 456         }
 457
 458         switch (verbs[i].argc_cmp) {
 459
 460         case EQUAL:
 461                 if (left != verbs[i].argc) {
 462                         log_error("Invalid number of arguments.");
 463                         return -EINVAL;
 464                 }
 465
 466                 break;
 467
 468         case MORE:
 469                 if (left < verbs[i].argc) {
 470                         log_error("Too few arguments.");
 471                         return -EINVAL;
 472                 }
 473
 474                 break;
 475
 476         case LESS:
 477                 if (left > verbs[i].argc) {
 478                         log_error("Too many arguments.");
 479                         return -EINVAL;
 480                 }
 481
 482                 break;
 483
 484         default:
 485                 assert_not_reached("Unknown comparison operator.");
 486         }
 487
 488         return verbs[i].dispatch(bus, argv + optind, left);
 489 }
 490
 491 int main(int argc, char *argv[]) {
 492         _cleanup_bus_flush_close_unref_ sd_bus *bus = NULL;
 493         int r;
 494
 495         setlocale(LC_ALL, "");
 496         log_parse_environment();
 497         log_open();
 498
 499         r = parse_argv(argc, argv);
 500         if (r <= 0)
 501                 goto finish;
 502
 503         r = bus_connect_transport(arg_transport, arg_host, false, &bus);
 504         if (r < 0) {
 505                 log_error_errno(r, "Failed to create bus connection: %m");
 506                 goto finish;
 507         }
 508
 509         r = timedatectl_main(bus, argc, argv);
 510
 511 finish:
 512         pager_close();
 513
 514         return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
 515 }