add a API method for getting the escrow status

not yet working!

8 files changed, 273 insertions, 5 deletions

diff --git a/src/escrow/escrow.h b/src/escrow/escrow.h
index 3c5bb68c8..b9128f5a4 100644
--- a/src/escrow/escrow.h
+++ b/src/escrow/escrow.h
@@ -154,7 +154,14 @@ struct ESCROW_PluginOperationWrapper
  */
 struct ESCROW_Plugin_AnchorContinuationWrapper
 {
+  /**
+   * Handle for the escrow component
+   */
   struct GNUNET_ESCROW_Handle *h;
+
+  /**
+   * The escrow anchor
+   */
   struct GNUNET_ESCROW_Anchor *escrowAnchor;
 };
 
@@ -166,7 +173,14 @@ struct ESCROW_Plugin_AnchorContinuationWrapper
  */
 struct ESCROW_Plugin_EgoContinuationWrapper
 {
+  /**
+   * Handle for the escrow component
+   */
   struct GNUNET_ESCROW_Handle *h;
+
+  /**
+   * The restored ego
+   */
   const struct GNUNET_IDENTITY_Ego *ego;
 };
 
@@ -178,7 +192,14 @@ struct ESCROW_Plugin_EgoContinuationWrapper
  */
 struct ESCROW_Plugin_VerifyContinuationWrapper
 {
+  /**
+   * Handle for the escrow component
+   */
   struct GNUNET_ESCROW_Handle *h;
+
+  /**
+   * The result of the verification
+   */
   int verificationResult;
 };
 
diff --git a/src/escrow/escrow_api.c b/src/escrow/escrow_api.c
index 5b57f9244..446833758 100644
--- a/src/escrow/escrow_api.c
+++ b/src/escrow/escrow_api.c
@@ -350,6 +350,31 @@ GNUNET_ESCROW_verify (struct GNUNET_ESCROW_Handle *h,
 
 
 /**
+ * Get the status of an escrow, i.e.
+ *   -> when the last escrow was
+ *   -> when the next escrow is recommended
+ * 
+ * @param h the handle for the escrow component
+ * @param ego the identity ego of which the escrow status has to be determined
+ * @param escrowAnchor the escrow anchor returned by the GNUNET_ESCROW_put method
+ * @param method the escrow method to use
+ * 
+ * @return the status of the escrow packed into a GNUNET_ESCROW_Status struct
+ */
+struct GNUNET_ESCROW_Status *
+GNUNET_ESCROW_get_status (struct GNUNET_ESCROW_Handle *h,
+                          const struct GNUNET_IDENTITY_Ego *ego,
+                          struct GNUNET_ESCROW_Anchor *escrowAnchor,
+                          enum GNUNET_ESCROW_Key_Escrow_Method method)
+{
+  const struct GNUNET_ESCROW_KeyPluginFunctions *api;
+
+  api = init_plugin (h, method);
+  return api->get_status (h, ego, escrowAnchor);
+}
+
+
+/**
  * Deserialize an escrow anchor string (e.g. from command line) into a
  * GNUNET_ESCROW_Anchor struct
  * 
diff --git a/src/escrow/gnunet-escrow.c b/src/escrow/gnunet-escrow.c
index 268815ce5..1974c4b2c 100644
--- a/src/escrow/gnunet-escrow.c
+++ b/src/escrow/gnunet-escrow.c
@@ -66,6 +66,11 @@ static char *verify_ego;
 static char *get_ego;
 
 /**
+ * -s option
+ */
+static char *status_ego;
+
+/**
  * The ego
  */
 const struct GNUNET_IDENTITY_Ego *ego;
@@ -101,6 +106,11 @@ static struct GNUNET_ESCROW_Handle *escrow_handle;
 static struct GNUNET_ESCROW_Operation *escrow_op;
 
 /**
+ * Escrow status
+ */
+static struct GNUNET_ESCROW_Status *escrow_status;
+
+/**
  * Handle to the identity service
  */
 static struct GNUNET_IDENTITY_Handle *identity_handle;
@@ -128,6 +138,21 @@ do_cleanup (void *cls)
     GNUNET_free (escrow_op);
     escrow_op = NULL;
   }
