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. If the filename is NULL,
 136  * the value of the environment variable $NOTMUCH_CONFIG will be used.
 137  * If $NOTMUCH_CONFIG is unset, the default configuration file
 138  * ($HOME/.notmuch-config) will be used.
 139  *
 140  * If any error occurs, (out of memory, or a permission-denied error,
 141  * etc.), this function will print a message to stderr and return
 142  * NULL.
 143  *
 144  * Note: It is *not* an error if the specified configuration file does
 145  * not exist. In this case, a default configuration will be created
 146  * and returned. Subsequently calling notmuch_config_save will cause
 147  * the configuration to be written to the filename specified at the
 148  * time of notmuch_config_open.
 149  *
 150  * The default configuration settings are determined as follows:
 151  *
 152  *      database_path:          $HOME/mail
 153  *
 154  *      user_name:              From /etc/passwd
 155  *
 156  *      user_primary_mail:      $EMAIL variable if set, otherwise
 157  *                              constructed from the username and
 158  *                              hostname of the current machine.
 159  *
 160  *      user_other_email:       Not set.
 161  *
 162  * The default configuration also contains comments to guide the user
 163  * in editing the file directly.
 164  */
 165 notmuch_config_t *
 166 notmuch_config_open (void *ctx,
 167                      const char *filename,
 168                      notmuch_bool_t *is_new_ret)
 169 {
 170     GError *error = NULL;
 171     int is_new = 0;
 172     char *notmuch_config_env = NULL;
 173
 174     if (is_new_ret)
 175         *is_new_ret = 0;
 176
 177     notmuch_config_t *config = talloc (ctx, notmuch_config_t);
 178     if (config == NULL) {
 179         fprintf (stderr, "Out of memory.\n");
 180         return NULL;
 181     }
 182
 183     talloc_set_destructor (config, notmuch_config_destructor);
 184
 185     if (filename) {
 186         config->filename = talloc_strdup (config, filename);
 187     } else if ((notmuch_config_env = getenv ("NOTMUCH_CONFIG"))) {
 188         config->filename = talloc_strdup (config, notmuch_config_env);
 189         notmuch_config_env = NULL;
 190     } else {
 191         config->filename = talloc_asprintf (config, "%s/.notmuch-config",
 192                                             getenv ("HOME"));
 193     }
 194
 195     config->key_file = g_key_file_new ();
 196
 197     config->database_path = NULL;
 198     config->user_name = NULL;
 199     config->user_primary_email = NULL;
 200     config->user_other_email = NULL;
 201     config->user_other_email_length = 0;
 202
 203     if (! g_key_file_load_from_file (config->key_file,
 204                                      config->filename,
 205                                      G_KEY_FILE_KEEP_COMMENTS,
 206                                      &error))
 207     {
 208         /* We are capable of dealing with a non-existent configuration
 209          * file, so be silent about that. */
 210         if (!(error->domain == G_FILE_ERROR &&
 211               error->code == G_FILE_ERROR_NOENT))
 212         {
 213             fprintf (stderr, "Error reading configuration file %s: %s\n",
 214                      config->filename, error->message);
 215             talloc_free (config);
 216             g_error_free (error);
 217             return NULL;
 218         }
 219
 220         g_error_free (error);
 221         is_new = 1;
 222     }
 223
 224     if (notmuch_config_get_database_path (config) == NULL) {
 225         char *path = talloc_asprintf (config, "%s/mail",
 226                                       getenv ("HOME"));
 227         notmuch_config_set_database_path (config, path);
 228         talloc_free (path);
 229     }
 230
 231     if (notmuch_config_get_user_name (config) == NULL) {
 232         char *name = get_name_from_passwd_file (config);
 233         notmuch_config_set_user_name (config, name);
 234         talloc_free (name);
 235     }
 236
 237     if (notmuch_config_get_user_primary_email (config) == NULL) {
 238         char *email = getenv ("EMAIL");
 239         if (email) {
 240             notmuch_config_set_user_primary_email (config, email);
 241         } else {
 242             char hostname[256];
 243             struct hostent *hostent;
 244             const char *domainname;
 245
 246             char *username = get_username_from_passwd_file (config);
 247
 248             gethostname (hostname, 256);
 249             hostname[255] = '\0';
 250
 251             hostent = gethostbyname (hostname);
 252             if (hostent && (domainname = strchr (hostent->h_name, '.')))
 253                 domainname += 1;
 254             else
 255                 domainname = "(none)";
 256
 257             email = talloc_asprintf (config, "%s@%s.%s",
 258                                      username, hostname, domainname);
 259
 260             notmuch_config_set_user_primary_email (config, email);
 261
 262             talloc_free (username);
 263             talloc_free (email);
 264         }
 265     }
 266
 267     /* When we create a new configuration file here, we  add some
 268      * comments to help the user understand what can be done. */
 269     if (is_new) {
 270         g_key_file_set_comment (config->key_file, NULL, NULL,
 271                                 toplevel_config_comment, NULL);
 272         g_key_file_set_comment (config->key_file, "database", NULL,
 273                                 database_config_comment, NULL);
 274         g_key_file_set_comment (config->key_file, "user", NULL,
 275                                 user_config_comment, NULL);
 276     }
 277
 278     if (is_new_ret)
 279         *is_new_ret = is_new;
 280
 281     return config;
 282 }
 283
 284 /* Close the given notmuch_config_t object, freeing all resources.
 285  *
 286  * Note: Any changes made to the configuration are *not* saved by this
 287  * function. To save changes, call notmuch_config_save before
 288  * notmuch_config_close.
 289 */
 290 void
 291 notmuch_config_close (notmuch_config_t *config)
 292 {
 293     talloc_free (config);
 294 }
 295
 296 /* Save any changes made to the notmuch configuration.
 297  *
 298  * Any comments originally in the file will be preserved.
 299  *
 300  * Returns 0 if successful, and 1 in case of any error, (after
 301  * printing a description of the error to stderr).
 302  */
 303 int
 304 notmuch_config_save (notmuch_config_t *config)
 305 {
 306     size_t length;
 307     char *data;
 308     GError *error = NULL;
 309
 310     data = g_key_file_to_data (config->key_file, &length, NULL);
 311     if (data == NULL) {
 312         fprintf (stderr, "Out of memory.\n");
 313         return 1;
 314     }
 315
 316     if (! g_file_set_contents (config->filename, data, length, &error)) {
 317         fprintf (stderr, "Error saving configuration to %s: %s\n",
 318                  config->filename, error->message);
 319         g_error_free (error);
 320         return 1;
 321     }
 322
 323     return 0;
 324 }
 325
 326 const char *
 327 notmuch_config_get_database_path (notmuch_config_t *config)
 328 {
 329     char *path;
 330
 331     if (config->database_path == NULL) {
 332         path = g_key_file_get_string (config->key_file,
 333                                       "database", "path", NULL);
 334         if (path) {
 335             config->database_path = talloc_strdup (config, path);
 336             free (path);
 337         }
 338     }
 339
 340     return config->database_path;
 341 }
 342
 343 void
 344 notmuch_config_set_database_path (notmuch_config_t *config,
 345                                   const char *database_path)
 346 {
 347     g_key_file_set_string (config->key_file,
 348                            "database", "path", database_path);
 349
 350     talloc_free (config->database_path);
 351     config->database_path = NULL;
 352 }
 353
 354 const char *
 355 notmuch_config_get_user_name (notmuch_config_t *config)
 356 {
 357     char *name;
 358
 359     if (config->user_name == NULL) {
 360         name = g_key_file_get_string (config->key_file,
 361                                       "user", "name", NULL);
 362         if (name) {
 363             config->user_name = talloc_strdup (config, name);
 364             free (name);
 365         }
 366     }
 367
 368     return config->user_name;
 369 }
 370
 371 void
 372 notmuch_config_set_user_name (notmuch_config_t *config,
 373                               const char *user_name)
 374 {
 375     g_key_file_set_string (config->key_file,
 376                            "user", "name", user_name);
 377
 378     talloc_free (config->user_name);
 379     config->user_name = NULL;
 380 }
 381
 382 const char *
 383 notmuch_config_get_user_primary_email (notmuch_config_t *config)
 384 {
 385     char *email;
 386
 387     if (config->user_primary_email == NULL) {
 388         email = g_key_file_get_string (config->key_file,
 389                                        "user", "primary_email", NULL);
 390         if (email) {
 391             config->user_primary_email = talloc_strdup (config, email);
 392             free (email);
 393         }
 394     }
 395
 396     return config->user_primary_email;
 397 }
 398
 399 void
 400 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 401                                        const char *primary_email)
 402 {
 403     g_key_file_set_string (config->key_file,
 404                            "user", "primary_email", primary_email);
 405
 406     talloc_free (config->user_primary_email);
 407     config->user_primary_email = NULL;
 408 }
 409
 410 char **
 411 notmuch_config_get_user_other_email (notmuch_config_t *config,
 412                                      size_t *length)
 413 {
 414     char **emails;
 415     size_t emails_length;
 416     unsigned int i;
 417
 418     if (config->user_other_email == NULL) {
 419         emails = g_key_file_get_string_list (config->key_file,
 420                                              "user", "other_email",
 421                                              &emails_length, NULL);
 422         if (emails) {
 423             config->user_other_email = talloc_size (config,
 424                                                     sizeof (char *) *
 425                                                     (emails_length + 1));
 426             for (i = 0; i < emails_length; i++)
 427                 config->user_other_email[i] = talloc_strdup (config->user_other_email,
 428                                                              emails[i]);
 429             config->user_other_email[i] = NULL;
 430
 431             g_strfreev (emails);
 432
 433             config->user_other_email_length = emails_length;
 434         }
 435     }
 436
 437     *length = config->user_other_email_length;
 438     return config->user_other_email;
 439 }
 440
 441 void
 442 notmuch_config_set_user_other_email (notmuch_config_t *config,
 443                                      const char *other_email[],
 444                                      size_t length)
 445 {
 446     g_key_file_set_string_list (config->key_file,
 447                                 "user", "other_email",
 448                                 other_email, length);
 449
 450     talloc_free (config->user_other_email);
 451     config->user_other_email = NULL;
 452 }