store_lookup: Introduce conditional based attribute matchers.

[sysdb.git] / src / include / core / store.h

diff --git a/src/include/core/store.h b/src/include/core/store.h
index 9f232758b6e1a99b337c959b4174206fbb1080ed..ecaf21d0bbd6b974483290a94dce38916dd285c4 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -41,6 +41,20 @@
 extern "C" {
 #endif
 
+/*
+ * Store object types.
+ */
+enum {
+       SDB_HOST = 1,
+       SDB_SERVICE,
+       SDB_ATTRIBUTE,
+};
+#define SDB_STORE_TYPE_TO_NAME(t) \
+       (((t) == SDB_HOST) ? "host" \
+               : ((t) == SDB_SERVICE) ? "service" \
+               : ((t) == SDB_ATTRIBUTE) ? "attribute" : "unknown")
+
+
 /*
  * 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
@@ -128,11 +142,30 @@ 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.
+ * Conditionals may be used to lookup hosts from the store based on a
+ * conditional expression.
  *
- * For each matcher object, *all* specified attributes have to match.
+ * A conditional object inherits from sdb_object_t and, thus, may safely be
+ * cast to a generic object.
+ */
+struct sdb_store_cond;
+typedef struct sdb_store_cond sdb_store_cond_t;
+#define SDB_STORE_COND(obj) ((sdb_store_cond_t *)(obj))
+
+/*
+ * sdb_store_attr_cond:
+ * Creates a conditional based on attribute values. The value of stored
+ * attributes is compared against the specified value. See sdb_data_cmp for
+ * details about the comparison.
+ */
+sdb_store_cond_t *
+sdb_store_attr_cond(const char *name, const sdb_data_t *value);
+
+/*
+ * Store matchers may be used to lookup hosts from the store based on their
+ * various attributes. Service and attribute matchers are applied to a host's
+ * services and attributes and evaluate to true if *any* service or attribute
+ * matches.
  *
  * A store matcher object inherits from sdb_object_t and, thus, may safely be
  * cast to a generic object.
@@ -142,32 +175,41 @@ typedef struct sdb_store_matcher sdb_store_matcher_t;
 #define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
 
 /*
- * 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_name_matcher:
+ * Creates a matcher matching by the specified object type's name. If 're' is
+ * true, the specified name is treated as a POSIX extended regular expression.
+ * Else, the exact name has to match (case-insensitive).
  */
 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_name_matcher(int type, const char *name, _Bool re);
 
 /*
- * sdb_store_service_matcher:
- * Creates a matcher matching services based on their name or attributes.
+ * sdb_store_attr_matcher:
+ * Creates a matcher matching attributes based on their value. If 're' is
+ * true, the specified name is treated as a POSIX extended regular expression.
+ * Else, the exact name has to match (case-insensitive).
  */
 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_attr_matcher(const char *name, const char *value, _Bool re);
 
 /*
- * sdb_store_host_matcher:
- * Creates a matcher matching hosts based on their name, services assigned to
- * the host, or its attributes.
+ * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
+ * sdb_store_ge_matcher, sdb_store_gt_matcher:
+ * Creates a matcher based on a conditional. The matcher matches objects for
+ * which the conditional evaluates the object to compare less than, less or
+ * equal, equal, greater or equal, or greater than the conditional's value
+ * repsectively.
  */
 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_lt_matcher(sdb_store_cond_t *cond);
+sdb_store_matcher_t *
+sdb_store_le_matcher(sdb_store_cond_t *cond);
+sdb_store_matcher_t *
+sdb_store_eq_matcher(sdb_store_cond_t *cond);
+sdb_store_matcher_t *
+sdb_store_ge_matcher(sdb_store_cond_t *cond);
+sdb_store_matcher_t *
+sdb_store_gt_matcher(sdb_store_cond_t *cond);
 
 /*
  * sdb_store_matcher_parse_cmp:
@@ -195,6 +237,13 @@ sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
 sdb_store_matcher_t *
 sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
 
+/*
+ * sdb_store_con_matcher::
+ * Creates a matcher matching the inverse (logical NOT) of a matcher.
+ */
+sdb_store_matcher_t *
+sdb_store_inv_matcher(sdb_store_matcher_t *m);
+
 /*
  * sdb_store_matcher_matches:
  * Check whether the specified matcher matches the specified store object.
@@ -206,6 +255,14 @@ sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
 int
 sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_base_t *obj);
 
+/*
+ * sdb_store_matcher_tostring:
+ * Format a matcher object as string. This is meant for logging or debugging
+ * purposes.
+ */
+char *
+sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen);
+
 /*
  * sdb_store_lookup_cb:
  * Lookup callback. It is called for each matching object when looking up data