+  if (NULL != method_name)
+  {
+    GNUNET_free (method_name);
+    method_name = NULL;
+  }
+  if (NULL != anchor_string)
+  {
+    GNUNET_free (anchor_string);
+    anchor_string = NULL;
+  }
+  if (NULL != anchor)
+  {
+    GNUNET_free (anchor);
+    anchor = NULL;
+  }
   if (NULL != put_ego)
   {
     GNUNET_free (put_ego);
@@ -143,6 +168,16 @@ do_cleanup (void *cls)
     GNUNET_free (get_ego);
     get_ego = NULL;
   }
+  if (NULL != status_ego)
+  {
+    GNUNET_free (status_ego);
+    status_ego = NULL;
+  }
+  if (NULL != escrow_status)
+  {
+    GNUNET_free (escrow_status);
+    escrow_status = NULL;
+  }
   if (NULL != ego)
   {
     /* does not have to be freed, as this is done when
@@ -256,6 +291,26 @@ start_process ()
                                    &get_cb);
     return;
   }
+  /* status */
+  if (NULL != status_ego)
+  {
+    if (NULL == ego)
+    {
+      fprintf (stderr, "Ego %s not found\n", status_ego);
+      cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
+      return;
+    }
+    escrow_status = GNUNET_ESCROW_get_status (escrow_handle,
+                                              ego,
+                                              anchor,
+                                              method);
+    // TODO: formatting/interpretation
+    fprintf (stdout, "Last escrow:\t\t\t%s\nNext recommended escrow:\t%s\n",
+             GNUNET_STRINGS_absolute_time_to_string (escrow_status->last_escrow_time),
+             GNUNET_STRINGS_absolute_time_to_string (escrow_status->next_recommended_escrow_time));
+    cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
+    return;
+  }
 }
 
 
