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