public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Chang, Abner via groups.io" <abner.chang=amd.com@groups.io>
To: <devel@edk2.groups.io>
Cc: Nickle Wang <nicklew@nvidia.com>, Igor Kulchytskyy <igork@ami.com>
Subject: [edk2-devel] [edk2-redfish-client][PATCH 3/3] RedfishClientPkg/ConverterLib: Function to remove Redfish unchangeable properties
Date: Fri, 12 Jan 2024 11:26:22 +0800	[thread overview]
Message-ID: <20240112032622.274-3-abner.chang@amd.com> (raw)
In-Reply-To: <20240112032622.274-1-abner.chang@amd.com>

From: Abner Chang <abner.chang@amd.com>

Update RedfishCsCommon.c to add a function to remove Redfish
unchangeable properties.

Signed-off-by: Abner Chang <abner.chang@amd.com>
Cc: Nickle Wang <nicklew@nvidia.com>
Cc: Igor Kulchytskyy <igork@ami.com>
---
 .../ConverterLib/include/RedfishCsCommon.h    | 20 +++++++
 .../ConverterLib/src/RedfishCsCommon.c        | 55 +++++++++++++++++++
 2 files changed, 75 insertions(+)

diff --git a/RedfishClientPkg/ConverterLib/include/RedfishCsCommon.h b/RedfishClientPkg/ConverterLib/include/RedfishCsCommon.h
index e454ab0b73..f5278015aa 100644
--- a/RedfishClientPkg/ConverterLib/include/RedfishCsCommon.h
+++ b/RedfishClientPkg/ConverterLib/include/RedfishCsCommon.h
@@ -104,6 +104,26 @@ DestoryCsMemory (
   RedfishCS_void  *rootCs
   );
 
+/**
+  This function removes the unchangeable Redfish properties from JSON raw text
+  The content in JsonString is left unmodified, the caller has to give enoungh
+  memory pointed by NewJsonBuffer in the size of BufferSize.
+
+  JsonString     Input JSON raw string
+  NewJsonBuffer  Pointer to memory for the updated JSON raw string in
+                 size of BuufferSize.
+  BuufferSize    The buffer size of NewJsonBuffer
+
+  Return RedfishCS_status.
+
+**/
+RedfishCS_status
+RemoveUnchangeableProperties (
+   RedfishCS_char   *JsonString,
+   RedfishCS_char   *NewJsonBuffer,
+   RedfishCS_uint32  BuufferSize
+   );
+
 typedef struct _RedfishCS_char_Array          RedfishCS_char_Array;
 typedef struct _RedfishCS_int64_Array         RedfishCS_int64_Array;
 typedef struct _RedfishCS_bool_Array          RedfishCS_bool_Array;
diff --git a/RedfishClientPkg/ConverterLib/src/RedfishCsCommon.c b/RedfishClientPkg/ConverterLib/src/RedfishCsCommon.c
index fd31e5296b..c6996d7d5d 100644
--- a/RedfishClientPkg/ConverterLib/src/RedfishCsCommon.c
+++ b/RedfishClientPkg/ConverterLib/src/RedfishCsCommon.c
@@ -1461,3 +1461,58 @@ CsEmptyPropLinkToJson (
 
   return RedfishCS_status_success;
 }
+
+/**
+  This function removes the unchangeable Redfish properties from JSON raw text
+  The content in JsonString is left unmodified, the caller has to give enoungh
+  memory pointed by NewJsonBuffer in the size of BufferSize.
+
+  JsonString     Input JSON raw string
+  NewJsonBuffer  Pointer to memory for the updated JSON raw string in
+                 size of BuufferSize.
+  BuufferSize    The buffer size of NewJsonBuffer
+
+  Return RedfishCS_status.
+
+**/
+RedfishCS_status
+RemoveUnchangeableProperties (
+   RedfishCS_char   *JsonString,
+   RedfishCS_char   *NewJsonBuffer,
+   RedfishCS_uint32  BuufferSize
+   )
+{
+  json_t            *JsonObj;
+  RedfishCS_char    *TempChar;
+  RedfishCS_status  Status;
+
+  if ((JsonString == NULL) || (NewJsonBuffer == NULL)) {
+    return RedfishCS_status_invalid_parameter;
+  }
+
+  JsonObj = json_loads (JsonString, 0, NULL);
+  if (JsonObj == NULL) {
+    return RedfishCS_status_unknown_error;
+  }
+
+  json_object_del (JsonObj, "@odata.type");
+  json_object_del (JsonObj, "@odata.id");
+  json_object_del (JsonObj, "Id");
+  json_object_del (JsonObj, "Name");
+
+  TempChar = json_dumps ((json_t *)JsonObj, JSON_INDENT (2));
+  if (TempChar != NULL) {
+    if ((strlen (TempChar) + 1) > BuufferSize) {
+      Status = RedfishCS_status_insufficient_memory;
+    } else {
+      memcpy (NewJsonBuffer, TempChar, strlen (TempChar) + 1);
+      free (TempChar);
+      Status = RedfishCS_status_success;
+    }
+  } else {
+    Status = RedfishCS_status_unknown_error;
+  }
+  json_decref(JsonObj);
+  return Status;
+}
+
-- 
2.37.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#113649): https://edk2.groups.io/g/devel/message/113649
Mute This Topic: https://groups.io/mt/103676920/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



  parent reply	other threads:[~2024-01-12  3:27 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-12  3:26 [edk2-devel] [edk2-redfish-client][PATCH 1/3] RedfishClientPkg/jansson: Define json_object_del Chang, Abner via groups.io
2024-01-12  3:26 ` [edk2-devel] [edk2-redfish-client][PATCH 2/3] RedfishClientPkg/RedfishFeatureUtilityLib: Add two helper functions Chang, Abner via groups.io
2024-01-16  3:14   ` Nickle Wang via groups.io
2024-01-12  3:26 ` Chang, Abner via groups.io [this message]
2024-01-16  3:17   ` [edk2-devel] [edk2-redfish-client][PATCH 3/3] RedfishClientPkg/ConverterLib: Function to remove Redfish unchangeable properties Nickle Wang via groups.io
2024-01-16  4:08     ` Chang, Abner via groups.io
2024-01-16  6:20       ` Nickle Wang via groups.io
2024-01-16  8:31         ` Chang, Abner via groups.io
2024-01-16  3:07 ` [edk2-devel] [edk2-redfish-client][PATCH 1/3] RedfishClientPkg/jansson: Define json_object_del Nickle Wang via groups.io

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240112032622.274-3-abner.chang@amd.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox