X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/blobdiff_plain/8e58a1769ce5e492dd68904dfc81b6e077fc2a3a..c8d06ad9146d939718dec9ee01b39e4e7012ef23:/keydb.h

diff --git a/keydb.h b/keydb.h
index 9a248e3..ae87ce3 100644
--- a/keydb.h
+++ b/keydb.h
@@ -9,7 +9,6 @@
 #ifndef __KEYDB_H__
 #define __KEYDB_H__
 
-// #include <stdint.h>
 #include <inttypes.h>
 
 #include "keystructs.h"
@@ -17,12 +16,13 @@
 
 /**
  *	initdb - Initialize the key database.
+ *	@readonly: If we'll only be reading the DB, not writing to it.
  *
  *	This function should be called before any of the other functions in
  *	this file are called in order to allow the DB to be initialized ready
  *	for access.
  */
-void initdb(void);
+void initdb(bool readonly);
 
 /**
  *	cleanupdb - De-initialize the key database.
@@ -32,38 +32,60 @@ void initdb(void);
  */
 void cleanupdb(void);
 
+/**
+ *	starttrans - Start a transaction.
+ *
+ *	Start a transaction. Intended to be used if we're about to perform many
+ *	operations on the database to help speed it all up, or if we want
+ *	something to only succeed if all relevant operations are successful.
+ */
+bool starttrans(void);
+
+/**
+ *	endtrans - End a transaction.
+ *
+ *	Ends a transaction.
+ */
+void endtrans(void);
+
 /**
  *	fetch_key - Given a keyid fetch the key from storage.
  *	@keyid: The keyid to fetch.
  *	@publickey: A pointer to a structure to return the key in.
+ *	@intrans: If we're already in a transaction.
  *
  *	This function returns a public key from whatever storage mechanism we
  *	are using.
  *
  *      TODO: What about keyid collisions? Should we use fingerprint instead?
  */
-int fetch_key(uint64_t keyid, struct openpgp_publickey **publickey);
+int fetch_key(uint64_t keyid, struct openpgp_publickey **publickey, bool intrans);
 
 /**
  *	store_key - Takes a key and stores it.
  *	@publickey: A pointer to the public key to store.
+ *	@intrans: If we're already in a transaction.
+ *	@update: If true the key exists and should be updated.
  *
  *	This function stores a public key in whatever storage mechanism we are
- *	using.
+ *	using. intrans indicates if we're already in a transaction so don't
+ *	need to start one. update indicates if the key already exists and is
+ *	just being updated.
  *
  *	TODO: Do we store multiple keys of the same id? Or only one and replace
  *	it?
  */
-int store_key(struct openpgp_publickey *publickey);
+int store_key(struct openpgp_publickey *publickey, bool intrans, bool update);
 
 /**
  *	delete_key - Given a keyid delete the key from storage.
  *	@keyid: The keyid to delete.
+ *	@intrans: If we're already in a transaction.
  *
  *	This function deletes a public key from whatever storage mechanism we
  *	are using. Returns 0 if the key existed.
  */
-int delete_key(uint64_t keyid);
+int delete_key(uint64_t keyid, bool intrans);
 
 /**
  *	fetch_key_text - Trys to find the keys that contain the supplied text.
@@ -87,10 +109,42 @@ char *keyid2uid(uint64_t keyid);
 /**
  *	getkeysigs - Gets a linked list of the signatures on a key.
  *	@keyid: The keyid to get the sigs for.
+ *	@revoked: Is the key revoked?
  *
  *	This function gets the list of signatures on a key. Used for key 
- *	indexing and doing stats bits.
+ *	indexing and doing stats bits. If revoked is non-NULL then if the key
+ *	is revoked it's set to true.
+ */
+struct ll *getkeysigs(uint64_t keyid, bool *revoked);
+
+/**
+ *	cached_getkeysigs - Gets the signatures on a key.
+ *	@keyid: The key we want the signatures for.
+ *	
+ *	This function gets the signatures on a key. It's the same as the
+ *	getkeysigs function above except we use the hash module to cache the
+ */
+struct ll *cached_getkeysigs(uint64_t keyid);
+
+/**
+ *	getfullkeyid - Maps a 32bit key id to a 64bit one.
+ *	@keyid: The 32bit keyid.
+ *
+ *	This function maps a 32bit key id to the full 64bit one. It returns the
+ *	full keyid. If the key isn't found a keyid of 0 is returned.
+ */
+uint64_t getfullkeyid(uint64_t keyid);
+
+/**
+ *	dumpdb - dump the key database
+ *	@filenamebase: The base filename to use for the dump.
+ *
+ *	Dumps the database into one or more files, which contain pure OpenPGP
+ *	that can be reimported into onak or gpg. filenamebase provides a base
+ *	file name for the dump; several files may be created, all of which will
+ *	begin with this string and then have a unique number and a .pgp
+ *	extension.
  */
-struct ll *getkeysigs(uint64_t keyid);
+int dumpdb(char *filenamebase);
 
 #endif /* __KEYDB_H__ */