X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/blobdiff_plain/340e776784a8902d43e6c4658c45254202e2779e..HEAD:/onak-conf.h

diff --git a/onak-conf.h b/onak-conf.h
index f91057e..eb3d91c 100644
--- a/onak-conf.h
+++ b/onak-conf.h
@@ -1,57 +1,105 @@
-/*
- * onak-conf.h - Routines related to runtime config.
+/**
+ * @file onak-conf.h
+ * @brief Routines related to runtime config.
  *
- * Jonathan McDowell <noodles@earth.li>
+ * Copyright 2002 Jonathan McDowell <noodles@earth.li>
  *
- * Copyright 2002 Project Purple
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifndef __ONAK_CONF_H_
 #define __ONAK_CONF_H_
 
-#define VERSION "0.0.4"
+#include "keydb.h"
 
-/*
- *	struct onak_config - Runtime configuration for onak.
- *	@maxkeys: The maximum number of keys a query should return.
- *
- * 	@db2_dbpath: The path to the directory containing the db2 files.
- * 
- *	@file_dbpath: The path to the flat file DB directory.
+/**
+ * @brief Runtime configuration for onak.
  *
- *	@pg_dbhost: The host that Postgres is running on.
- *	@pg_dbname: The database name.
- *	@pg_dbuser: The user we should connect as.
- *	@pg_dbpass: The password for the user.
- *
- *	This structure holds various runtime configuration options for onak. It
- *	will eventually be populated from the config file.
+ * This structure holds various runtime configuration options for onak. It
+ * will eventually be populated from the config file.
  */
 struct onak_config {
-	int maxkeys;
-
 	/*
-	 * Options for the db2 file backend.
+	 * Generic options.
 	 */
-	char *db2_dbpath;
+	/** The maximum number of keys a query should return. */
+	int maxkeys;
+	/** Our email address that servers sync with. */
+	char *thissite;
+	/** The email address of the server admin. */
+	char *adminemail;
+	/** The mta to invoke to send sync mails. */
+	char *mta;
+	/** List of email address for sites we sync with via email */
+	struct ll *syncsites;
+	/** A linked list of sites we sync with. */
+	char *logfile;
+
+	/** Set if we're using keyd as the backend. */
+	bool use_keyd;
 
 	/*
-	 * Options for the file backend.
+	 * Options for any database backend that needs a directory, be it the
+	 * file, db2 or db3 options.
 	 */
-	char *file_dbpath;
+	/** The path to the directory containing the database files. */
+	char *db_dir;
 	
 	/*
 	 * Options for the Postgres backend.
 	 */
+	/** The host that Postgres is running on. */
 	char *pg_dbhost;
+	/** The database name. */
 	char *pg_dbname;
+	/** The user we should connect as. */
 	char *pg_dbuser;
+	/** The password for the user. */
 	char *pg_dbpass;
+
+	/*
+	 * Options for the dynamic backend.
+	 */
+	/** Name of the DB backend we're using */
+	char *db_backend;
+	/** Directory where backend .so files can be found */
+	char *backends_dir;
+
+	/** Pointer to the function table for our loaded DB backend */
+	struct dbfuncs *dbbackend;
+
+	/** Should we verify signature hashes match? */
+	bool check_sighash;
 };
 
-/*
- *	config - The variable containing our runtime config.
+/**
+ * @brief The variable containing our runtime config.
  */
 extern struct onak_config config;
 
+/**
+ * @brief read the onak config.
+ * @param configfile the config file to read.
+ *
+ * Read in our config file. If config file is NULL read in the compile
+ * time default.
+ */
+void readconfig(const char *configfile);
+
+/**
+ * @brief clean up the config when we're shutting down.
+ */
+void cleanupconfig(void);
+
 #endif /* __ONAK_CONF_H_ */