DP: Add callback for backward compatibility

Reviewed-by: Sumit Bose <sbose@redhat.com>
Reviewed-by: Jakub Hrozek <jhrozek@redhat.com>
Reviewed-by: Lukáš Slebodník <lslebodn@redhat.com>

4 files changed, 148 insertions, 0 deletions

diff --git a/Makefile.am b/Makefile.am
index 88eabd1b1..d7446b089 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1318,6 +1318,7 @@ sssd_be_SOURCES = \
     src/providers/data_provider/dp_request.c \
     src/providers/data_provider/dp_request_reply.c \
     src/providers/data_provider/dp_request_table.c \
+    src/providers/data_provider/dp_reply_std.c \
     $(SSSD_FAILOVER_OBJ)
 sssd_be_LDADD = \
     $(LIBADD_DL) \
diff --git a/src/providers/data_provider.h b/src/providers/data_provider.h
index 7332b677d..f52295ae4 100644
--- a/src/providers/data_provider.h
+++ b/src/providers/data_provider.h
@@ -115,6 +115,7 @@
  * @}
  */ /* end of group pamHandler */
 
+#define DP_ERR_DECIDE -1
 #define DP_ERR_OK 0
 #define DP_ERR_OFFLINE 1
 #define DP_ERR_TIMEOUT 2
diff --git a/src/providers/data_provider/dp_custom_data.h b/src/providers/data_provider/dp_custom_data.h
index 4c03dc93a..298f91de4 100644
--- a/src/providers/data_provider/dp_custom_data.h
+++ b/src/providers/data_provider/dp_custom_data.h
@@ -27,6 +27,21 @@
 
 /* Reply private data. */
 
+struct dp_reply_std {
+    int dp_error;
+    int error;
+    const char *message;
+};
+
+void dp_reply_std_set(struct dp_reply_std *reply,
+                      int dp_error,
+                      int error,
+                      const char *msg);
+
 /* Reply callbacks. */
 
+void dp_req_reply_std(const char *request_name,
+                      struct sbus_request *sbus_req,
+                      struct dp_reply_std *reply);
+
 #endif /* _DP_CUSTOM_DATA_H_ */
diff --git a/src/providers/data_provider/dp_reply_std.c b/src/providers/data_provider/dp_reply_std.c
new file mode 100644
index 000000000..fc576151e
--- /dev/null
+++ b/src/providers/data_provider/dp_reply_std.c
@@ -0,0 +1,131 @@
+/*
+    Authors:
+        Pavel Březina <pbrezina@redhat.com>
+
+    Copyright (C) 2016 Red Hat
+
+    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; either version 3 of the License, or
+    (at your option) any later version.
+
+    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, see <http://www.gnu.org/licenses/>.
+*/
+
+#include <tevent.h>
+
+#include "sbus/sssd_dbus.h"
+#include "providers/data_provider/dp_private.h"
+#include "providers/backend.h"
+#include "util/sss_utf8.h"
+#include "util/util.h"
+
+static const char *dp_err_to_string(int dp_err_type)
+{
+    switch (dp_err_type) {
+    case DP_ERR_OK:
+        return "Success";
+    case DP_ERR_OFFLINE:
+        return "Provider is Offline";
+    case DP_ERR_TIMEOUT:
+        return "Request timed out";
+    case DP_ERR_FATAL:
+        return "Internal Error";
+    default:
+        break;
+    }
+
+    return "Unknown Error";
+}
+
+static const char *safe_be_req_err_msg(const char *msg_in,
+                                       int dp_err_type)
+{
+    bool ok;
+
+    if (msg_in == NULL) {
+        /* No custom error, just use default */
+        return dp_err_to_string(dp_err_type);
+    }
+
+    ok = sss_utf8_check((const uint8_t *) msg_in,
+                        strlen(msg_in));
+    if (!ok) {
+        DEBUG(SSSDBG_MINOR_FAILURE,
+              "Back end message [%s] contains invalid non-UTF8 character, " \
+              "using default\n", msg_in);
+        return dp_err_to_string(dp_err_type);
+    }
+
+    return msg_in;
+}
+
+void dp_req_reply_std(const char *request_name,
+                      struct sbus_request *sbus_req,
+                      struct dp_reply_std *reply)
+{
+    const char *safe_err_msg;
+
+    safe_err_msg = safe_be_req_err_msg(reply->message, reply->dp_error);
+
+    DP_REQ_DEBUG(SSSDBG_TRACE_LIBS, request_name, "Returning [%s]: %d,%d,%s",
+                 dp_err_to_string(reply->dp_error), reply->dp_error,
+                 reply->error, reply->message);
+
+    sbus_request_return_and_finish(sbus_req,
+                                   DBUS_TYPE_UINT16, &reply->dp_error,
+                                   DBUS_TYPE_UINT32, &reply->error,
+                                   DBUS_TYPE_STRING, &safe_err_msg,
+                                   DBUS_TYPE_INVALID);
+}
+
+void dp_reply_std_set(struct dp_reply_std *reply,
+                      int dp_error,
+                      int error,
+                      const char *msg)
+{
+    const char *def_msg;
+
+    if (dp_error == DP_ERR_DECIDE) {
+        switch (error) {
+        case EOK:
+            dp_error = DP_ERR_OK;
+            break;
+        case ERR_OFFLINE:
+            dp_error = DP_ERR_OFFLINE;
+            break;
+        case ETIMEDOUT:
+            dp_error = DP_ERR_TIMEOUT;
+            break;
+        default:
+            dp_error = DP_ERR_FATAL;
+            break;
+        }
+    }
+
+    switch (dp_error) {
+    case DP_ERR_OK:
+        def_msg = "Success";
+        break;
+    case DP_ERR_OFFLINE:
+        def_msg = "Offline";
+        break;
+    default:
+        def_msg = sss_strerror(error);
+        break;
+    }
+
+    if (dp_error == DP_ERR_OK && error != EOK) {
+        DEBUG(SSSDBG_MINOR_FAILURE, "DP Error is OK on failed request?\n");
+    }
+
+    reply->dp_error = dp_error;
+    reply->error = error;
+    reply->message = msg == NULL ? def_msg : msg;
+}