mirror of
https://dev.iopsys.eu/feed/iopsys.git
synced 2025-12-10 07:44:50 +01:00
obuspa: Add bulkdata csv report format support
This commit is contained in:
suvendhu
parent
44c6d5e7e6
commit
28e8fda73b
2 changed files with 674 additions and 1 deletions
|
|
@ -5,7 +5,7 @@
|
||||||
include $(TOPDIR)/rules.mk
|
include $(TOPDIR)/rules.mk
|
||||||
|
|
||||||
PKG_NAME:=obuspa
|
PKG_NAME:=obuspa
|
||||||
PKG_VERSION:=7.0.0.8
|
PKG_VERSION:=7.0.0.9
|
||||||
|
|
||||||
LOCAL_DEV:=0
|
LOCAL_DEV:=0
|
||||||
ifneq ($(LOCAL_DEV),1)
|
ifneq ($(LOCAL_DEV),1)
|
||||||
|
|
|
||||||
673
obuspa/patches/0007-bdc_csv_format.patch
Normal file
673
obuspa/patches/0007-bdc_csv_format.patch
Normal file
|
|
@ -0,0 +1,673 @@
|
||||||
|
diff --git a/src/core/bdc_exec.c b/src/core/bdc_exec.c
|
||||||
|
index 3670361..6a6325d 100644
|
||||||
|
--- a/src/core/bdc_exec.c
|
||||||
|
+++ b/src/core/bdc_exec.c
|
||||||
|
@@ -547,11 +547,19 @@ int StartSendingReport(bdc_connection_t *bc)
|
||||||
|
|
||||||
|
// Set the list of headers
|
||||||
|
bc->headers = NULL;
|
||||||
|
- bc->headers = curl_slist_append(bc->headers, "Content-Type: application/json; charset=UTF-8");
|
||||||
|
- if (bc->flags & BDC_FLAG_HEADER_OBJ_HIER)
|
||||||
|
+ if (bc->flags & BDC_FLAG_HEADER_OBJ_HIER) {
|
||||||
|
+ bc->headers = curl_slist_append(bc->headers, "Content-Type: application/json; charset=UTF-8");
|
||||||
|
bc->headers = curl_slist_append(bc->headers, "BBF-Report-Format: ObjectHierarchy");
|
||||||
|
- else
|
||||||
|
+ } else if (bc->flags & BDC_FLAG_HEADER_NAME_VAL) {
|
||||||
|
+ bc->headers = curl_slist_append(bc->headers, "Content-Type: application/json; charset=UTF-8");
|
||||||
|
bc->headers = curl_slist_append(bc->headers, "BBF-Report-Format: NameValuePair");
|
||||||
|
+ } else if (bc->flags & BDC_FLAG_HEADER_PER_COL) {
|
||||||
|
+ bc->headers = curl_slist_append(bc->headers, "Content-Type: text/csv; charset=UTF-8");
|
||||||
|
+ bc->headers = curl_slist_append(bc->headers, "BBF-Report-Format: ParameterPerColumn");
|
||||||
|
+ } else {
|
||||||
|
+ bc->headers = curl_slist_append(bc->headers, "Content-Type: text/csv; charset=UTF-8");
|
||||||
|
+ bc->headers = curl_slist_append(bc->headers, "BBF-Report-Format: ParameterPerRow");
|
||||||
|
+ }
|
||||||
|
|
||||||
|
if (bc->flags & BDC_FLAG_GZIP)
|
||||||
|
{
|
||||||
|
diff --git a/src/core/bdc_exec.h b/src/core/bdc_exec.h
|
||||||
|
index ff37a2d..ee29c85 100644
|
||||||
|
--- a/src/core/bdc_exec.h
|
||||||
|
+++ b/src/core/bdc_exec.h
|
||||||
|
@@ -53,6 +53,9 @@ void BDC_EXEC_ScheduleExit(void);
|
||||||
|
#define BDC_FLAG_PUT 0x00000001 // If set, HTTP PUT should be used instead of HTTP POST when sending the report to the BDC server
|
||||||
|
#define BDC_FLAG_GZIP 0x00000002 // If set, the reports contants are Gzipped
|
||||||
|
#define BDC_FLAG_DATE_HEADER 0x00000004 // If set, the date header should be included in the HTTP post.
|
||||||
|
-#define BDC_FLAG_HEADER_OBJ_HIER 0x00000008 // If set, report format in header would be ObjectHierarchy otherwise NameValuePair
|
||||||
|
+#define BDC_FLAG_HEADER_OBJ_HIER 0x00000008 // If set, report format in header would be json ObjectHierarchy
|
||||||
|
+#define BDC_FLAG_HEADER_NAME_VAL 0x00000010 // If set, report format in header would be json NameValuePair
|
||||||
|
+#define BDC_FLAG_HEADER_PER_ROW 0x00000020 // If set, report format in header would be csv ParameterPerRow
|
||||||
|
+#define BDC_FLAG_HEADER_PER_COL 0x00000040 // If set, report format in header would be csv ParameterPerColumn
|
||||||
|
|
||||||
|
#endif
|
||||||
|
diff --git a/src/core/device_bulkdata.c b/src/core/device_bulkdata.c
|
||||||
|
index a7d1b3e..fab9731 100755
|
||||||
|
--- a/src/core/device_bulkdata.c
|
||||||
|
+++ b/src/core/device_bulkdata.c
|
||||||
|
@@ -67,9 +67,12 @@
|
||||||
|
|
||||||
|
//------------------------------------------------------------------------------
|
||||||
|
// Definitions for formats that we support
|
||||||
|
-#define BULKDATA_ENCODING_TYPE "JSON"
|
||||||
|
+#define BULKDATA_ENCODING_TYPE_JSON "JSON"
|
||||||
|
+#define BULKDATA_ENCODING_TYPE_CSV "CSV"
|
||||||
|
#define BULKDATA_JSON_REPORT_FORMAT_NAME_VALUE "NameValuePair"
|
||||||
|
#define BULKDATA_JSON_REPORT_FORMAT_OBJ_HIER "ObjectHierarchy"
|
||||||
|
+#define BULKDATA_CSV_REPORT_FORMAT_PER_COLUMN "ParameterPerColumn"
|
||||||
|
+#define BULKDATA_CSV_REPORT_FORMAT_PER_ROW "ParameterPerRow"
|
||||||
|
|
||||||
|
|
||||||
|
// Definitions for Device.BulkData.Profile.{i}.JSONEncoding.ReportTimestamp
|
||||||
|
@@ -153,6 +156,7 @@ static char *profile_push_event_args[] =
|
||||||
|
typedef struct
|
||||||
|
{
|
||||||
|
int num_retained_failed_reports;
|
||||||
|
+ char encoding_type[10];
|
||||||
|
char report_timestamp[33];
|
||||||
|
char url[1025];
|
||||||
|
char username[257];
|
||||||
|
@@ -161,6 +165,11 @@ typedef struct
|
||||||
|
char method[9];
|
||||||
|
bool use_date_header;
|
||||||
|
char report_format[20];
|
||||||
|
+ char field_separator[10];
|
||||||
|
+ char row_separator[10];
|
||||||
|
+ char escape_char[10];
|
||||||
|
+ char csv_format[20];
|
||||||
|
+ char row_timestamp[33];
|
||||||
|
} profile_ctrl_params_t;
|
||||||
|
|
||||||
|
//------------------------------------------------------------------------------
|
||||||
|
@@ -208,6 +217,7 @@ int Validate_BulkDataEncodingType(dm_req_t *req, char *value);
|
||||||
|
int Validate_BulkDataReportingInterval(dm_req_t *req, char *value);
|
||||||
|
int Validate_BulkDataReference(dm_req_t *req, char *value);
|
||||||
|
int Validate_BulkDataReportFormat(dm_req_t *req, char *value);
|
||||||
|
+int Validate_BulkDataCSVReportFormat(dm_req_t *req, char *value);
|
||||||
|
int Validate_BulkDataReportTimestamp(dm_req_t *req, char *value);
|
||||||
|
int Validate_BulkDataCompression(dm_req_t *req, char *value);
|
||||||
|
int Validate_BulkDataHTTPMethod(dm_req_t *req, char *value);
|
||||||
|
@@ -236,6 +246,8 @@ bulkdata_profile_t *bulkdata_find_profile(int profile_id);
|
||||||
|
int bulkdata_calc_report_map(bulkdata_profile_t *bp, kv_vector_t *report_map);
|
||||||
|
int bulkdata_reduce_to_alt_name(char *spec, char *path, char *alt_name, char *out_buf, int buf_len);
|
||||||
|
char *bulkdata_generate_json_report(bulkdata_profile_t *bp, char *report_timestamp, char *report_format);
|
||||||
|
+char *bulkdata_generate_csv_report(bulkdata_profile_t *bp, char *field_separator, char *row_separator,
|
||||||
|
+ char *escape_char, char *csv_format, char *row_timestamp);
|
||||||
|
unsigned char *bulkdata_compress_report(profile_ctrl_params_t *ctrl, char *input_buf, int input_len, int *p_output_len);
|
||||||
|
int bulkdata_schedule_sending_http_report(profile_ctrl_params_t *ctrl, bulkdata_profile_t *bp, unsigned char *json_report, int report_len);
|
||||||
|
int bulkdata_start_profile(bulkdata_profile_t *bp);
|
||||||
|
@@ -250,6 +262,7 @@ char *bulkdata_platform_calc_uri_query_string(kv_vector_t *escaped_map);
|
||||||
|
int bulkdata_platform_get_param_refs(int profile_id, param_ref_vector_t *param_refs);
|
||||||
|
void bulkdata_expand_param_ref(param_ref_entry_t *pr, group_get_vector_t *ggv);
|
||||||
|
void bulkdata_append_to_result_map(param_ref_entry_t *pr, group_get_vector_t *ggv, kv_vector_t *report_map);
|
||||||
|
+void append_string_to_target(char *str, char **output);
|
||||||
|
|
||||||
|
/*********************************************************************//**
|
||||||
|
**
|
||||||
|
@@ -282,7 +295,7 @@ int DEVICE_BULKDATA_Init(void)
|
||||||
|
err |= USP_REGISTER_VendorParam_ReadOnly("Device.BulkData.Status", Get_BulkDataGlobalStatus, DM_STRING);
|
||||||
|
err |= USP_REGISTER_Param_Constant("Device.BulkData.MinReportingInterval", BULKDATA_MINIMUM_REPORTING_INTERVAL_STR, DM_UINT);
|
||||||
|
err |= USP_REGISTER_Param_SupportedList("Device.BulkData.Protocols", bdc_protocols, NUM_ELEM(bdc_protocols));
|
||||||
|
- err |= USP_REGISTER_Param_Constant("Device.BulkData.EncodingTypes", BULKDATA_ENCODING_TYPE, DM_STRING);
|
||||||
|
+ err |= USP_REGISTER_Param_Constant("Device.BulkData.EncodingTypes", "CSV,JSON", DM_STRING);
|
||||||
|
err |= USP_REGISTER_Param_Constant("Device.BulkData.ParameterWildCardSupported", "true", DM_BOOL);
|
||||||
|
err |= USP_REGISTER_Param_Constant("Device.BulkData.MaxNumberOfProfiles", BULKDATA_MAX_PROFILES_STR, DM_INT);
|
||||||
|
err |= USP_REGISTER_Param_Constant("Device.BulkData.MaxNumberOfParameterReferences", "-1", DM_INT);
|
||||||
|
@@ -297,7 +310,7 @@ int DEVICE_BULKDATA_Init(void)
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.Name", "", NULL, NULL, DM_STRING);
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.NumberOfRetainedFailedReports", "0", Validate_NumberOfRetainedFailedReports, NULL, DM_INT);
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.Protocol", BULKDATA_PROTOCOL_HTTP, Validate_BulkDataProtocol, NULL, DM_STRING);
|
||||||
|
- err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.EncodingType", BULKDATA_ENCODING_TYPE, Validate_BulkDataEncodingType, NULL, DM_STRING);
|
||||||
|
+ err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.EncodingType", BULKDATA_ENCODING_TYPE_JSON, Validate_BulkDataEncodingType, NULL, DM_STRING);
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.ReportingInterval", "86400", Validate_BulkDataReportingInterval, NotifyChange_BulkDataReportingInterval, DM_UINT);
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.TimeReference", UNKNOWN_TIME_STR, NULL, NotifyChange_BulkDataTimeReference, DM_DATETIME);
|
||||||
|
|
||||||
|
@@ -312,6 +325,13 @@ int DEVICE_BULKDATA_Init(void)
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.JSONEncoding.ReportFormat", BULKDATA_JSON_REPORT_FORMAT_NAME_VALUE, Validate_BulkDataReportFormat, NULL, DM_STRING);
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.JSONEncoding.ReportTimestamp", BULKDATA_JSON_TIMESTAMP_FORMAT_EPOCH, Validate_BulkDataReportTimestamp, NULL, DM_STRING);
|
||||||
|
|
||||||
|
+ // Device.BulkData.Profile.{i}.CSVEncoding
|
||||||
|
+ err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.CSVEncoding.FieldSeparator", ",", NULL, NULL, DM_STRING);
|
||||||
|
+ err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.CSVEncoding.RowSeparator", " ", NULL, NULL, DM_STRING);
|
||||||
|
+ err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.CSVEncoding.EscapeCharacter", """, NULL, NULL, DM_STRING);
|
||||||
|
+ err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.CSVEncoding.ReportFormat", BULKDATA_CSV_REPORT_FORMAT_PER_COLUMN, Validate_BulkDataCSVReportFormat, NULL, DM_STRING);
|
||||||
|
+ err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.CSVEncoding.RowTimestamp", BULKDATA_JSON_TIMESTAMP_FORMAT_EPOCH, Validate_BulkDataReportTimestamp, NULL, DM_STRING);
|
||||||
|
+
|
||||||
|
// Device.BulkData.Profile.{i}.HTTP
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.HTTP.URL", "", NULL, NotifyChange_BulkDataURL, DM_STRING);
|
||||||
|
err |= USP_REGISTER_DBParam_ReadWrite("Device.BulkData.Profile.{i}.HTTP.Username", "", NULL, NULL, DM_STRING);
|
||||||
|
@@ -591,9 +611,10 @@ int Validate_BulkDataProtocol(dm_req_t *req, char *value)
|
||||||
|
int Validate_BulkDataEncodingType(dm_req_t *req, char *value)
|
||||||
|
{
|
||||||
|
// Exit if trying to set a value outside of the range we accept
|
||||||
|
- if (strcmp(value, BULKDATA_ENCODING_TYPE) != 0)
|
||||||
|
+ if (strcmp(value, BULKDATA_ENCODING_TYPE_JSON) != 0 && strcmp(value, BULKDATA_ENCODING_TYPE_CSV) != 0)
|
||||||
|
{
|
||||||
|
- USP_ERR_SetMessage("%s: Only EncodingType supported is '%s'", __FUNCTION__, BULKDATA_ENCODING_TYPE);
|
||||||
|
+ USP_ERR_SetMessage("%s: Only EncodingType supported are '%s,%s'", __FUNCTION__,
|
||||||
|
+ BULKDATA_ENCODING_TYPE_JSON, BULKDATA_ENCODING_TYPE_CSV);
|
||||||
|
return USP_ERR_INVALID_VALUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
@@ -674,6 +695,32 @@ int Validate_BulkDataReportFormat(dm_req_t *req, char *value)
|
||||||
|
return USP_ERR_OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
+/*********************************************************************//**
|
||||||
|
+**
|
||||||
|
+** Validate_BulkDataCSVReportFormat
|
||||||
|
+**
|
||||||
|
+** Validates Device.BulkData.Profile.{i}.CSVEncoding.ReportFormat
|
||||||
|
+**
|
||||||
|
+** \param req - pointer to structure identifying the parameter
|
||||||
|
+** \param value - value that the controller would like to set the parameter to
|
||||||
|
+**
|
||||||
|
+** \return USP_ERR_OK if successful
|
||||||
|
+**
|
||||||
|
+**************************************************************************/
|
||||||
|
+int Validate_BulkDataCSVReportFormat(dm_req_t *req, char *value)
|
||||||
|
+{
|
||||||
|
+ // Exit if trying to set a value outside of the range we accept
|
||||||
|
+ if (strcmp(value, BULKDATA_CSV_REPORT_FORMAT_PER_COLUMN) != 0 &&
|
||||||
|
+ strcmp(value, BULKDATA_CSV_REPORT_FORMAT_PER_ROW) != 0)
|
||||||
|
+ {
|
||||||
|
+ USP_ERR_SetMessage("%s: Only JSON Report Format supported are '%s', '%s'", __FUNCTION__,
|
||||||
|
+ BULKDATA_CSV_REPORT_FORMAT_PER_COLUMN, BULKDATA_CSV_REPORT_FORMAT_PER_ROW);
|
||||||
|
+ return USP_ERR_INVALID_VALUE;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ return USP_ERR_OK;
|
||||||
|
+}
|
||||||
|
+
|
||||||
|
/*********************************************************************//**
|
||||||
|
**
|
||||||
|
** Validate_BulkDataReportTimestamp
|
||||||
|
@@ -1970,6 +2017,14 @@ int bulkdata_platform_get_profile_control_params(bulkdata_profile_t *bp, profile
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
+ // Exit if unable to get EncodingType
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.EncodingType", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, ctrl_params->encoding_type, sizeof(ctrl_params->encoding_type), 0);
|
||||||
|
+ if (err != USP_ERR_OK)
|
||||||
|
+ {
|
||||||
|
+ return err;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
// Exit if unable to get ReportTimestamp
|
||||||
|
USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.JSONEncoding.ReportTimestamp", bp->profile_id);
|
||||||
|
err = DATA_MODEL_GetParameterValue(path, ctrl_params->report_timestamp, sizeof(ctrl_params->report_timestamp), 0);
|
||||||
|
@@ -1986,6 +2041,46 @@ int bulkdata_platform_get_profile_control_params(bulkdata_profile_t *bp, profile
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
+ // Exit if unable to get FieldSeparator
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.FieldSeparator", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, ctrl_params->field_separator, sizeof(ctrl_params->field_separator), 0);
|
||||||
|
+ if (err != USP_ERR_OK)
|
||||||
|
+ {
|
||||||
|
+ return err;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get RowSeparator
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.RowSeparator", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, ctrl_params->row_separator, sizeof(ctrl_params->row_separator), 0);
|
||||||
|
+ if (err != USP_ERR_OK)
|
||||||
|
+ {
|
||||||
|
+ return err;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get EscapeCharacter
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.EscapeCharacter", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, ctrl_params->escape_char, sizeof(ctrl_params->escape_char), 0);
|
||||||
|
+ if (err != USP_ERR_OK)
|
||||||
|
+ {
|
||||||
|
+ return err;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get ReportFormat
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.ReportFormat", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, ctrl_params->csv_format, sizeof(ctrl_params->csv_format), 0);
|
||||||
|
+ if (err != USP_ERR_OK)
|
||||||
|
+ {
|
||||||
|
+ return err;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get RowTimestamp
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.RowTimestamp", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, ctrl_params->row_timestamp, sizeof(ctrl_params->row_timestamp), 0);
|
||||||
|
+ if (err != USP_ERR_OK)
|
||||||
|
+ {
|
||||||
|
+ return err;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
return USP_ERR_OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
@@ -2222,7 +2317,7 @@ void bulkdata_process_profile_http(bulkdata_profile_t *bp)
|
||||||
|
{
|
||||||
|
int err;
|
||||||
|
report_t *cur_report;
|
||||||
|
- char *json_report;
|
||||||
|
+ char *report;
|
||||||
|
profile_ctrl_params_t ctrl;
|
||||||
|
unsigned char *compressed_report;
|
||||||
|
int compressed_len;
|
||||||
|
@@ -2261,10 +2356,23 @@ void bulkdata_process_profile_http(bulkdata_profile_t *bp)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exit if unable to generate the report
|
||||||
|
- json_report = bulkdata_generate_json_report(bp, ctrl.report_timestamp, ctrl.report_format);
|
||||||
|
- if (json_report == NULL)
|
||||||
|
- {
|
||||||
|
- USP_ERR_SetMessage("%s: bulkdata_generate_json_report failed", __FUNCTION__);
|
||||||
|
+ if (strcmp(ctrl.encoding_type, BULKDATA_ENCODING_TYPE_JSON) == 0) {
|
||||||
|
+ report = bulkdata_generate_json_report(bp, ctrl.report_timestamp, ctrl.report_format);
|
||||||
|
+ if (report == NULL)
|
||||||
|
+ {
|
||||||
|
+ USP_ERR_SetMessage("%s: bulkdata_generate_json_report failed", __FUNCTION__);
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+ } else if (strcmp(ctrl.encoding_type, BULKDATA_ENCODING_TYPE_CSV) == 0) {
|
||||||
|
+ report = bulkdata_generate_csv_report(bp, ctrl.field_separator, ctrl.row_separator, ctrl.escape_char,
|
||||||
|
+ ctrl.csv_format, ctrl.row_timestamp);
|
||||||
|
+ if (report == NULL)
|
||||||
|
+ {
|
||||||
|
+ USP_ERR_SetMessage("%s: bulkdata_generate_csv_report failed", __FUNCTION__);
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+ } else {
|
||||||
|
+ USP_ERR_SetMessage("%s: bulkdata invalid report encoding type %s", __FUNCTION__, ctrl.encoding_type);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
@@ -2273,14 +2381,14 @@ void bulkdata_process_profile_http(bulkdata_profile_t *bp)
|
||||||
|
USP_LOG_Info("BULK DATA: using compression method=%s", ctrl.compression);
|
||||||
|
if (enable_protocol_trace)
|
||||||
|
{
|
||||||
|
- USP_LOG_String(kLogLevel_Info, kLogType_Protocol, json_report);
|
||||||
|
+ USP_LOG_String(kLogLevel_Info, kLogType_Protocol, report);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compress the report, if enabled
|
||||||
|
- compressed_report = bulkdata_compress_report(&ctrl, json_report, strlen(json_report), &compressed_len);
|
||||||
|
- if (compressed_report != (unsigned char *)json_report)
|
||||||
|
+ compressed_report = bulkdata_compress_report(&ctrl, report, strlen(report), &compressed_len);
|
||||||
|
+ if (compressed_report != (unsigned char *)report)
|
||||||
|
{
|
||||||
|
- free(json_report);
|
||||||
|
+ free(report);
|
||||||
|
}
|
||||||
|
// NOTE: From this point on, only the compressed_report exists
|
||||||
|
|
||||||
|
@@ -2310,9 +2418,15 @@ void bulkdata_process_profile_usp_event(bulkdata_profile_t *bp)
|
||||||
|
kv_vector_t event_args;
|
||||||
|
kv_pair_t kv;
|
||||||
|
report_t *cur_report;
|
||||||
|
- char *json_report;
|
||||||
|
+ char *report;
|
||||||
|
+ char encoding_type[10] = {0};
|
||||||
|
char report_timestamp[33] = {0};
|
||||||
|
char report_format[20] = {0};
|
||||||
|
+ char field_separator[10];
|
||||||
|
+ char row_separator[10];
|
||||||
|
+ char escape_char[10];
|
||||||
|
+ char csv_format[20];
|
||||||
|
+ char row_timestamp[33];
|
||||||
|
|
||||||
|
// Exit if the MTP has not been connected to successfully after bootup
|
||||||
|
// This is to prevent BDC events being enqueued before the Boot! event is sent (the Boot! event is only sent after successfully connecting to the MTP).
|
||||||
|
@@ -2321,20 +2435,62 @@ void bulkdata_process_profile_usp_event(bulkdata_profile_t *bp)
|
||||||
|
goto exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
- // Exit if unable to get ReportTimestamp
|
||||||
|
- USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.JSONEncoding.ReportTimestamp", bp->profile_id);
|
||||||
|
- err = DATA_MODEL_GetParameterValue(path, report_timestamp, sizeof(report_timestamp), 0);
|
||||||
|
- if (err != USP_ERR_OK)
|
||||||
|
- {
|
||||||
|
+ // Exit if unable to get EncodingType
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.EncodingType", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, encoding_type, sizeof(encoding_type), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
- // Exit if unable to get ReportFormat
|
||||||
|
- USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.JSONEncoding.ReportFormat", bp->profile_id);
|
||||||
|
- err = DATA_MODEL_GetParameterValue(path, report_format, sizeof(report_format), 0);
|
||||||
|
- if (err != USP_ERR_OK)
|
||||||
|
- {
|
||||||
|
- return;
|
||||||
|
+ if (strcmp(encoding_type, BULKDATA_ENCODING_TYPE_JSON) == 0) {
|
||||||
|
+ // Exit if unable to get ReportTimestamp
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.JSONEncoding.ReportTimestamp", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, report_timestamp, sizeof(report_timestamp), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get ReportFormat
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.JSONEncoding.ReportFormat", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, report_format, sizeof(report_format), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+ } else {
|
||||||
|
+ // Exit if unable to get FieldSeparator
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.FieldSeparator", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, field_separator, sizeof(field_separator), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get RowSeparator
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.RowSeparator", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, row_separator, sizeof(row_separator), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get EscapeCharacter
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.EscapeCharacter", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, escape_char, sizeof(escape_char), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get ReportFormat
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.ReportFormat", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, csv_format, sizeof(csv_format), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Exit if unable to get RowTimestamp
|
||||||
|
+ USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.CSVEncoding.RowTimestamp", bp->profile_id);
|
||||||
|
+ err = DATA_MODEL_GetParameterValue(path, row_timestamp, sizeof(row_timestamp), 0);
|
||||||
|
+ if (err != USP_ERR_OK) {
|
||||||
|
+ return;
|
||||||
|
+ }
|
||||||
|
}
|
||||||
|
|
||||||
|
// When sending via USP events, only one report is ever sent in each USP event
|
||||||
|
@@ -2354,10 +2510,16 @@ void bulkdata_process_profile_usp_event(bulkdata_profile_t *bp)
|
||||||
|
bp->num_retained_reports = 1;
|
||||||
|
|
||||||
|
// Exit if unable to generate the report
|
||||||
|
- json_report = bulkdata_generate_json_report(bp, report_timestamp, report_format);
|
||||||
|
- if (json_report == NULL)
|
||||||
|
+ if (strcmp(encoding_type, BULKDATA_ENCODING_TYPE_JSON) == 0) {
|
||||||
|
+ report = bulkdata_generate_json_report(bp, report_timestamp, report_format);
|
||||||
|
+ } else {
|
||||||
|
+ report = bulkdata_generate_csv_report(bp, field_separator, row_separator, escape_char,
|
||||||
|
+ csv_format, row_timestamp);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ if (report == NULL)
|
||||||
|
{
|
||||||
|
- USP_ERR_SetMessage("%s: bulkdata_generate_json_report failed", __FUNCTION__);
|
||||||
|
+ USP_ERR_SetMessage("%s: bulkdata failed to generate report", __FUNCTION__);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
@@ -2365,15 +2527,15 @@ void bulkdata_process_profile_usp_event(bulkdata_profile_t *bp)
|
||||||
|
|
||||||
|
// Construct event_args manually to avoid the overhead of a malloc and copy of the report in KV_VECTOR_Add()
|
||||||
|
kv.key = "Data";
|
||||||
|
- kv.value = json_report;
|
||||||
|
+ kv.value = report;
|
||||||
|
event_args.vector = &kv;
|
||||||
|
event_args.num_entries = 1;
|
||||||
|
|
||||||
|
USP_SNPRINTF(path, sizeof(path), "Device.BulkData.Profile.%d.Push!", bp->profile_id);
|
||||||
|
DEVICE_SUBSCRIPTION_ProcessAllEventCompleteSubscriptions(path, &event_args);
|
||||||
|
|
||||||
|
- // Free the report. No need to free the event_args as json_report is the only thing dynamically allocated in it
|
||||||
|
- free(json_report); // The report is not allocated via USP_MALLOC
|
||||||
|
+ // Free the report. No need to free the event_args as report is the only thing dynamically allocated in it
|
||||||
|
+ free(report); // The report is not allocated via USP_MALLOC
|
||||||
|
|
||||||
|
// From the point of view of this code, the report(s) have been successfully sent, so don't retain them
|
||||||
|
// NOTE: Sending of the reports successfully is delegated to the USP notification retry mechanism
|
||||||
|
@@ -2833,6 +2995,219 @@ char *bulkdata_generate_json_report(bulkdata_profile_t *bp, char *report_timesta
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
+/*********************************************************************//**
|
||||||
|
+**
|
||||||
|
+** append_string_to_target
|
||||||
|
+**
|
||||||
|
+** concatenates the src string with target string in newly allocated memory
|
||||||
|
+** and assign back the new pointer.
|
||||||
|
+**
|
||||||
|
+** \param str - pointer to the src string
|
||||||
|
+** \param output - address of the pointer that points to the target string
|
||||||
|
+**
|
||||||
|
+** \return None
|
||||||
|
+**
|
||||||
|
+**************************************************************************/
|
||||||
|
+void append_string_to_target(char *str, char **output)
|
||||||
|
+{
|
||||||
|
+ char *tmp = NULL;
|
||||||
|
+
|
||||||
|
+ if (str == NULL || strlen(str) == 0)
|
||||||
|
+ return;
|
||||||
|
+
|
||||||
|
+ if (*output == NULL || strlen(*output) == 0) {
|
||||||
|
+ *output = USP_STRDUP(str);
|
||||||
|
+ return;
|
||||||
|
+ } else {
|
||||||
|
+ tmp = USP_STRDUP(*output);
|
||||||
|
+ free(*output);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ assert(tmp != NULL);
|
||||||
|
+ asprintf(output, "%s%s", tmp, str);
|
||||||
|
+ free(tmp);
|
||||||
|
+}
|
||||||
|
+
|
||||||
|
+/*********************************************************************//**
|
||||||
|
+**
|
||||||
|
+** bulkdata_generate_csv_report
|
||||||
|
+**
|
||||||
|
+** Generates a CSV ParameterPerRow or ParameterPerColumn format report
|
||||||
|
+** NOTE: The report contains all retained failed reports, as well as the current report
|
||||||
|
+** See TR-157 section A.4.2 (end) for an example, and section A.3.5.2 for layout of content containing failed report transmissions
|
||||||
|
+**
|
||||||
|
+** \param bp - pointer to bulk data profile containing all reports (current and retained)
|
||||||
|
+** \param field_separator - value of Device.Bulkdata.Profile.{i}.CSVEncoding.FieldSeparator
|
||||||
|
+** \param row_separator - value of Device.Bulkdata.Profile.{i}.CSVEncoding.RowSeparator
|
||||||
|
+** \param escape_char - value of Device.Bulkdata.Profile.{i}.CSVEncoding.EscapeCharacter
|
||||||
|
+** \param csv_format - value of Device.BulkData.Profile.{i}.CSVEncoding.ReportFormat
|
||||||
|
+** \param row_timestamp - value of Device.Bulkdata.Profile.{i}.CSVEncoding.RowTimestamp
|
||||||
|
+**
|
||||||
|
+** \return pointer to NULL terminated dynamically allocated buffer containing the serialized report to send
|
||||||
|
+**
|
||||||
|
+**************************************************************************/
|
||||||
|
+char *bulkdata_generate_csv_report(bulkdata_profile_t *bp, char *field_separator, char *row_separator,
|
||||||
|
+ char *escape_char, char *csv_format, char *row_timestamp)
|
||||||
|
+{
|
||||||
|
+ char *param_path;
|
||||||
|
+ char *param_type_value;
|
||||||
|
+ char param_type;
|
||||||
|
+ char *param_value;
|
||||||
|
+ kv_vector_t *report_map;
|
||||||
|
+ report_t *report;
|
||||||
|
+ int i, j;
|
||||||
|
+ bool value_as_bool;
|
||||||
|
+ char buf[32];
|
||||||
|
+ kv_pair_t *kv;
|
||||||
|
+ int err;
|
||||||
|
+ char *output = NULL, *str = NULL, *str1 = NULL, *str2 = NULL, rowseparator = '\0', separator = '\0';
|
||||||
|
+
|
||||||
|
+ if (strcmp(row_separator, " ") == 0)
|
||||||
|
+ rowseparator = '\n';
|
||||||
|
+ else if (strcmp(row_separator, " ") == 0)
|
||||||
|
+ rowseparator = '\r';
|
||||||
|
+
|
||||||
|
+ if (field_separator)
|
||||||
|
+ separator = field_separator[0];
|
||||||
|
+
|
||||||
|
+ if (strcasecmp(csv_format, "ParameterPerRow") == 0) {
|
||||||
|
+ if (strcmp(row_timestamp, "None") == 0)
|
||||||
|
+ asprintf(&str, "ParameterName%cParameterValue%cParameterType%c", separator, separator, rowseparator);
|
||||||
|
+ else
|
||||||
|
+ asprintf(&str, "ReportTimestamp%cParameterName%cParameterValue%cParameterType%c", separator, separator, separator, rowseparator);
|
||||||
|
+
|
||||||
|
+ assert(str != NULL);
|
||||||
|
+ append_string_to_target(str, &output);
|
||||||
|
+ free(str);
|
||||||
|
+ str = NULL;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ for (i=0; i < bp->num_retained_reports; i++)
|
||||||
|
+ {
|
||||||
|
+ char *timestamp = NULL;
|
||||||
|
+ report = &bp->reports[i];
|
||||||
|
+ report_map = &report->report_map;
|
||||||
|
+
|
||||||
|
+ // Add Collection time to each csv report element (only if specified and not 'None')
|
||||||
|
+ if (strcmp(row_timestamp, "Unix-Epoch")==0)
|
||||||
|
+ {
|
||||||
|
+ asprintf(×tamp, "%lld", (long long int)report->collection_time);
|
||||||
|
+ }
|
||||||
|
+ else if (strcmp(row_timestamp, "ISO-8601")==0)
|
||||||
|
+ {
|
||||||
|
+ char *result = iso8601_from_unix_time(report->collection_time, buf, sizeof(buf));
|
||||||
|
+ if (result != NULL)
|
||||||
|
+ {
|
||||||
|
+ asprintf(×tamp, "%s", buf);
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ if (strcasecmp(csv_format, "ParameterPerColumn") == 0 && timestamp) {
|
||||||
|
+ append_string_to_target("ReportTimestamp", &str1);
|
||||||
|
+ append_string_to_target(timestamp, &str2);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ // Iterate over each parameter, adding it to the json element. Take account of the parameter's type
|
||||||
|
+ for (j=0; j < report_map->num_entries; j++)
|
||||||
|
+ {
|
||||||
|
+ kv = &report_map->vector[j];
|
||||||
|
+ param_path = kv->key;
|
||||||
|
+ param_type_value = kv->value;
|
||||||
|
+ param_type = param_type_value[0]; // First character denotes the type of the parameter
|
||||||
|
+ param_value = ¶m_type_value[1]; // Subsequent characters contain the parameter's valu
|
||||||
|
+ char *type = NULL;
|
||||||
|
+ switch (param_type)
|
||||||
|
+ {
|
||||||
|
+ case 'S':
|
||||||
|
+ type = "string";
|
||||||
|
+ break;
|
||||||
|
+
|
||||||
|
+ case 'U':
|
||||||
|
+ type = "unsignedInt";
|
||||||
|
+ break;
|
||||||
|
+
|
||||||
|
+ case 'L':
|
||||||
|
+ type = "long";
|
||||||
|
+ break;
|
||||||
|
+
|
||||||
|
+ case 'N':
|
||||||
|
+ type = "decimal";
|
||||||
|
+ break;
|
||||||
|
+
|
||||||
|
+ case 'B':
|
||||||
|
+ err = TEXT_UTILS_StringToBool(param_value, &value_as_bool);
|
||||||
|
+ if (err == USP_ERR_OK)
|
||||||
|
+ {
|
||||||
|
+ type = "boolean";
|
||||||
|
+ param_value = value_as_bool ? "True" : "False";
|
||||||
|
+ }
|
||||||
|
+ break;
|
||||||
|
+
|
||||||
|
+ default:
|
||||||
|
+ USP_ERR_SetMessage("%s: Invalid JSON parameter type ('%c') in report map for %s", __FUNCTION__, param_type_value[0], param_path);
|
||||||
|
+ break;
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ if (type) {
|
||||||
|
+ if (strcasecmp(csv_format, "ParameterPerRow") == 0) {
|
||||||
|
+ if (timestamp == NULL)
|
||||||
|
+ asprintf(&str, "%s%c%s%c%s%c", param_path, separator, param_value, separator, type, rowseparator);
|
||||||
|
+ else
|
||||||
|
+ asprintf(&str, "%s%c%s%c%s%c%s%c", timestamp, separator, param_path, separator, param_value, separator, type, rowseparator);
|
||||||
|
+
|
||||||
|
+ assert(str != NULL);
|
||||||
|
+ append_string_to_target(str, &output);
|
||||||
|
+ free(str);
|
||||||
|
+ str = NULL;
|
||||||
|
+ } else {
|
||||||
|
+ if (str1 == NULL || strlen(str1) == 0)
|
||||||
|
+ asprintf(&str, "%s", param_path);
|
||||||
|
+ else
|
||||||
|
+ asprintf(&str, "%c%s", separator, param_path);
|
||||||
|
+
|
||||||
|
+ assert(str != NULL);
|
||||||
|
+ append_string_to_target(str, &str1);
|
||||||
|
+ free(str);
|
||||||
|
+ str = NULL;
|
||||||
|
+
|
||||||
|
+ if (str2 == NULL || strlen(str2) == 0)
|
||||||
|
+ asprintf(&str, "%s", param_value);
|
||||||
|
+ else
|
||||||
|
+ asprintf(&str, "%c%s", separator, param_value);
|
||||||
|
+
|
||||||
|
+ assert(str != NULL);
|
||||||
|
+ append_string_to_target(str, &str2);
|
||||||
|
+ free(str);
|
||||||
|
+ str = NULL;
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ if (timestamp) {
|
||||||
|
+ free(timestamp);
|
||||||
|
+ timestamp = NULL;
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ if (strcasecmp(csv_format, "ParameterPerColumn") == 0) {
|
||||||
|
+ asprintf(&str, "%c", rowseparator);
|
||||||
|
+ assert(str != NULL);
|
||||||
|
+ append_string_to_target(str, &str1);
|
||||||
|
+ append_string_to_target(str, &str2);
|
||||||
|
+ append_string_to_target(str1, &output);
|
||||||
|
+ append_string_to_target(str2, &output);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ if (str)
|
||||||
|
+ free(str);
|
||||||
|
+ if (str1)
|
||||||
|
+ free(str1);
|
||||||
|
+ if (str2)
|
||||||
|
+ free(str2);
|
||||||
|
+
|
||||||
|
+ return output;
|
||||||
|
+}
|
||||||
|
+
|
||||||
|
/*********************************************************************//**
|
||||||
|
**
|
||||||
|
** bulkdata_compress_report
|
||||||
|
@@ -2986,9 +3361,18 @@ int bulkdata_schedule_sending_http_report(profile_ctrl_params_t *ctrl, bulkdata_
|
||||||
|
flags |= BDC_FLAG_DATE_HEADER;
|
||||||
|
}
|
||||||
|
|
||||||
|
- if (strcmp(ctrl->report_format, BULKDATA_JSON_REPORT_FORMAT_OBJ_HIER) == 0)
|
||||||
|
- {
|
||||||
|
- flags |= BDC_FLAG_HEADER_OBJ_HIER;
|
||||||
|
+ if (strcmp(ctrl->encoding_type, BULKDATA_ENCODING_TYPE_JSON) == 0) {
|
||||||
|
+ if (strcmp(ctrl->report_format, BULKDATA_JSON_REPORT_FORMAT_OBJ_HIER) == 0) {
|
||||||
|
+ flags |= BDC_FLAG_HEADER_OBJ_HIER;
|
||||||
|
+ } else {
|
||||||
|
+ flags |= BDC_FLAG_HEADER_NAME_VAL;
|
||||||
|
+ }
|
||||||
|
+ } else {
|
||||||
|
+ if (strcmp(ctrl->csv_format, BULKDATA_CSV_REPORT_FORMAT_PER_COLUMN) == 0) {
|
||||||
|
+ flags |= BDC_FLAG_HEADER_PER_COL;
|
||||||
|
+ } else {
|
||||||
|
+ flags |= BDC_FLAG_HEADER_PER_ROW;
|
||||||
|
+ }
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exit if failed to post a message to BDC thread
|
||||||
Loading…
Add table
Reference in a new issue