![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index aac884a5d104a72cd747c3db83ffa0f8b478a5c7..a327ae9d31ebd31744e4ce6d9d0786b0d183ae29 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
#include "sysdb.h"
#include "core/object.h"
+#include "core/data.h"
#include "core/time.h"
#include "utils/llist.h"
+#include "utils/strbuf.h"
#include <stdio.h>
extern "C" {
#endif
-extern const sdb_type_t sdb_host_type;
-extern const sdb_type_t sdb_attribute_type;
-extern const sdb_type_t sdb_service_type;
-
-typedef struct {
- sdb_object_t super;
- sdb_time_t last_update;
-} sdb_store_obj_t;
-#define SDB_STORE_OBJ_INIT(t) { SDB_OBJECT_TYPED_INIT(t), 0 }
-#define SDB_STORE_OBJ(obj) ((sdb_store_obj_t *)(obj))
-#define SDB_CONST_STORE_OBJ(obj) ((const sdb_store_obj_t *)(obj))
-
-typedef struct {
- sdb_store_obj_t super;
-
- char *hostname;
-} sdb_service_t;
-#define SDB_SVC_INIT { SDB_STORE_OBJ_INIT(sdb_service_type), NULL }
-#define SDB_SVC(obj) ((sdb_service_t *)(obj))
-#define SDB_CONST_SVC(obj) ((const sdb_service_t *)(obj))
-
-typedef struct {
- sdb_store_obj_t super;
-
- char *attr_value;
- char *hostname;
-} sdb_attribute_t;
-#define SDB_ATTR_INIT { SDB_STORE_OBJ_INIT(sdb_attribute_type), NULL, NULL }
-#define SDB_ATTR(obj) ((sdb_attribute_t *)(obj))
-#define SDB_CONST_ATTR(obj) ((const sdb_attribute_t *)(obj))
-
-typedef struct {
- sdb_store_obj_t super;
-
- sdb_llist_t *attributes;
- sdb_llist_t *services;
-} sdb_host_t;
-#define SDB_HOST_INIT { SDB_STORE_OBJ_INIT(sdb_host_type), NULL, NULL }
-#define SDB_HOST(obj) ((sdb_host_t *)(obj))
-#define SDB_CONST_HOST(obj) ((const sdb_host_t *)(obj))
-
-/* shortcuts for accessing the sdb_store_obj_t attributes of inheriting
- * objects */
-#define _last_update super.last_update
+/*
+ * sdb_store_base_t represents the super-class of any object stored in the
+ * database. It inherits from sdb_object_t and may safely be cast to a generic
+ * object to access its name.
+ */
+struct sdb_store_base;
+typedef struct sdb_store_base sdb_store_base_t;
+
+/*
+ * sdb_store_clear:
+ * Clear the entire store and remove all stored objects.
+ */
+void
+sdb_store_clear(void);
/*
* sdb_store_host:
int
sdb_store_host(const char *name, sdb_time_t last_update);
+/*
+ * sdb_store_has_host:
+ * sdb_store_get_host:
+ * Query the store for a host by its (canonicalized) name.
+ *
+ * sdb_store_get_host increments the ref count of the host object. The caller
+ * needs to deref it when no longer using it.
+ */
_Bool
sdb_store_has_host(const char *name);
-sdb_attribute_t *
-sdb_attribute_create(const char *hostname,
- const char *name, const char *value);
+sdb_store_base_t *
+sdb_store_get_host(const char *name);
/*
* sdb_store_attribute:
* Add/update a host's attribute in the store. If the attribute, identified by
- * its name, already exists for the specified host, it will be updated
- * according to the specified 'attr' object. If the referenced host does not
- * exist, an error will be reported. Else, a new entry will be created in the
- * store. Any memory required for storing the entry will be allocated and
- * managed by the store itself. The specified attribute-object will not be
- * referenced or further accessed.
+ * its key, already exists for the specified host, it will be updated to the
+ * specified values. If the referenced host does not exist, an error will be
+ * reported. Else, a new entry will be created in the store. Any memory
+ * required for storing the entry will be allocated and managed by the store
+ * itself.
*
* Returns:
* - 0 on success
* - a negative value on error
*/
int
-sdb_store_attribute(const sdb_attribute_t *attr);
-
-sdb_service_t *
-sdb_service_create(const char *hostname, const char *name);
+sdb_store_attribute(const char *hostname,
+ const char *key, const sdb_data_t *value,
+ sdb_time_t last_update);
/*
* sdb_store_service:
* - a negative value on error
*/
int
-sdb_store_service(const sdb_service_t *svc);
+sdb_store_service(const char *hostname, const char *name,
+ sdb_time_t last_update);
+
+/*
+ * Store matchers may be used to lookup objects from the host based on their
+ * various attributes. Each type of matcher evaluates attributes of the
+ * respective object type.
+ *
+ * For each matcher object, *all* specified attributes have to match.
+ *
+ * A store matcher object inherits from sdb_object_t and, thus, may safely be
+ * cast to a generic object.
+ */
+struct sdb_store_matcher;
+typedef struct sdb_store_matcher sdb_store_matcher_t;
+
+/*
+ * sdb_store_attr_matcher:
+ * Creates a matcher matching attributes based on their name or value. Either
+ * a complete name (which will have to match completely but case-independent)
+ * or an extended POSIX regular expression may be specified.
+ */
+sdb_store_matcher_t *
+sdb_store_attr_matcher(const char *attr_name, const char *attr_name_re,
+ const char *attr_value, const char *attr_value_re);
+
+/*
+ * sdb_store_service_matcher:
+ * Creates a matcher matching services based on their name or attributes.
+ */
+sdb_store_matcher_t *
+sdb_store_service_matcher(const char *service_name, const char *service_name_re,
+ sdb_store_matcher_t *attr_matcher);
+
+/*
+ * sdb_store_host_matcher:
+ * Creates a matcher matching hosts based on their name, services assigned to
+ * the host, or its attributes.
+ */
+sdb_store_matcher_t *
+sdb_store_host_matcher(const char *host_name, const char *host_name_re,
+ sdb_store_matcher_t *service_matcher,
+ sdb_store_matcher_t *attr_matcher);
+
+/*
+ * sdb_store_matcher_matches:
+ * Check whether the specified matcher matches the specified store object.
+ *
+ * Returns:
+ * - 0 if the object matches
+ * - a negative value else
+ */
+int
+sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_base_t *obj);
-const sdb_service_t *
-sdb_store_get_service(const sdb_host_t *host, const char *name);
+/*
+ * Flags for serialization functions.
+ *
+ * By default, the full object will be included in the serialized output. When
+ * specifying any of the flags, the respective information will be left out.
+ */
+enum {
+ SDB_SKIP_ATTRIBUTES = 1 << 0,
+ SDB_SKIP_SERVICES = 1 << 1,
+ SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2,
+};
+/*
+ * sdb_store_tojson:
+ * Serialize the entire store to JSON and append the result to the specified
+ * buffer.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value on error
+ */
+int
+sdb_store_tojson(sdb_strbuf_t *buf, int flags);
+
+/*
+ * sdb_store_host_tojson:
+ * Serialize a host object to JSON and append the result to the specified
+ * buffer.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value on error
+ */
int
-sdb_store_dump(FILE *fh);
+sdb_store_host_tojson(sdb_store_base_t *host, sdb_strbuf_t *buf, int flags);
#ifdef __cplusplus
} /* extern "C" */