conf.c

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2010 Nedko Arnaudov <nedko@arnaudov.name>
   6  *
   7  **************************************************************************
   8  * This file contains implementation of the settings storage
   9  **************************************************************************
  10  *
  11  * LADI Session Handler is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * LADI Session Handler is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  23  * or write to the Free Software Foundation, Inc.,
  24  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26
  27 #include "common.h"
  28
  29 #include <unistd.h>
  30 #include <signal.h>
  31 #include <sys/types.h>
  32 #include <sys/stat.h>
  33 #include <fcntl.h>
  34 #include <errno.h>
  35
  36 #include "dbus/helpers.h"
  37 #include "dbus/error.h"
  38 #include "dbus_constants.h"
  39 #include "common/catdup.h"
  40 #include "common/dirhelpers.h"
  41
  42 #define STORAGE_BASE_DIR "/.ladish/conf/"
  43
  44 extern const struct dbus_interface_descriptor g_interface;
  45
  46 static const char * g_dbus_unique_name;
  47 static dbus_object_path g_object;
  48 static bool g_quit;
  49
  50 struct pair
  51 {
  52   struct list_head siblings;
  53   uint64_t version;
  54   char * key;
  55   char * value;
  56   bool stored;
  57 };
  58
  59 struct list_head g_pairs;
  60
  61 static bool connect_dbus(void)
  62 {
  63   int ret;
  64
  65   dbus_error_init(&g_dbus_error);
  66
  67   g_dbus_connection = dbus_bus_get(DBUS_BUS_SESSION, &g_dbus_error);
  68   if (dbus_error_is_set(&g_dbus_error))
  69   {
  70     log_error("Failed to get bus: %s", g_dbus_error.message);
  71     dbus_error_free(&g_dbus_error);
  72     goto fail;
  73   }
  74
  75   g_dbus_unique_name = dbus_bus_get_unique_name(g_dbus_connection);
  76   if (g_dbus_unique_name == NULL)
  77   {
  78     log_error("Failed to read unique bus name");
  79     goto unref_connection;
  80   }
  81
  82   log_info("Connected to local session bus, unique name is \"%s\"", g_dbus_unique_name);
  83
  84   ret = dbus_bus_request_name(g_dbus_connection, CONF_SERVICE_NAME, DBUS_NAME_FLAG_DO_NOT_QUEUE, &g_dbus_error);
  85   if (ret == -1)
  86   {
  87     log_error("Failed to acquire bus name: %s", g_dbus_error.message);
  88     dbus_error_free(&g_dbus_error);
  89     goto unref_connection;
  90   }
  91
  92   if (ret == DBUS_REQUEST_NAME_REPLY_EXISTS)
  93   {
  94     log_error("Requested connection name already exists");
  95     goto unref_connection;
  96   }
  97
  98   g_object = dbus_object_path_new(CONF_OBJECT_PATH, &g_interface, NULL, NULL);
  99   if (g_object == NULL)
 100   {
 101     goto unref_connection;
 102   }
 103
 104   if (!dbus_object_path_register(g_dbus_connection, g_object))
 105   {
 106     goto destroy_control_object;
 107   }
 108
 109   return true;
 110
 111 destroy_control_object:
 112   dbus_object_path_destroy(g_dbus_connection, g_object);
 113 unref_connection:
 114   dbus_connection_unref(g_dbus_connection);
 115
 116 fail:
 117   return false;
 118 }
 119
 120 static void disconnect_dbus(void)
 121 {
 122   dbus_object_path_destroy(g_dbus_connection, g_object);
 123   dbus_connection_unref(g_dbus_connection);
 124 }
 125
 126 void term_signal_handler(int signum)
 127 {
 128   log_info("Caught signal %d (%s), terminating", signum, strsignal(signum));
 129   g_quit = true;
 130 }
 131
 132 bool install_term_signal_handler(int signum, bool ignore_if_already_ignored)
 133 {
 134   sig_t sigh;
 135
 136   sigh = signal(signum, term_signal_handler);
 137   if (sigh == SIG_ERR)
 138   {
 139     log_error("signal() failed to install handler function for signal %d.", signum);
 140     return false;
 141   }
 142
 143   if (sigh == SIG_IGN && ignore_if_already_ignored)
 144   {
 145     signal(SIGTERM, SIG_IGN);
 146   }
 147
 148   return true;
 149 }
 150
 151 int main(int argc, char ** argv)
 152 {
 153   int ret;
 154
 155   if (getenv("HOME") == NULL)
 156   {
 157     log_error("Environment variable HOME not set");
 158     return 1;
 159   }
 160
 161   INIT_LIST_HEAD(&g_pairs);
 162
 163   install_term_signal_handler(SIGTERM, false);
 164   install_term_signal_handler(SIGINT, true);
 165
 166   if (!connect_dbus())
 167   {
 168     log_error("Failed to connect to D-Bus");
 169     return 1;
 170   }
 171
 172   while (!g_quit)
 173   {
 174     dbus_connection_read_write_dispatch(g_dbus_connection, 50);
 175   }
 176
 177   ret = 0;
 178
 179   disconnect_dbus();
 180   return 0;
 181 }
 182
 183 static struct pair * create_pair(const char * key, const char * value)
 184 {
 185   struct pair * pair_ptr;
 186
 187   pair_ptr = malloc(sizeof(struct pair));
 188   if (pair_ptr == NULL)
 189   {
 190     log_error("malloc() failed to allocate memory for pair struct");
 191     return NULL;
 192   }
 193
 194   pair_ptr->key = strdup(key);
 195   if (pair_ptr->key == NULL)
 196   {
 197     log_error("strdup(\"%s\") failed for key", key);
 198     free(pair_ptr);
 199     return NULL;
 200   }
 201
 202   if (value != NULL)
 203   {
 204     pair_ptr->value = strdup(value);
 205     if (pair_ptr->value == NULL)
 206     {
 207       log_error("strdup(\"%s\") failed for value", value);
 208       free(pair_ptr->key);
 209       free(pair_ptr);
 210       return NULL;
 211     }
 212   }
 213   else
 214   {
 215     /* Caller will fill this shortly */
 216     pair_ptr->value = NULL;
 217   }
 218
 219   pair_ptr->version = 1;
 220   pair_ptr->stored = false;
 221
 222   list_add_tail(&pair_ptr->siblings, &g_pairs);
 223
 224   return pair_ptr;
 225 }
 226
 227 static bool store_pair(struct pair * pair_ptr)
 228 {
 229   char * dirpath;
 230   char * filepath;
 231   int fd;
 232   size_t len;
 233   ssize_t written;
 234
 235   dirpath = catdupv(getenv("HOME"), STORAGE_BASE_DIR, pair_ptr->key, NULL);
 236   if (dirpath == NULL)
 237   {
 238     return false;
 239   }
 240
 241   if (!ensure_dir_exist(dirpath, 0700))
 242   {
 243     free(dirpath);
 244     return false;
 245   }
 246
 247   filepath = catdup(dirpath, "/value");
 248   free(dirpath);
 249   if (filepath == NULL)
 250   {
 251     return false;
 252   }
 253
 254   fd = creat(filepath, 0700);
 255   if (fd == -1)
 256   {
 257     log_error("Failed to create \"%s\": %d (%s)", filepath, errno, strerror(errno));
 258     free(filepath);
 259     return false;
 260   }
 261
 262   len = strlen(pair_ptr->value);
 263
 264   written = write(fd, pair_ptr->value, len);
 265   if (written < 0)
 266   {
 267     log_error("Failed to write() to \"%s\": %d (%s)", filepath, errno, strerror(errno));
 268     free(filepath);
 269     return false;
 270   }
 271
 272   if ((size_t)written != len)
 273   {
 274     log_error("write() to \"%s\" returned %zd instead of %zu", filepath, written, len);
 275     free(filepath);
 276     return false;
 277   }
 278
 279   close(fd);
 280   free(filepath);
 281
 282   pair_ptr->stored = true;
 283
 284   return true;
 285 }
 286
 287 static struct pair * load_pair(const char * key)
 288 {
 289   struct pair * pair_ptr;
 290   char * path;
 291   struct stat st;
 292   int fd;
 293   char * buffer;
 294   ssize_t bytes_read;
 295
 296   path = catdupv(getenv("HOME"), STORAGE_BASE_DIR, key, "/value", NULL);
 297   if (path == NULL)
 298   {
 299     return false;
 300   }
 301
 302   if (stat(path, &st) != 0)
 303   {
 304     log_error("Failed to stat \"%s\": %d (%s)", path, errno, strerror(errno));
 305     free(path);
 306     return false;
 307   }
 308
 309   if (!S_ISREG(st.st_mode))
 310   {
 311     log_error("\"%s\" is not a regular file.", path);
 312     free(path);
 313     return false;
 314   }
 315
 316   fd = open(path, O_RDONLY);
 317   if (fd == -1)
 318   {
 319     log_error("Failed to open \"%s\": %d (%s)", path, errno, strerror(errno));
 320     free(path);
 321     return false;
 322   }
 323
 324   buffer = malloc((size_t)st.st_size + 1);
 325   if (buffer == NULL)
 326   {
 327     log_error("malloc() failed to allocate %zu bytes of memory for value", (size_t)st.st_size + 1);
 328     close(fd);
 329     free(path);
 330     return false;
 331   }
 332
 333   bytes_read = read(fd, buffer, st.st_size);
 334   if (bytes_read < 0)
 335   {
 336     log_error("Failed to read() from \"%s\": %d (%s)", path, errno, strerror(errno));
 337     free(buffer);
 338     close(fd);
 339     free(path);
 340     return false;
 341   }
 342
 343   if (bytes_read != st.st_size)
 344   {
 345     log_error("read() from \"%s\" returned %zd instead of %llu", path, bytes_read, (unsigned long long)st.st_size);
 346     free(buffer);
 347     close(fd);
 348     free(path);
 349     return false;
 350   }
 351
 352   buffer[st.st_size] = 0;
 353
 354   pair_ptr = create_pair(key, NULL);
 355   if (pair_ptr == NULL)
 356   {
 357     free(buffer);
 358     close(fd);
 359     free(path);
 360     return false;
 361   }
 362
 363   pair_ptr->value = buffer;
 364
 365   close(fd);
 366   free(path);
 367
 368   return pair_ptr;
 369 }
 370
 371 static struct pair * find_pair(const char * key)
 372 {
 373   struct list_head * node_ptr;
 374   struct pair * pair_ptr;
 375
 376   list_for_each(node_ptr, &g_pairs)
 377   {
 378     pair_ptr = list_entry(node_ptr, struct pair, siblings);
 379     if (strcmp(pair_ptr->key, key) == 0)
 380     {
 381       return pair_ptr;
 382     }
 383   }
 384
 385   return NULL;
 386 }
 387
 388 /***************************************************************************/
 389 /* D-Bus interface implementation */
 390
 391 static void conf_set(struct dbus_method_call * call_ptr)
 392 {
 393   const char * key;
 394   const char * value;
 395   struct pair * pair_ptr;
 396   char * buffer;
 397   bool store;
 398
 399   if (!dbus_message_get_args(
 400         call_ptr->message,
 401         &g_dbus_error,
 402         DBUS_TYPE_STRING, &key,
 403         DBUS_TYPE_STRING, &value,
 404         DBUS_TYPE_INVALID))
 405   {
 406     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_INVALID_ARGS, "Invalid arguments to method \"%s\": %s",  call_ptr->method_name, g_dbus_error.message);
 407     dbus_error_free(&g_dbus_error);
 408     return;
 409   }
 410
 411   log_info("set '%s' <- '%s'", key, value);
 412
 413   pair_ptr = find_pair(key);
 414   if (pair_ptr == NULL)
 415   {
 416     pair_ptr = create_pair(key, value);
 417     if (pair_ptr == NULL)
 418     {
 419       lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Memory allocation failed");
 420       return;
 421     }
 422
 423     store = true;
 424   }
 425   else
 426   {
 427     store = strcmp(pair_ptr->value, value) != 0;
 428     if (store)
 429     {
 430       buffer = strdup(value);
 431       if (buffer == NULL)
 432       {
 433         lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Memory allocation failed. strdup(\"%s\") failed for value", value);
 434         return;
 435       }
 436       free(pair_ptr->value);
 437       pair_ptr->value = buffer;
 438       pair_ptr->version++;
 439       pair_ptr->stored = false; /* mark that new value was not stored on disk yet */
 440
 441       dbus_signal_emit(
 442         g_dbus_connection,
 443         CONF_OBJECT_PATH,
 444         CONF_IFACE,
 445         "changed",
 446         "sst",
 447         &pair_ptr->key,
 448         &pair_ptr->value,
 449         &pair_ptr->version);
 450     }
 451     else if (!pair_ptr->stored) /* if store to disk failed last time, retry */
 452     {
 453       store = true;
 454     }
 455   }
 456
 457   if (store)
 458   {
 459     if (!store_pair(pair_ptr))
 460     {
 461       lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Storing the value of key '%s' to disk failed", pair_ptr->key);
 462       return;
 463     }
 464   }
 465
 466   method_return_new_single(call_ptr, DBUS_TYPE_UINT64, &pair_ptr->version);
 467 }
 468
 469 static void conf_get(struct dbus_method_call * call_ptr)
 470 {
 471   const char * key;
 472   struct pair * pair_ptr;
 473
 474   if (!dbus_message_get_args(
 475         call_ptr->message,
 476         &g_dbus_error,
 477         DBUS_TYPE_STRING, &key,
 478         DBUS_TYPE_INVALID))
 479   {
 480     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_INVALID_ARGS, "Invalid arguments to method \"%s\": %s",  call_ptr->method_name, g_dbus_error.message);
 481     dbus_error_free(&g_dbus_error);
 482     return;
 483   }
 484
 485   pair_ptr = find_pair(key);
 486   if (pair_ptr == NULL)
 487   {
 488     pair_ptr = load_pair(key);
 489     if (pair_ptr == NULL)
 490     {
 491       lash_dbus_error(call_ptr, LASH_DBUS_ERROR_KEY_NOT_FOUND, "Key '%s' not found", key);
 492       return;
 493     }
 494   }
 495
 496   log_info("get '%s' -> '%s'", key, pair_ptr->value);
 497
 498   method_return_new_valist(
 499     call_ptr,
 500     DBUS_TYPE_STRING, &pair_ptr->value,
 501     DBUS_TYPE_UINT64, &pair_ptr->version,
 502     DBUS_TYPE_INVALID);
 503 }
 504
 505 static void conf_exit(struct dbus_method_call * call_ptr)
 506 {
 507   log_info("Exit command received through D-Bus");
 508   g_quit = true;
 509   method_return_new_void(call_ptr);
 510 }
 511
 512 METHOD_ARGS_BEGIN(set, "Set conf value")
 513   METHOD_ARG_DESCRIBE_IN("key", DBUS_TYPE_STRING_AS_STRING, "")
 514   METHOD_ARG_DESCRIBE_IN("value", DBUS_TYPE_STRING_AS_STRING, "")
 515   METHOD_ARG_DESCRIBE_OUT("version", DBUS_TYPE_UINT64_AS_STRING, "")
 516 METHOD_ARGS_END
 517
 518 METHOD_ARGS_BEGIN(get, "Get conf value")
 519   METHOD_ARG_DESCRIBE_IN("key", DBUS_TYPE_STRING_AS_STRING, "")
 520   METHOD_ARG_DESCRIBE_OUT("value", DBUS_TYPE_STRING_AS_STRING, "")
 521   METHOD_ARG_DESCRIBE_OUT("version", DBUS_TYPE_UINT64_AS_STRING, "")
 522 METHOD_ARGS_END
 523
 524 METHOD_ARGS_BEGIN(exit, "Tell conf D-Bus service to exit")
 525 METHOD_ARGS_END
 526
 527 METHODS_BEGIN
 528   METHOD_DESCRIBE(set, conf_set)
 529   METHOD_DESCRIBE(get, conf_get)
 530   METHOD_DESCRIBE(exit, conf_exit)
 531 METHODS_END
 532
 533 SIGNAL_ARGS_BEGIN(changed, "")
 534   SIGNAL_ARG_DESCRIBE("key", DBUS_TYPE_STRING_AS_STRING, "")
 535   SIGNAL_ARG_DESCRIBE("value", DBUS_TYPE_STRING_AS_STRING, "")
 536   SIGNAL_ARG_DESCRIBE("version", DBUS_TYPE_UINT64_AS_STRING, "")
 537 SIGNAL_ARGS_END
 538
 539 SIGNALS_BEGIN
 540   SIGNAL_DESCRIBE(changed)
 541 SIGNALS_END
 542
 543 INTERFACE_BEGIN(g_interface, CONF_IFACE)
 544   INTERFACE_DEFAULT_HANDLER
 545   INTERFACE_EXPOSE_METHODS
 546   INTERFACE_EXPOSE_SIGNALS
 547 INTERFACE_END