Pileus Git - ~andy/fetchmail/blob - conf.c

   1 /*
   2  * conf.c -- dump fetchmail configuration as Python dictionary initializer
   3  *
   4  * For license terms, see the file COPYING in this directory.
   5  */
   6
   7 #include "config.h"
   8 #include "tunable.h"
   9
  10 #include <stdio.h>
  11 #include <ctype.h>
  12 #if defined(STDC_HEADERS)
  13 #include <stdlib.h>
  14 #endif
  15 #if defined(HAVE_UNISTD_H)
  16 #include <unistd.h>
  17 #endif
  18 #include <string.h>
  19 #include <pwd.h>
  20 #include <errno.h>
  21
  22 #include "fetchmail.h"
  23
  24 /* Python prettyprinting functions */
  25
  26 static int indent_level;
  27
  28 static void indent(char ic)
  29 /* indent current line */
  30 {
  31     int i;
  32
  33     if (ic == ')' || ic == ']' || ic == '}')
  34         indent_level--;
  35
  36     /*
  37      * The guard here is a kluge.  It depends on the fact that in the
  38      * particular structure we're dumping, opening [s are always
  39      * initializers for dictionary members and thus will be preceded
  40      * by a member name.
  41      */
  42     if (ic != '[')
  43     {
  44         for (i = 0; i < indent_level / 2; i++)
  45             putc('\t', stdout);
  46         if (indent_level % 2)
  47             fputs("    ", stdout);
  48     }
  49
  50     if (ic)
  51     {
  52         putc(ic, stdout);
  53         putc('\n', stdout);
  54     }
  55
  56     if (ic == '(' || ic == '[' || ic == '{')
  57         indent_level++;
  58 }
  59
  60
  61 static void stringdump(const char *name, const char *member)
  62 /* dump a string member with current indent */
  63 {
  64     indent('\0');
  65     fprintf(stdout, "\"%s\":", name);
  66     if (member)
  67         fprintf(stdout, "\"%s\"", visbuf(member));
  68     else
  69         fputs("None", stdout);
  70     fputs(",\n", stdout);
  71 }
  72
  73 static void numdump(const char *name, const int num)
  74 /* dump a numeric quantity at current indent */
  75 {
  76     indent('\0');
  77     fprintf(stdout, "'%s':%d,\n", name, NUM_VALUE_OUT(num));
  78 }
  79
  80 static void booldump(const char *name, const int onoff)
  81 /* dump a boolean quantity at current indent */
  82 {
  83     indent('\0');
  84     if (onoff)
  85         fprintf(stdout, "'%s':TRUE,\n", name);
  86     else
  87         fprintf(stdout, "'%s':FALSE,\n", name);
  88 }
  89
  90 static void listdump(const char *name, struct idlist *list)
  91 /* dump a string list member with current indent */
  92 {
  93     indent('\0');
  94     fprintf(stdout, "\"%s\":", name);
  95
  96     if (!list)
  97         fputs("[],\n", stdout);
  98     else
  99     {
 100         struct idlist *idp;
 101
 102         fputs("[", stdout);
 103         for (idp = list; idp; idp = idp->next)
 104             if (idp->id)
 105             {
 106                 fprintf(stdout, "\"%s\"", visbuf(idp->id));
 107                 if (idp->next)
 108                     fputs(", ", stdout);
 109             }
 110         fputs("],\n", stdout);
 111     }
 112 }
 113
 114 /*
 115  * Note: this function dumps the entire configuration,
 116  * after merging of the defaults record (if any).  It
 117  * is intended to produce output parseable by a configuration
 118  * front end, not anything especially comfortable for humans.
 119  */
 120
 121 void dump_config(struct runctl *runp, struct query *querylist)
 122 /* dump the in-core configuration in recompilable form */
 123 {
 124     struct query *ctl;
 125     struct idlist *idp;
 126     const char *features;
 127
 128     indent_level = 0;
 129
 130     /*
 131      * These had better match the values fetchmailconf is expecting!
 132      * (We don't want to import them from Tkinter because the user
 133      * might not have it installed.)
 134      */
 135     fputs("TRUE=1; FALSE=0\n\n", stdout);
 136
 137     /*
 138      * We need this in order to know whether `interface' and `monitor'
 139      * are valid options or not.
 140      */
 141 #if defined(linux)
 142     fputs("os_type = 'linux'\n", stdout);
 143 #elif defined(__FreeBSD__)
 144     fputs("os_type = 'freebsd'\n", stdout);
 145 #else
 146     fputs("os_type = 'generic'\n", stdout);
 147 #endif
 148
 149     /*
 150      * This should be approximately in sync with the -V option dumping
 151      * in fetchmail.c.
 152      */
 153     features = "feature_options = ("
 154 #ifdef POP2_ENABLE
 155     "'pop2',"
 156 #endif /* POP2_ENABLE */
 157 #ifdef POP3_ENABLE
 158     "'pop3',"
 159 #endif /* POP3_ENABLE */
 160 #ifdef IMAP_ENABLE
 161     "'imap',"
 162 #endif /* IMAP_ENABLE */
 163 #ifdef GSSAPI
 164     "'gssapi',"
 165 #endif /* GSSAPI */
 166 #if defined(KERBEROS_V4)
 167     "'kerberos',"
 168 #endif /* defined(IMAP4) */
 169 #ifdef RPA_ENABLE
 170     "'rpa',"
 171 #endif /* RPA_ENABLE */
 172 #ifdef SDPS_ENABLE
 173     "'sdps',"
 174 #endif /* SDPS_ENABLE */
 175 #ifdef ETRN_ENABLE
 176     "'etrn',"
 177 #endif /* ETRN_ENABLE */
 178 #ifdef ODMR_ENABLE
 179     "'odmr',"
 180 #endif /* ODMR_ENABLE */
 181 #ifdef SSL_ENABLE
 182     "'ssl',"
 183 #endif /* SSL_ENABLE */
 184 #ifdef OPIE_ENABLE
 185     "'opie',"
 186 #endif /* OPIE_ENABLE */
 187 #ifdef INET6_ENABLE
 188     "'inet6',"
 189 #endif /* INET6_ENABLE */
 190     ")\n";
 191     fputs(features, stdout);
 192
 193     fputs("# Start of configuration initializer\n", stdout);
 194     fputs("fetchmailrc = ", stdout);
 195     indent('{');
 196
 197     numdump("poll_interval", runp->poll_interval);
 198     stringdump("logfile", runp->logfile);
 199     stringdump("idfile", runp->idfile);
 200     stringdump("postmaster", runp->postmaster);
 201     booldump("bouncemail", runp->bouncemail);
 202     booldump("spambounce", runp->spambounce);
 203     stringdump("properties", runp->properties);
 204     booldump("invisible", runp->invisible);
 205     booldump("showdots", runp->showdots);
 206     booldump("syslog", runp->use_syslog);
 207
 208     if (!querylist)
 209     {
 210         fputs("    'servers': []\n", stdout);
 211         goto alldone;
 212     }
 213
 214     indent(0);
 215     fputs("# List of server entries begins here\n", stdout);
 216     indent(0);
 217     fputs("'servers': ", stdout);
 218     indent('[');
 219
 220     for (ctl = querylist; ctl; ctl = ctl->next)
 221     {
 222         /*
 223          * First, the server stuff.
 224          */
 225         if (!ctl->server.lead_server)
 226         {
 227             flag        using_kpop;
 228
 229             /*
 230              * Every time we see a leading server entry after the first one,
 231              * it implicitly ends the both (a) the list of user structures
 232              * associated with the previous entry, and (b) that previous entry.
 233              */
 234             if (ctl > querylist)
 235             {
 236                 indent(']');
 237                 indent('}');
 238                 indent('\0');
 239                 putc(',', stdout);
 240                 putc('\n', stdout);
 241             }
 242
 243             indent(0);
 244             fprintf(stdout,"# Entry for site `%s' begins:\n",ctl->server.pollname);
 245             indent('{');
 246
 247             using_kpop =
 248                 (ctl->server.protocol == P_POP3 &&
 249 #ifndef INET6_ENABLE
 250                  ctl->server.port == KPOP_PORT &&
 251 #else
 252                  ctl->server.service && !strcmp(ctl->server.service, KPOP_PORT ) &&
 253 #endif
 254                  ctl->server.authenticate == A_KERBEROS_V4);
 255
 256             stringdump("pollname", ctl->server.pollname);
 257             booldump("active", !ctl->server.skip);
 258             stringdump("via", ctl->server.via);
 259             stringdump("protocol",
 260                        using_kpop ? "KPOP" : showproto(ctl->server.protocol));
 261 #ifndef INET6_ENABLE
 262             numdump("port",  ctl->server.port);
 263 #else
 264             stringdump("port",  ctl->server.service);
 265 #endif
 266             numdump("timeout",  ctl->server.timeout);
 267             numdump("interval", ctl->server.interval);
 268
 269             if (ctl->server.envelope == STRING_DISABLED)
 270                 stringdump("envelope", NULL);
 271             else if (ctl->server.envelope == NULL)
 272                 stringdump("envelope", "Received");
 273             else
 274                 stringdump("envelope", ctl->server.envelope);
 275             numdump("envskip", ctl->server.envskip);
 276             stringdump("qvirtual", ctl->server.qvirtual);
 277
 278             if (ctl->server.authenticate == A_ANY)
 279                 stringdump("auth", "any");
 280             else if (ctl->server.authenticate == A_PASSWORD)
 281                 stringdump("auth", "password");
 282             else if (ctl->server.authenticate == A_OTP)
 283                 stringdump("auth", "otp");
 284             else if (ctl->server.authenticate == A_NTLM)
 285                 stringdump("auth", "ntlm");
 286             else if (ctl->server.authenticate == A_CRAM_MD5)
 287                 stringdump("auth", "cram-md5");
 288             else if (ctl->server.authenticate == A_GSSAPI)
 289                 stringdump("auth", "gssapi");
 290             else if (ctl->server.authenticate == A_KERBEROS_V4)
 291                 stringdump("auth", "kerberos_v4");
 292             else if (ctl->server.authenticate == A_KERBEROS_V5)
 293                 stringdump("auth", "kerberos_v5");
 294             else if (ctl->server.authenticate == A_SSH)
 295                 stringdump("auth", "ssh");
 296             else if (ctl->server.authenticate == A_OTP)
 297                 stringdump("auth", "otp");
 298
 299 #if defined(HAVE_GETHOSTBYNAME) && defined(HAVE_RES_SEARCH)
 300             booldump("dns", ctl->server.dns);
 301 #endif /* HAVE_GETHOSTBYNAME && HAVE_RES_SEARCH */
 302             booldump("uidl", ctl->server.uidl);
 303
 304             listdump("aka", ctl->server.akalist);
 305             listdump("localdomains", ctl->server.localdomains);
 306
 307 #if defined(linux) || defined(__FreeBSD__)
 308             stringdump("interface", ctl->server.interface);
 309             stringdump("monitor", ctl->server.monitor);
 310 #endif /* linux || __FreeBSD__ */
 311
 312             stringdump("plugin", ctl->server.plugin);
 313             stringdump("plugout", ctl->server.plugout);
 314             stringdump("principal", ctl->server.principal);
 315             if (ctl->server.esmtp_name)
 316                 stringdump("esmtpname",ctl->server.esmtp_name);
 317             if (ctl->server.esmtp_password)
 318                 stringdump("esmtppassword",ctl->server.esmtp_password);
 319             booldump("tracepolls", ctl->server.tracepolls);
 320
 321             indent(0);
 322             fputs("'users': ", stdout);
 323             indent('[');
 324         }
 325
 326         indent('{');
 327
 328         stringdump("remote", ctl->remotename);
 329         stringdump("password", ctl->password);
 330
 331         indent('\0');
 332         fprintf(stdout, "'localnames':[");
 333         for (idp = ctl->localnames; idp; idp = idp->next)
 334         {
 335             char namebuf[USERNAMELEN + 1];
 336
 337             strlcpy(namebuf, visbuf(idp->id), sizeof(namebuf));
 338             if (idp->val.id2)
 339                 fprintf(stdout, "(\"%s\", %s)", namebuf, visbuf(idp->val.id2));
 340             else
 341                 fprintf(stdout, "\"%s\"", namebuf);
 342             if (idp->next)
 343                 fputs(", ", stdout);
 344         }
 345         if (ctl->wildcard)
 346             fputs(", '*'", stdout);
 347         fputs("],\n", stdout);
 348
 349         booldump("fetchall", ctl->fetchall);
 350         booldump("keep", ctl->keep);
 351         booldump("flush", ctl->flush);
 352         booldump("rewrite", ctl->rewrite);
 353         booldump("stripcr", ctl->stripcr);
 354         booldump("forcecr", ctl->forcecr);
 355         booldump("pass8bits", ctl->pass8bits);
 356         booldump("dropstatus", ctl->dropstatus);
 357         booldump("dropdelivered", ctl->dropdelivered);
 358         booldump("mimedecode", ctl->mimedecode);
 359         booldump("idle", ctl->idle);
 360
 361         stringdump("mda", ctl->mda);
 362         stringdump("bsmtp", ctl->bsmtp);
 363         indent('\0');
 364         if (ctl->listener == LMTP_MODE)
 365             fputs("'lmtp':TRUE,\n", stdout);
 366         else
 367             fputs("'lmtp':FALSE,\n", stdout);
 368
 369         stringdump("preconnect", ctl->preconnect);
 370         stringdump("postconnect", ctl->postconnect);
 371         numdump("limit", ctl->limit);
 372         numdump("warnings", ctl->warnings);
 373         numdump("fetchlimit", ctl->fetchlimit);
 374         numdump("fetchsizelimit", ctl->fetchsizelimit);
 375         numdump("fastuidl", ctl->fastuidl);
 376         numdump("batchlimit", ctl->batchlimit);
 377 #ifdef SSL_ENABLE
 378         booldump("ssl", ctl->use_ssl);
 379         stringdump("sslkey", ctl->sslkey);
 380         stringdump("sslcert", ctl->sslcert);
 381         stringdump("sslproto", ctl->sslproto);
 382         booldump("sslcertck", ctl->sslcertck);
 383         stringdump("sslcertpath", ctl->sslcertpath);
 384         stringdump("sslfingerprint", ctl->sslfingerprint);
 385 #endif /* SSL_ENABLE */
 386         numdump("expunge", ctl->expunge);
 387         stringdump("properties", ctl->properties);
 388         listdump("smtphunt", ctl->smtphunt);
 389         listdump("fetchdomains", ctl->domainlist);
 390         stringdump("smtpaddress", ctl->smtpaddress);
 391         stringdump("smtpname", ctl->smtpname);
 392
 393         indent('\0');
 394         fprintf(stdout, "'antispam':'");
 395         for (idp = ctl->antispam; idp; idp = idp->next)
 396         {
 397             fprintf(stdout, "%d", idp->val.status.num);
 398             if (idp->next)
 399                 fputs(" ", stdout);
 400         }
 401         fputs("',\n", stdout);
 402         listdump("mailboxes", ctl->mailboxes);
 403
 404         indent('}');
 405         indent('\0');
 406         fputc(',', stdout);
 407     }
 408
 409     /* end last span of user entries and last server entry */
 410     indent(']');
 411     indent('}');
 412
 413     /* end array of servers */
 414     indent(']');
 415
 416  alldone:
 417     /* end top-level dictionary */
 418     indent('}');
 419     fputs("# End of initializer\n", stdout);
 420 }
 421
 422 /* conf.c ends here */