src/x-server-local.c

   1 /*
   2  * Copyright (C) 2010-2011 Robert Ancell.
   3  * Author: Robert Ancell <robert.ancell@canonical.com>
   4  *
   5  * This program is free software: you can redistribute it and/or modify it under
   6  * the terms of the GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option) any later
   8  * version. See http://www.gnu.org/copyleft/gpl.html the full text of the
   9  * license.
  10  */
  11
  12 #include <config.h>
  13 #include <string.h>
  14 #include <fcntl.h>
  15 #include <unistd.h>
  16 #include <sys/stat.h>
  17 #include <errno.h>
  18 #include <glib/gstdio.h>
  19 #include <stdlib.h>
  20
  21 #include "x-server-local.h"
  22 #include "configuration.h"
  23 #include "process.h"
  24 #include "vt.h"
  25
  26 struct XServerLocalPrivate
  27 {
  28     /* X server process */
  29     Process *x_server_process;
  30
  31     /* Command to run the X server */
  32     gchar *command;
  33
  34     /* Config file to use */
  35     gchar *config_file;
  36
  37     /* Server layout to use */
  38     gchar *layout;
  39
  40     /* Value for -seat argument */
  41     gchar *xdg_seat;
  42
  43     /* TRUE if should share VT with other X server */
  44     gboolean sharevts;
  45
  46     /* TRUE if TCP/IP connections are allowed */
  47     gboolean allow_tcp;
  48
  49     /* Authority file */
  50     gchar *authority_file;
  51
  52     /* XDMCP server to connect to */
  53     gchar *xdmcp_server;
  54
  55     /* XDMCP port to connect to */
  56     guint xdmcp_port;
  57
  58     /* XDMCP key to use */
  59     gchar *xdmcp_key;
  60
  61     /* ID to report to Mir */
  62     gchar *mir_id;
  63
  64     /* Filename of socket Mir is listening on */
  65     gchar *mir_socket;
  66
  67     /* TRUE when received ready signal */
  68     gboolean got_signal;
  69
  70     /* VT to run on */
  71     gint vt;
  72     gboolean have_vt_ref;
  73
  74     /* Background to set */
  75     gchar *background;
  76 };
  77
  78 G_DEFINE_TYPE (XServerLocal, x_server_local, X_SERVER_TYPE);
  79
  80 static GList *display_numbers = NULL;
  81
  82 static gboolean
  83 display_number_in_use (guint display_number)
  84 {
  85     GList *link;
  86     gchar *path;
  87     gboolean in_use;
  88     gchar *data;
  89
  90     /* See if we know we are managing a server with that number */
  91     for (link = display_numbers; link; link = link->next)
  92     {
  93         guint number = GPOINTER_TO_UINT (link->data);
  94         if (number == display_number)
  95             return TRUE;
  96     }
  97
  98     /* See if an X server that we don't know of has a lock on that number */
  99     path = g_strdup_printf ("/tmp/.X%d-lock", display_number);
 100     in_use = g_file_test (path, G_FILE_TEST_EXISTS);
 101
 102     /* See if that lock file is valid, ignore it if the contents are invalid or the process doesn't exist */
 103     if (in_use && g_file_get_contents (path, &data, NULL, NULL))
 104     {
 105         int pid;
 106
 107         pid = atoi (g_strstrip (data));
 108         g_free (data);
 109
 110         errno = 0;
 111         if (pid < 0 || (kill (pid, 0) < 0 && errno == ESRCH))
 112             in_use = FALSE;
 113     }
 114
 115     g_free (path);
 116
 117     return in_use;
 118 }
 119
 120 guint
 121 x_server_local_get_unused_display_number (void)
 122 {
 123     guint number;
 124
 125     number = config_get_integer (config_get_instance (), "LightDM", "minimum-display-number");
 126     while (display_number_in_use (number))
 127         number++;
 128
 129     display_numbers = g_list_append (display_numbers, GUINT_TO_POINTER (number));
 130
 131     return number;
 132 }
 133
 134 void
 135 x_server_local_release_display_number (guint display_number)
 136 {
 137     GList *link;
 138     for (link = display_numbers; link; link = link->next)
 139     {
 140         guint number = GPOINTER_TO_UINT (link->data);
 141         if (number == display_number)
 142         {
 143             display_numbers = g_list_delete_link (display_numbers, link);
 144             return;
 145         }
 146     }
 147 }
 148
 149 XServerLocal *
 150 x_server_local_new (void)
 151 {
 152     XServerLocal *self;
 153     gchar hostname[1024], *number, *name;
 154     XAuthority *cookie;
 155
 156     self = g_object_new (X_SERVER_LOCAL_TYPE, NULL);
 157
 158     x_server_set_display_number (X_SERVER (self), x_server_local_get_unused_display_number ());
 159
 160     gethostname (hostname, 1024);
 161     number = g_strdup_printf ("%d", x_server_get_display_number (X_SERVER (self)));
 162     cookie = x_authority_new_cookie (XAUTH_FAMILY_LOCAL, (guint8*) hostname, strlen (hostname), number);
 163     x_server_set_authority (X_SERVER (self), cookie);
 164     g_free (number);
 165     g_object_unref (cookie);
 166
 167     name = g_strdup_printf ("x-%d", x_server_get_display_number (X_SERVER (self)));
 168     display_server_set_name (DISPLAY_SERVER (self), name);
 169     g_free (name);
 170
 171     return self;
 172 }
 173
 174 void
 175 x_server_local_set_command (XServerLocal *server, const gchar *command)
 176 {
 177     g_return_if_fail (server != NULL);
 178     g_free (server->priv->command);
 179     server->priv->command = g_strdup (command);
 180 }
 181
 182 void
 183 x_server_local_set_vt (XServerLocal *server, gint vt)
 184 {
 185     g_return_if_fail (server != NULL);
 186     if (server->priv->have_vt_ref)
 187         vt_unref (server->priv->vt);
 188     server->priv->have_vt_ref = FALSE;
 189     server->priv->vt = vt;
 190     if (vt > 0)
 191     {
 192         vt_ref (vt);
 193         server->priv->have_vt_ref = TRUE;
 194     }
 195 }
 196
 197 void
 198 x_server_local_set_config (XServerLocal *server, const gchar *path)
 199 {
 200     g_return_if_fail (server != NULL);
 201     g_free (server->priv->config_file);
 202     server->priv->config_file = g_strdup (path);
 203 }
 204
 205 void
 206 x_server_local_set_layout (XServerLocal *server, const gchar *layout)
 207 {
 208     g_return_if_fail (server != NULL);
 209     g_free (server->priv->layout);
 210     server->priv->layout = g_strdup (layout);
 211 }
 212
 213 void
 214 x_server_local_set_xdg_seat (XServerLocal *server, const gchar *xdg_seat)
 215 {
 216     g_return_if_fail (server != NULL);
 217     g_free (server->priv->xdg_seat);
 218     server->priv->xdg_seat = g_strdup (xdg_seat);
 219 }
 220
 221 void
 222 x_server_local_set_sharevts (XServerLocal *server, gboolean sharevts)
 223 {
 224     g_return_if_fail (server != NULL);
 225     server->priv->sharevts = sharevts;
 226 }
 227
 228 void
 229 x_server_local_set_allow_tcp (XServerLocal *server, gboolean allow_tcp)
 230 {
 231     g_return_if_fail (server != NULL);
 232     server->priv->allow_tcp = allow_tcp;
 233 }
 234
 235 void
 236 x_server_local_set_xdmcp_server (XServerLocal *server, const gchar *hostname)
 237 {
 238     g_return_if_fail (server != NULL);
 239     g_free (server->priv->xdmcp_server);
 240     server->priv->xdmcp_server = g_strdup (hostname);
 241 }
 242
 243 const gchar *
 244 x_server_local_get_xdmcp_server (XServerLocal *server)
 245 {
 246     g_return_val_if_fail (server != NULL, 0);
 247     return server->priv->xdmcp_server;
 248 }
 249
 250 void
 251 x_server_local_set_xdmcp_port (XServerLocal *server, guint port)
 252 {
 253     g_return_if_fail (server != NULL);
 254     server->priv->xdmcp_port = port;
 255 }
 256
 257 guint
 258 x_server_local_get_xdmcp_port (XServerLocal *server)
 259 {
 260     g_return_val_if_fail (server != NULL, 0);
 261     return server->priv->xdmcp_port;
 262 }
 263
 264 void
 265 x_server_local_set_xdmcp_key (XServerLocal *server, const gchar *key)
 266 {
 267     g_return_if_fail (server != NULL);
 268     g_free (server->priv->xdmcp_key);
 269     server->priv->xdmcp_key = g_strdup (key);
 270     x_server_set_authority (X_SERVER (server), NULL);
 271 }
 272
 273 void
 274 x_server_local_set_background (XServerLocal *server, const gchar *background)
 275 {
 276     g_return_if_fail (server != NULL);
 277     g_free (server->priv->background);
 278     server->priv->background = g_strdup (background);
 279 }
 280
 281 void
 282 x_server_local_set_mir_id (XServerLocal *server, const gchar *id)
 283 {
 284     g_return_if_fail (server != NULL);
 285     g_free (server->priv->mir_id);
 286     server->priv->mir_id = g_strdup (id);
 287 }
 288
 289 const gchar *x_server_local_get_mir_id (XServerLocal *server)
 290 {
 291     g_return_val_if_fail (server != NULL, NULL);
 292     return server->priv->mir_id;
 293 }
 294
 295 void
 296 x_server_local_set_mir_socket (XServerLocal *server, const gchar *socket)
 297 {
 298     g_return_if_fail (server != NULL);
 299     g_free (server->priv->mir_socket);
 300     server->priv->mir_socket = g_strdup (socket);
 301 }
 302
 303 static gint
 304 x_server_local_get_vt (DisplayServer *server)
 305 {
 306     g_return_val_if_fail (server != NULL, 0);
 307     return X_SERVER_LOCAL (server)->priv->vt;
 308 }
 309
 310 const gchar *
 311 x_server_local_get_authority_file_path (XServerLocal *server)
 312 {
 313     g_return_val_if_fail (server != NULL, 0);
 314     return server->priv->authority_file;
 315 }
 316
 317 static gchar *
 318 get_absolute_command (const gchar *command)
 319 {
 320     gchar **tokens;
 321     gchar *absolute_binary, *absolute_command = NULL;
 322
 323     tokens = g_strsplit (command, " ", 2);
 324
 325     absolute_binary = g_find_program_in_path (tokens[0]);
 326     if (absolute_binary)
 327     {
 328         if (tokens[1])
 329             absolute_command = g_strjoin (" ", absolute_binary, tokens[1], NULL);
 330         else
 331             absolute_command = g_strdup (absolute_binary);
 332     }
 333     g_free (absolute_binary);
 334
 335     g_strfreev (tokens);
 336
 337     return absolute_command;
 338 }
 339
 340 static void
 341 run_cb (Process *process, gpointer user_data)
 342 {
 343     int fd;
 344
 345     /* Make input non-blocking */
 346     fd = open ("/dev/null", O_RDONLY);
 347     dup2 (fd, STDIN_FILENO);
 348     close (fd);
 349
 350     /* Set SIGUSR1 to ignore so the X server can indicate it when it is ready */
 351     signal (SIGUSR1, SIG_IGN);
 352 }
 353
 354 static void
 355 got_signal_cb (Process *process, int signum, XServerLocal *server)
 356 {
 357     if (signum == SIGUSR1 && !server->priv->got_signal)
 358     {
 359         server->priv->got_signal = TRUE;
 360         l_debug (server, "Got signal from X server :%d", x_server_get_display_number (X_SERVER (server)));
 361
 362         // FIXME: Check return value
 363         DISPLAY_SERVER_CLASS (x_server_local_parent_class)->start (DISPLAY_SERVER (server));
 364     }
 365 }
 366
 367 static void
 368 stopped_cb (Process *process, XServerLocal *server)
 369 {
 370     l_debug (server, "X server stopped");
 371
 372     /* Release VT and display number for re-use */
 373     if (server->priv->have_vt_ref)
 374     {
 375         vt_unref (server->priv->vt);
 376         server->priv->have_vt_ref = FALSE;
 377     }
 378     x_server_local_release_display_number (x_server_get_display_number (X_SERVER (server)));
 379
 380     if (x_server_get_authority (X_SERVER (server)) && server->priv->authority_file)
 381     {
 382         l_debug (server, "Removing X server authority %s", server->priv->authority_file);
 383
 384         g_unlink (server->priv->authority_file);
 385
 386         g_free (server->priv->authority_file);
 387         server->priv->authority_file = NULL;
 388     }
 389
 390     DISPLAY_SERVER_CLASS (x_server_local_parent_class)->stop (DISPLAY_SERVER (server));
 391 }
 392
 393 static void
 394 write_authority_file (XServerLocal *server)
 395 {
 396     XAuthority *authority;
 397     GError *error = NULL;
 398
 399     authority = x_server_get_authority (X_SERVER (server));
 400     if (!authority)
 401         return;
 402
 403     /* Get file to write to if have authority */
 404     if (!server->priv->authority_file)
 405     {
 406         gchar *run_dir, *dir;
 407
 408         run_dir = config_get_string (config_get_instance (), "LightDM", "run-directory");
 409         dir = g_build_filename (run_dir, "root", NULL);
 410         g_free (run_dir);
 411         if (g_mkdir_with_parents (dir, S_IRWXU) < 0)
 412             l_warning (server, "Failed to make authority directory %s: %s", dir, strerror (errno));
 413
 414         server->priv->authority_file = g_build_filename (dir, x_server_get_address (X_SERVER (server)), NULL);
 415         g_free (dir);
 416     }
 417
 418     l_debug (server, "Writing X server authority to %s", server->priv->authority_file);
 419
 420     x_authority_write (authority, XAUTH_WRITE_MODE_REPLACE, server->priv->authority_file, &error);
 421     if (error)
 422         l_warning (server, "Failed to write authority: %s", error->message);
 423     g_clear_error (&error);
 424 }
 425
 426 static gboolean
 427 x_server_local_start (DisplayServer *display_server)
 428 {
 429     XServerLocal *server = X_SERVER_LOCAL (display_server);
 430     gboolean result;
 431     gchar *filename, *dir, *log_file, *absolute_command;
 432     GString *command;
 433
 434     g_return_val_if_fail (server->priv->x_server_process == NULL, FALSE);
 435
 436     server->priv->got_signal = FALSE;
 437
 438     g_return_val_if_fail (server->priv->command != NULL, FALSE);
 439
 440     server->priv->x_server_process = process_new (run_cb, server);
 441     process_set_clear_environment (server->priv->x_server_process, TRUE);
 442     g_signal_connect (server->priv->x_server_process, PROCESS_SIGNAL_GOT_SIGNAL, G_CALLBACK (got_signal_cb), server);
 443     g_signal_connect (server->priv->x_server_process, PROCESS_SIGNAL_STOPPED, G_CALLBACK (stopped_cb), server);
 444
 445     /* Setup logging */
 446     filename = g_strdup_printf ("%s.log", display_server_get_name (display_server));
 447     dir = config_get_string (config_get_instance (), "LightDM", "log-directory");
 448     log_file = g_build_filename (dir, filename, NULL);
 449     process_set_log_file (server->priv->x_server_process, log_file, TRUE);
 450     l_debug (display_server, "Logging to %s", log_file);
 451     g_free (log_file);
 452     g_free (filename);
 453     g_free (dir);
 454
 455     absolute_command = get_absolute_command (server->priv->command);
 456     if (!absolute_command)
 457     {
 458         l_debug (display_server, "Can't launch X server %s, not found in path", server->priv->command);
 459         stopped_cb (server->priv->x_server_process, X_SERVER_LOCAL (server));
 460         return FALSE;
 461     }
 462     command = g_string_new (absolute_command);
 463     g_free (absolute_command);
 464
 465     g_string_append_printf (command, " :%d", x_server_get_display_number (X_SERVER (server)));
 466
 467     if (server->priv->config_file)
 468         g_string_append_printf (command, " -config %s", server->priv->config_file);
 469
 470     if (server->priv->layout)
 471         g_string_append_printf (command, " -layout %s", server->priv->layout);
 472
 473     if (server->priv->xdg_seat)
 474         g_string_append_printf (command, " -seat %s", server->priv->xdg_seat);
 475
 476     if (server->priv->sharevts)
 477         g_string_append (command, " -sharevts");
 478
 479     write_authority_file (server);
 480     if (server->priv->authority_file)
 481         g_string_append_printf (command, " -auth %s", server->priv->authority_file);
 482
 483     /* Setup for running inside Mir */
 484     if (server->priv->mir_id)
 485         g_string_append_printf (command, " -mir %s", server->priv->mir_id);
 486
 487     if (server->priv->mir_socket)
 488         g_string_append_printf (command, " -mirSocket %s", server->priv->mir_socket);
 489
 490     /* Connect to a remote server using XDMCP */
 491     if (server->priv->xdmcp_server != NULL)
 492     {
 493         if (server->priv->xdmcp_port != 0)
 494             g_string_append_printf (command, " -port %d", server->priv->xdmcp_port);
 495         g_string_append_printf (command, " -query %s", server->priv->xdmcp_server);
 496         if (server->priv->xdmcp_key)
 497             g_string_append_printf (command, " -cookie %s", server->priv->xdmcp_key);
 498     }
 499     else if (!server->priv->allow_tcp)
 500         g_string_append (command, " -nolisten tcp");
 501
 502     if (server->priv->vt >= 0)
 503         g_string_append_printf (command, " vt%d -novtswitch", server->priv->vt);
 504
 505     if (server->priv->background)
 506         g_string_append_printf (command, " -background %s", server->priv->background);
 507
 508     process_set_command (server->priv->x_server_process, command->str);
 509     g_string_free (command, TRUE);
 510
 511     l_debug (display_server, "Launching X Server");
 512
 513     /* If running inside another display then pass through those variables */
 514     if (g_getenv ("DISPLAY"))
 515     {
 516         process_set_env (server->priv->x_server_process, "DISPLAY", g_getenv ("DISPLAY"));
 517         if (g_getenv ("XAUTHORITY"))
 518             process_set_env (server->priv->x_server_process, "XAUTHORITY", g_getenv ("XAUTHORITY"));
 519         else
 520         {
 521             gchar *path;
 522             path = g_build_filename (g_get_home_dir (), ".Xauthority", NULL);
 523             process_set_env (server->priv->x_server_process, "XAUTHORITY", path);
 524             g_free (path);
 525         }
 526     }
 527
 528     /* Variable required for regression tests */
 529     if (g_getenv ("LIGHTDM_TEST_ROOT"))
 530     {
 531         process_set_env (server->priv->x_server_process, "LIGHTDM_TEST_ROOT", g_getenv ("LIGHTDM_TEST_ROOT"));
 532         process_set_env (server->priv->x_server_process, "LD_PRELOAD", g_getenv ("LD_PRELOAD"));
 533         process_set_env (server->priv->x_server_process, "LD_LIBRARY_PATH", g_getenv ("LD_LIBRARY_PATH"));
 534     }
 535
 536     result = process_start (server->priv->x_server_process, FALSE);
 537
 538     if (result)
 539         l_debug (display_server, "Waiting for ready signal from X server :%d", x_server_get_display_number (X_SERVER (server)));
 540
 541     if (!result)
 542         stopped_cb (server->priv->x_server_process, X_SERVER_LOCAL (server));
 543
 544     return result;
 545 }
 546
 547 static void
 548 x_server_local_stop (DisplayServer *server)
 549 {
 550     process_stop (X_SERVER_LOCAL (server)->priv->x_server_process);
 551 }
 552
 553 static void
 554 x_server_local_init (XServerLocal *server)
 555 {
 556     server->priv = G_TYPE_INSTANCE_GET_PRIVATE (server, X_SERVER_LOCAL_TYPE, XServerLocalPrivate);
 557     server->priv->vt = -1;
 558     server->priv->command = g_strdup ("X");
 559 }
 560
 561 static void
 562 x_server_local_finalize (GObject *object)
 563 {
 564     XServerLocal *self;
 565
 566     self = X_SERVER_LOCAL (object);
 567
 568     if (self->priv->x_server_process)
 569     {
 570         g_signal_handlers_disconnect_matched (self->priv->x_server_process, G_SIGNAL_MATCH_DATA, 0, 0, NULL, NULL, self);
 571         g_object_unref (self->priv->x_server_process);
 572     }
 573     g_free (self->priv->command);
 574     g_free (self->priv->config_file);
 575     g_free (self->priv->layout);
 576     g_free (self->priv->xdg_seat);
 577     g_free (self->priv->xdmcp_server);
 578     g_free (self->priv->xdmcp_key);
 579     g_free (self->priv->mir_id);
 580     g_free (self->priv->mir_socket);
 581     g_free (self->priv->authority_file);
 582     if (self->priv->have_vt_ref)
 583         vt_unref (self->priv->vt);
 584     g_free (self->priv->background);
 585
 586     G_OBJECT_CLASS (x_server_local_parent_class)->finalize (object);
 587 }
 588
 589 static void
 590 x_server_local_class_init (XServerLocalClass *klass)
 591 {
 592     GObjectClass *object_class = G_OBJECT_CLASS (klass);
 593     DisplayServerClass *display_server_class = DISPLAY_SERVER_CLASS (klass);
 594
 595     display_server_class->get_vt = x_server_local_get_vt;
 596     display_server_class->start = x_server_local_start;
 597     display_server_class->stop = x_server_local_stop;
 598     object_class->finalize = x_server_local_finalize;
 599
 600     g_type_class_add_private (klass, sizeof (XServerLocalPrivate));
 601 }