git.notmuchmail.org Git - notmuch/blob - notmuch-config.c

   1 /* notmuch - Not much of an email program, (just index and search)
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include "notmuch-client.h"
  22
  23 #include <pwd.h>
  24 #include <netdb.h>
  25
  26 static const char toplevel_config_comment[] =
  27     " .notmuch-config - Configuration file for the notmuch mail system\n"
  28     "\n"
  29     " For more information about notmuch, see http://notmuchmail.org";
  30
  31 static const char database_config_comment[] =
  32     " Database configuration\n"
  33     "\n"
  34     " The only value supported here is 'path' which should be the top-level\n"
  35     " directory where your mail currently exists and to where mail will be\n"
  36     " delivered in the future. Files should be individual email messages.\n"
  37     " Notmuch will store its database within a sub-directory of the path\n"
  38     " configured here named \".notmuch\".\n";
  39
  40 static const char user_config_comment[] =
  41     " User configuration\n"
  42     "\n"
  43     " Here is where you can let notmuch know how you would like to be\n"
  44     " addressed. Valid settings are\n"
  45     "\n"
  46     "\tname             Your full name.\n"
  47     "\tprimary_email    Your primary email address.\n"
  48     "\tother_email      A list (separated by ';') of other email addresses\n"
  49     "\t         at which you receive email.\n"
  50     "\n"
  51     " Notmuch will use the various email addresses configured here when\n"
  52     " formatting replies. It will avoid including your own addresses in the\n"
  53     " recipient list of replies, and will set the From address based on the\n"
  54     " address to which the original email was addressed.\n";
  55
  56 struct _notmuch_config {
  57     char *filename;
  58     GKeyFile *key_file;
  59
  60     char *database_path;
  61     char *user_name;
  62     char *user_primary_email;
  63     char **user_other_email;
  64     size_t user_other_email_length;
  65 };
  66
  67 static int
  68 notmuch_config_destructor (notmuch_config_t *config)
  69 {
  70     if (config->key_file)
  71         g_key_file_free (config->key_file);
  72
  73     return 0;
  74 }
  75
  76 static char *
  77 get_name_from_passwd_file (void *ctx)
  78 {
  79     long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
  80     char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
  81     struct passwd passwd, *ignored;
  82     char *name;
  83     int e;
  84
  85     if (pw_buf_size == -1) pw_buf_size = 64;
  86
  87     while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
  88                             pw_buf_size, &ignored)) == ERANGE) {
  89         pw_buf_size = pw_buf_size * 2;
  90         pw_buf = talloc_zero_size(ctx, pw_buf_size);
  91     }
  92
  93     if (e == 0) {
  94         char *comma = strchr (passwd.pw_gecos, ',');
  95         if (comma)
  96             name = talloc_strndup (ctx, passwd.pw_gecos,
  97                                    comma - passwd.pw_gecos);
  98         else
  99             name = talloc_strdup (ctx, passwd.pw_gecos);
 100     } else {
 101         name = talloc_strdup (ctx, "");
 102     }
 103
 104     talloc_free (pw_buf);
 105
 106     return name;
 107 }
 108
 109 static char *
 110 get_username_from_passwd_file (void *ctx)
 111 {
 112     long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
 113     char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
 114     struct passwd passwd, *ignored;
 115     char *name;
 116     int e;
 117
 118     if (pw_buf_size == -1) pw_buf_size = 64;
 119     while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
 120                             pw_buf_size, &ignored)) == ERANGE) {
 121         pw_buf_size = pw_buf_size * 2;
 122         pw_buf = talloc_zero_size(ctx, pw_buf_size);
 123     }
 124
 125     if (e == 0)
 126         name = talloc_strdup (ctx, passwd.pw_name);
 127     else
 128         name = talloc_strdup (ctx, "");
 129
 130     talloc_free (pw_buf);
 131
 132     return name;
 133 }
 134
 135 /* Open the named notmuch configuration file. A filename of NULL will
 136  * be interpreted as the default configuration file
 137  * ($HOME/.notmuch-config).
 138  *
 139  * If any error occurs, (out of memory, or a permission-denied error,
 140  * etc.), this function will print a message to stderr and return
 141  * NULL.
 142  *
 143  * Note: It is *not* an error if the specified configuration file does
 144  * not exist. In this case, a default configuration will be created
 145  * and returned. Subsequently calling notmuch_config_save will cause
 146  * the configuration to be written to the filename specified at the
 147  * time of notmuch_config_open.
 148  *
 149  * The default configuration settings are determined as follows:
 150  *
 151  *      database_path:          $HOME/mail
 152  *
 153  *      user_name:              From /etc/passwd
 154  *
 155  *      user_primary_mail:      $EMAIL variable if set, otherwise
 156  *                              constructed from the username and
 157  *                              hostname of the current machine.
 158  *
 159  *      user_other_email:       Not set.
 160  *
 161  * The default configuration also contains comments to guide the user
 162  * in editing the file directly.
 163  */
 164 notmuch_config_t *
 165 notmuch_config_open (void *ctx,
 166                      const char *filename,
 167                      notmuch_bool_t *is_new_ret)
 168 {
 169     GError *error = NULL;
 170     int is_new = 0;
 171
 172     if (is_new_ret)
 173         *is_new_ret = 0;
 174
 175     notmuch_config_t *config = talloc (ctx, notmuch_config_t);
 176     if (config == NULL) {
 177         fprintf (stderr, "Out of memory.\n");
 178         return NULL;
 179     }
 180
 181     talloc_set_destructor (config, notmuch_config_destructor);
 182
 183     if (filename)
 184         config->filename = talloc_strdup (config, filename);
 185     else
 186         config->filename = talloc_asprintf (config, "%s/.notmuch-config",
 187                                             getenv ("HOME"));
 188
 189     config->key_file = g_key_file_new ();
 190
 191     config->database_path = NULL;
 192     config->user_name = NULL;
 193     config->user_primary_email = NULL;
 194     config->user_other_email = NULL;
 195     config->user_other_email_length = 0;
 196
 197     if (! g_key_file_load_from_file (config->key_file,
 198                                      config->filename,
 199                                      G_KEY_FILE_KEEP_COMMENTS,
 200                                      &error))
 201     {
 202         /* We are capable of dealing with a non-existent configuration
 203          * file, so be silent about that. */
 204         if (!(error->domain == G_FILE_ERROR &&
 205               error->code == G_FILE_ERROR_NOENT))
 206         {
 207             fprintf (stderr, "Error reading configuration file %s: %s\n",
 208                      config->filename, error->message);
 209             talloc_free (config);
 210             return NULL;
 211         }
 212
 213         is_new = 1;
 214     }
 215
 216     if (notmuch_config_get_database_path (config) == NULL) {
 217         char *path = talloc_asprintf (config, "%s/mail",
 218                                       getenv ("HOME"));
 219         notmuch_config_set_database_path (config, path);
 220         talloc_free (path);
 221     }
 222
 223     if (notmuch_config_get_user_name (config) == NULL) {
 224         char *name = get_name_from_passwd_file (config);
 225         notmuch_config_set_user_name (config, name);
 226         talloc_free (name);
 227     }
 228
 229     if (notmuch_config_get_user_primary_email (config) == NULL) {
 230         char *email = getenv ("EMAIL");
 231         if (email) {
 232             notmuch_config_set_user_primary_email (config, email);
 233         } else {
 234             char hostname[256];
 235             struct hostent *hostent;
 236             const char *domainname;
 237
 238             char *username = get_username_from_passwd_file (config);
 239
 240             gethostname (hostname, 256);
 241             hostname[255] = '\0';
 242
 243             hostent = gethostbyname (hostname);
 244             if (hostent && (domainname = strchr (hostent->h_name, '.')))
 245                 domainname += 1;
 246             else
 247                 domainname = "(none)";
 248
 249             email = talloc_asprintf (config, "%s@%s.%s",
 250                                      username, hostname, domainname);
 251
 252             notmuch_config_set_user_primary_email (config, email);
 253
 254             talloc_free (username);
 255             talloc_free (email);
 256         }
 257     }
 258
 259     /* When we create a new configuration file here, we  add some
 260      * comments to help the user understand what can be done. */
 261     if (is_new) {
 262         g_key_file_set_comment (config->key_file, NULL, NULL,
 263                                 toplevel_config_comment, NULL);
 264         g_key_file_set_comment (config->key_file, "database", NULL,
 265                                 database_config_comment, NULL);
 266         g_key_file_set_comment (config->key_file, "user", NULL,
 267                                 user_config_comment, NULL);
 268     }
 269
 270     if (is_new_ret)
 271         *is_new_ret = is_new;
 272
 273     return config;
 274 }
 275
 276 /* Close the given notmuch_config_t object, freeing all resources.
 277  *
 278  * Note: Any changes made to the configuration are *not* saved by this
 279  * function. To save changes, call notmuch_config_save before
 280  * notmuch_config_close.
 281 */
 282 void
 283 notmuch_config_close (notmuch_config_t *config)
 284 {
 285     talloc_free (config);
 286 }
 287
 288 /* Save any changes made to the notmuch configuration.
 289  *
 290  * Any comments originally in the file will be preserved.
 291  *
 292  * Returns 0 if successful, and 1 in case of any error, (after
 293  * printing a description of the error to stderr).
 294  */
 295 int
 296 notmuch_config_save (notmuch_config_t *config)
 297 {
 298     size_t length;
 299     char *data;
 300     GError *error = NULL;
 301
 302     data = g_key_file_to_data (config->key_file, &length, NULL);
 303     if (data == NULL) {
 304         fprintf (stderr, "Out of memory.\n");
 305         return 1;
 306     }
 307
 308     if (! g_file_set_contents (config->filename, data, length, &error)) {
 309         fprintf (stderr, "Error saving configuration to %s: %s\n",
 310                  config->filename, error->message);
 311         return 1;
 312     }
 313
 314     return 0;
 315 }
 316
 317 const char *
 318 notmuch_config_get_database_path (notmuch_config_t *config)
 319 {
 320     char *path;
 321
 322     if (config->database_path == NULL) {
 323         path = g_key_file_get_string (config->key_file,
 324                                       "database", "path", NULL);
 325         if (path) {
 326             config->database_path = talloc_strdup (config, path);
 327             free (path);
 328         }
 329     }
 330
 331     return config->database_path;
 332 }
 333
 334 void
 335 notmuch_config_set_database_path (notmuch_config_t *config,
 336                                   const char *database_path)
 337 {
 338     g_key_file_set_string (config->key_file,
 339                            "database", "path", database_path);
 340
 341     talloc_free (config->database_path);
 342     config->database_path = NULL;
 343 }
 344
 345 const char *
 346 notmuch_config_get_user_name (notmuch_config_t *config)
 347 {
 348     char *name;
 349
 350     if (config->user_name == NULL) {
 351         name = g_key_file_get_string (config->key_file,
 352                                       "user", "name", NULL);
 353         if (name) {
 354             config->user_name = talloc_strdup (config, name);
 355             free (name);
 356         }
 357     }
 358
 359     return config->user_name;
 360 }
 361
 362 void
 363 notmuch_config_set_user_name (notmuch_config_t *config,
 364                               const char *user_name)
 365 {
 366     g_key_file_set_string (config->key_file,
 367                            "user", "name", user_name);
 368
 369     talloc_free (config->user_name);
 370     config->user_name = NULL;
 371 }
 372
 373 const char *
 374 notmuch_config_get_user_primary_email (notmuch_config_t *config)
 375 {
 376     char *email;
 377
 378     if (config->user_primary_email == NULL) {
 379         email = g_key_file_get_string (config->key_file,
 380                                        "user", "primary_email", NULL);
 381         if (email) {
 382             config->user_primary_email = talloc_strdup (config, email);
 383             free (email);
 384         }
 385     }
 386
 387     return config->user_primary_email;
 388 }
 389
 390 void
 391 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 392                                        const char *primary_email)
 393 {
 394     g_key_file_set_string (config->key_file,
 395                            "user", "primary_email", primary_email);
 396
 397     talloc_free (config->user_primary_email);
 398     config->user_primary_email = NULL;
 399 }
 400
 401 char **
 402 notmuch_config_get_user_other_email (notmuch_config_t *config,
 403                                      size_t *length)
 404 {
 405     char **emails;
 406     size_t emails_length;
 407     unsigned int i;
 408
 409     if (config->user_other_email == NULL) {
 410         emails = g_key_file_get_string_list (config->key_file,
 411                                              "user", "other_email",
 412                                              &emails_length, NULL);
 413         if (emails) {
 414             config->user_other_email = talloc_size (config,
 415                                                     sizeof (char *) *
 416                                                     (emails_length + 1));
 417             for (i = 0; i < emails_length; i++)
 418                 config->user_other_email[i] = talloc_strdup (config->user_other_email,
 419                                                              emails[i]);
 420             config->user_other_email[i] = NULL;
 421
 422             g_strfreev (emails);
 423
 424             config->user_other_email_length = emails_length;
 425         }
 426     }
 427
 428     *length = config->user_other_email_length;
 429     return config->user_other_email;
 430 }
 431
 432 void
 433 notmuch_config_set_user_other_email (notmuch_config_t *config,
 434                                      const char *other_email[],
 435                                      size_t length)
 436 {
 437     g_key_file_set_string_list (config->key_file,
 438                                 "user", "other_email",
 439                                 other_email, length);
 440
 441     talloc_free (config->user_other_email);
 442     config->user_other_email = NULL;
 443 }