@@ -304,10 +359,10 @@ run (void *cls,
 
   if (NULL != put_ego)
   {
-    if (NULL != verify_ego || NULL != get_ego)
+    if (NULL != verify_ego || NULL != get_ego || NULL != status_ego)
     {
       ret = 1;
-      fprintf (stderr, _ ("-P may only be used without -V or -G!\n"));
+      fprintf (stderr, _ ("-P may only be used without -V, -G or -S!\n"));
       return;
     }
     /* put */
@@ -315,10 +370,10 @@ run (void *cls,
   }
   else if (NULL != verify_ego)
   {
-    if (NULL != get_ego)
+    if (NULL != get_ego || NULL != status_ego)
     {
       ret = 1;
-      fprintf (stderr, _ ("-V may only be used without -P or -G!\n"));
+      fprintf (stderr, _ ("-V may only be used without -P, -G or -S!\n"));
       return;
     }
     /* verify */
@@ -332,6 +387,12 @@ run (void *cls,
   }
   else if (NULL != get_ego)
   {
+    if (NULL != status_ego)
+    {
+      ret = 1;
+      fprintf (stderr, _ ("-G may only be used without -P, -V or -S!\n"));
+      return;
+    }
     /* get */
     if (NULL == anchor_string)
     {
@@ -341,11 +402,22 @@ run (void *cls,
     }
     ego_name = get_ego;
   }
+  else if (NULL != status_ego)
+  {
+    /* status */
+    if (NULL == anchor_string)
+    {
+      ret = 1;
+      fprintf (stderr, _ ("-a is needed for -S!\n"));
+      return;
+    }
+    ego_name = status_ego;
+  }
   else
   {
     /* nothing */
     ret = 1;
-    fprintf (stderr, _ ("-P, -V or -G option must be specified!\n"));
+    fprintf (stderr, _ ("-P, -V, -G or -S option must be specified!\n"));
     return;
   }
 
@@ -397,6 +469,11 @@ main (int argc, char *const argv[])
                                  "NAME",
                                  gettext_noop ("Get the ego NAME back from escrow"),
                                  &get_ego),
+    GNUNET_GETOPT_option_string ('S',
+                                 "status",
+                                 "NAME",
+                                 gettext_noop ("Get the status of the escrow of ego NAME"),
+                                 &status_ego),
     GNUNET_GETOPT_option_string ('a',
                                  "anchor",
                                  "ANCHOR",
diff --git a/src/escrow/plugin_escrow_anastasis.c b/src/escrow/plugin_escrow_anastasis.c
index 165fdda23..a66410099 100644
--- a/src/escrow/plugin_escrow_anastasis.c
+++ b/src/escrow/plugin_escrow_anastasis.c
@@ -125,6 +125,32 @@ restore_anastasis_key_escrow (struct GNUNET_ESCROW_Handle *h,
 
 
 /**
+ * Get the status of a Anastasis escrow
+ * 
+ * @param h the handle for the escrow component
+ * @param ego the identity ego of which the status has to be obtained
+ * @param escrowAnchor the escrow anchor needed to restore the key
+ * 
+ * @return the status of the escrow packed into a GNUNET_ESCROW_Status struct
+ */
+struct GNUNET_ESCROW_Status *
+anastasis_get_status (struct GNUNET_ESCROW_Handle *h,
+                      const struct GNUNET_IDENTITY_Ego *ego,
+                      struct GNUNET_ESCROW_Anchor *escrowAnchor)
+{
+  struct GNUNET_ESCROW_Status *status;
+  
+  status = GNUNET_new (struct GNUNET_ESCROW_Status);
+  // TODO: get the correct time values
+  status->last_escrow_time = GNUNET_TIME_absolute_get ();
+  status->next_recommended_escrow_time = GNUNET_TIME_absolute_get ();
+  // END TODO
+  
+  return status;
+}
+
+
+/**
  * Deserialize an escrow anchor string into a GNUNET_ESCROW_Anchor struct
  * 
  * @param anchorString the encoded escrow anchor string
@@ -206,6 +232,7 @@ libgnunet_plugin_escrow_anastasis_init (void *cls)
   api->start_key_escrow = &start_anastasis_key_escrow;
   api->verify_key_escrow = &verify_anastasis_key_escrow;
   api->restore_key = &restore_anastasis_key_escrow;
+  api->get_status = &anastasis_get_status;
   api->anchor_string_to_data = &anastasis_anchor_string_to_data;
   api->cancel_plugin_operation = &cancel_anastasis_operation;
 
diff --git a/src/escrow/plugin_escrow_gns.c b/src/escrow/plugin_escrow_gns.c
index 45c16366b..618591393 100644
--- a/src/escrow/plugin_escrow_gns.c
+++ b/src/escrow/plugin_escrow_gns.c
@@ -224,6 +224,32 @@ restore_gns_key_escrow (struct GNUNET_ESCROW_Handle *h,
 
 
 /**
+ * Get the status of a GNS escrow
+ * 
+ * @param h the handle for the escrow component
+ * @param ego the identity ego of which the status has to be obtained
+ * @param escrowAnchor the escrow anchor needed to restore the key
+ * 
+ * @return the status of the escrow packed into a GNUNET_ESCROW_Status struct
+ */
+struct GNUNET_ESCROW_Status *
+gns_get_status (struct GNUNET_ESCROW_Handle *h,
+                const struct GNUNET_IDENTITY_Ego *ego,
+                struct GNUNET_ESCROW_Anchor *escrowAnchor)
+{
+  struct GNUNET_ESCROW_Status *status;
+  
+  status = GNUNET_new (struct GNUNET_ESCROW_Status);
+  // TODO: get the correct time values
+  status->last_escrow_time = GNUNET_TIME_absolute_get ();
+  status->next_recommended_escrow_time = GNUNET_TIME_absolute_get ();
+  // END TODO
+  
+  return status;
+}
+
+
+/**
  * Deserialize an escrow anchor string into a GNUNET_ESCROW_Anchor struct
  * 
  * @param anchorString the encoded escrow anchor string
@@ -305,6 +331,7 @@ libgnunet_plugin_escrow_gns_init (void *cls)
   api->start_key_escrow = &start_gns_key_escrow;
   api->verify_key_escrow = &verify_gns_key_escrow;
   api->restore_key = &restore_gns_key_escrow;
+  api->get_status = &gns_get_status;
   api->anchor_string_to_data = &gns_anchor_string_to_data;
   api->cancel_plugin_operation = &cancel_gns_operation;
 
diff --git a/src/escrow/plugin_escrow_plaintext.c b/src/escrow/plugin_escrow_plaintext.c
index b6de718e4..7d0fb24fb 100644
--- a/src/escrow/plugin_escrow_plaintext.c
+++ b/src/escrow/plugin_escrow_plaintext.c
@@ -331,6 +331,32 @@ restore_plaintext_key_escrow (struct GNUNET_ESCROW_Handle *h,
 
 
 /**
+ * Get the status of a plaintext escrow
+ * 
+ * @param h the handle for the escrow component
+ * @param ego the identity ego of which the status has to be obtained
+ * @param escrowAnchor the escrow anchor needed to restore the key
+ * 
+ * @return the status of the escrow packed into a GNUNET_ESCROW_Status struct
+ */
+struct GNUNET_ESCROW_Status *
+plaintext_get_status (struct GNUNET_ESCROW_Handle *h,
+                      const struct GNUNET_IDENTITY_Ego *ego,
+                      struct GNUNET_ESCROW_Anchor *escrowAnchor)
+{
+  struct GNUNET_ESCROW_Status *status;
+  
+  status = GNUNET_new (struct GNUNET_ESCROW_Status);
+  // TODO: get the correct time values
+  status->last_escrow_time = GNUNET_TIME_absolute_get ();
+  status->next_recommended_escrow_time = GNUNET_TIME_absolute_get ();
+  // END TODO
+  
+  return status;
+}
+
+
+/**
  * Deserialize an escrow anchor string into a GNUNET_ESCROW_Anchor struct
  * 
  * @param h the handle for the escrow component
@@ -434,6 +460,7 @@ libgnunet_plugin_escrow_plaintext_init (void *cls)
   api->start_key_escrow = &start_plaintext_key_escrow;
   api->verify_key_escrow = &verify_plaintext_key_escrow;
   api->restore_key = &restore_plaintext_key_escrow;
+  api->get_status = &plaintext_get_status;
   api->anchor_string_to_data = &plaintext_anchor_string_to_data;
   api->anchor_data_to_string = &plaintext_anchor_data_to_string;
   api->cancel_plugin_operation = &cancel_plaintext_operation;
diff --git a/src/include/gnunet_escrow_lib.h b/src/include/gnunet_escrow_lib.h
index 564c457b9..112f0afdb 100644
--- a/src/include/gnunet_escrow_lib.h
+++ b/src/include/gnunet_escrow_lib.h
@@ -77,6 +77,22 @@ struct GNUNET_ESCROW_Anchor {
 
 
 /**
+ * Struct for the escrow status
+ */
+struct GNUNET_ESCROW_Status {
+  /**
+   * The time of the last successful escrow.
+   */
+  struct GNUNET_TIME_Absolute last_escrow_time;
+
+  /**
+   * The time of the next recommended escrow.
+   */
+  struct GNUNET_TIME_Absolute next_recommended_escrow_time;
+};
+
+
+/**
  * Function called after the initialization of the identity service.
  * Passed via cls to the callback of GNUNET_IDENTITY_connect
  */
@@ -284,6 +300,26 @@ GNUNET_ESCROW_verify (
 
 
 /**
+ * Get the status of an escrow, i.e.
+ *   -> when the last escrow was
+ *   -> when the next escrow is recommended
+ * 
+ * @param h the handle for the escrow component
+ * @param ego the identity ego of which the escrow status has to be determined
+ * @param escrowAnchor the escrow anchor returned by the GNUNET_ESCROW_put method
+ * @param method the escrow method to use
+ * 
+ * @return the status of the escrow packed into a GNUNET_ESCROW_Status struct
+ */
+struct GNUNET_ESCROW_Status *
+GNUNET_ESCROW_get_status (
+  struct GNUNET_ESCROW_Handle *h,
+  const struct GNUNET_IDENTITY_Ego *ego,
+  struct GNUNET_ESCROW_Anchor *escrowAnchor,
+  enum GNUNET_ESCROW_Key_Escrow_Method method);
+
+
+/**
  * Deserialize an escrow anchor string (e.g. from command line) into a
  * GNUNET_ESCROW_Anchor struct
  * 
diff --git a/src/include/gnunet_escrow_plugin.h b/src/include/gnunet_escrow_plugin.h
index 3cd461663..449921a8e 100644
--- a/src/include/gnunet_escrow_plugin.h
+++ b/src/include/gnunet_escrow_plugin.h
@@ -50,6 +50,8 @@ extern "C" {
  * @param h the handle for the escrow component
  * @param ego the identity ego containing the private key
  * @param cb the function called upon completion
+ * 
+ * @return a wrapper for the plugin operation
  */
 typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_StartKeyEscrowFunction) (
   struct GNUNET_ESCROW_Handle *h,
@@ -63,6 +65,8 @@ typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_StartKeyEscrowFunc
  * @param ego the identity ego containing the private key
  * @param escrowAnchor the escrow anchor needed to restore the key
  * @param cb the function called upon completion
+ * 
+ * @return a wrapper for the plugin operation
  */
 typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_VerifyKeyEscrowFunction) (
   struct GNUNET_ESCROW_Handle *h,
@@ -77,6 +81,8 @@ typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_VerifyKeyEscrowFun
  * @param escrowAnchor the escrow anchor needed to restore the key
  * @param egoName the name of the ego to restore
  * @param cb the function called upon completion
+ * 
+ * @return a wrapper for the plugin operation
  */
 typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_RestoreKeyFunction) (
   struct GNUNET_ESCROW_Handle *h,
@@ -86,6 +92,23 @@ typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_RestoreKeyFunction
 
 
 /**
+ * Function called to get the status of an escrow, i.e.
+ *   -> when the last successful escrow was
+ *   -> when the next recommended escrow is
+ * 
+ * @param h the handle for the escrow component
+ * @param ego the identity ego of which the status has to be obtained
+ * @param escrowAnchor the escrow anchor needed to restore the key
+ * 
+ * @return the status of the escrow packed into a GNUNET_ESCROW_Status struct
+ */
+typedef struct GNUNET_ESCROW_Status *(*GNUNET_ESCROW_GetEscrowStatusFunction) (
+  struct GNUNET_ESCROW_Handle *h,
+  const struct GNUNET_IDENTITY_Ego *ego,
+  struct GNUNET_ESCROW_Anchor *escrowAnchor);
+
+
+/**
  * Function called to deserialize an escrow anchor string into a
  * GNUNET_ESCROW_Anchor struct
  * 
@@ -148,6 +171,11 @@ struct GNUNET_ESCROW_KeyPluginFunctions
   GNUNET_ESCROW_RestoreKeyFunction restore_key;
 
   /**
+   * Get the status of an escrow
+   */
+  GNUNET_ESCROW_GetEscrowStatusFunction get_status;
+
+  /**
    * Deserialize anchor string to data
    */
   GNUNET_ESCROW_AnchorStringToDataFunction anchor_string_to_data;