[mirror_edk2.git] / RedfishPkg / PrivateLibrary / RedfishLib / RedfishLib.c

/** @file\r
  Provides a set of utility APIs that allow to create/read/update/delete\r
  (CRUD) Redfish resources and provide basic query.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "RedfishMisc.h"\r
\r
/**\r
  This function uses REST EX protocol provided in RedfishConfigServiceInfo.\r
  The service enumerator will also handle the authentication flow automatically\r
  if HTTP basic auth or Redfish session login is configured to use.\r
\r
  Callers are responsible for freeing the returned service by RedfishCleanupService().\r
\r
  @param[in]  RedfishConfigServiceInfo Redfish service information the EFI Redfish\r
                                       feature driver communicates with.\r
\r
  @return     New created Redfish Service, or NULL if error happens.\r
\r
**/\r
REDFISH_SERVICE\r
EFIAPI\r
RedfishCreateService (\r
  IN  REDFISH_CONFIG_SERVICE_INFORMATION  *RedfishConfigServiceInfo\r
  )\r
{\r
  REDFISH_SERVICE            RedfishService;\r
  EDKII_REDFISH_AUTH_METHOD  AuthMethod;\r
  CHAR8                      *UserId;\r
  CHAR8                      *Password;\r
  EFI_STATUS                 Status;\r
\r
  RedfishService = NULL;\r
  UserId         = NULL;\r
  Password       = NULL;\r
\r
  //\r
  // Check Input Parameters.\r
  //\r
  if (RedfishConfigServiceInfo == NULL) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Get Authentication Configuration.\r
  //\r
  Status = RedfishGetAuthInfo (&AuthMethod, &UserId, &Password);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Create a redfish service node based on Redfish network host interface.\r
  //\r
  RedfishService = RedfishCreateLibredfishService (\r
                     RedfishConfigServiceInfo,\r
                     AuthMethod,\r
                     UserId,\r
                     Password\r
                     );\r
\r
ON_EXIT:\r
  if (UserId != NULL) {\r
    FreePool (UserId);\r
  }\r
\r
  if (Password != NULL) {\r
    FreePool (Password);\r
  }\r
\r
  return RedfishService;\r
}\r
\r
/**\r
  Free the Service and all its related resources.\r
\r
  @param[in]    RedfishService     The Service to access the Redfish resources.\r
\r
**/\r
VOID\r
EFIAPI\r
RedfishCleanupService (\r
  IN REDFISH_SERVICE  RedfishService\r
  )\r
{\r
  if (RedfishService == NULL) {\r
    return;\r
  }\r
\r
  cleanupServiceEnumerator (RedfishService);\r
}\r
\r
/**\r
  Create REDFISH_PAYLOAD instance in local with JSON represented resource value and\r
  the Redfish Service.\r
\r
  The returned REDFISH_PAYLOAD can be used to create or update Redfish resource in\r
  server side.\r
\r
  Callers are responsible for freeing the returned payload by RedfishCleanupPayload().\r
\r
  @param[in]    Value                 JSON Value of the redfish resource.\r
  @param[in]    RedfishService        The Service to access the Redfish resources.\r
\r
  @return     REDFISH_PAYLOAD instance of the resource, or NULL if error happens.\r
\r
**/\r
REDFISH_PAYLOAD\r
EFIAPI\r
RedfishCreatePayload (\r
  IN EDKII_JSON_VALUE  Value,\r
  IN REDFISH_SERVICE   RedfishService\r
  )\r
{\r
  EDKII_JSON_VALUE  CopyValue;\r
\r
  CopyValue = JsonValueClone (Value);\r
  return createRedfishPayload (CopyValue, RedfishService);\r
}\r
\r
/**\r
  Free the RedfishPayload and all its related resources.\r
\r
  @param[in]    Payload        Payload to be freed.\r
\r
**/\r
VOID\r
EFIAPI\r
RedfishCleanupPayload (\r
  IN REDFISH_PAYLOAD  Payload\r
  )\r
{\r
  if (Payload == NULL) {\r
    return;\r
  }\r
\r
  cleanupPayload ((redfishPayload *)Payload);\r
}\r
\r
/**\r
  This function returns the decoded JSON value of a REDFISH_PAYLOAD.\r
\r
  Caller doesn't need to free the returned JSON value because it will be released\r
  in corresponding RedfishCleanupPayload() function.\r
\r
  @param[in]    Payload     A REDFISH_PAYLOAD instance.\r
\r
  @return     Decoded JSON value of the payload.\r
\r
**/\r
EDKII_JSON_VALUE\r
EFIAPI\r
RedfishJsonInPayload (\r
  IN REDFISH_PAYLOAD  Payload\r
  )\r
{\r
  if (Payload == NULL) {\r
    return NULL;\r
  }\r
\r
  return ((redfishPayload *)Payload)->json;\r
}\r
\r
/**\r
  Fill the input RedPath string with system UUID from SMBIOS table or use the customized\r
  ID if  FromSmbios == FALSE.\r
\r
  This is a helper function to build a RedPath string which can be used to address\r
  a Redfish resource for this computer system. The input PathString must have a Systems\r
  note in format of "Systems[UUID=%g]" or "Systems[UUID~%g]" to fill the UUID value.\r
\r
  Example:\r
    Use "/v1/Systems[UUID=%g]/Bios" to build a RedPath to address the "Bios" resource\r
    for this computer system.\r
\r
  @param[in]    RedPath        RedPath format to be build.\r
  @param[in]    FromSmbios     Get system UUID from SMBIOS as computer system instance ID.\r
  @param[in]    IdString       The computer system instance ID.\r
\r
  @return     Full RedPath with system UUID inside, or NULL if error happens.\r
\r
**/\r
CHAR8 *\r
EFIAPI\r
RedfishBuildPathWithSystemUuid (\r
  IN CONST CHAR8  *RedPath,\r
  IN BOOLEAN      FromSmbios,\r
  IN CHAR8        *IdString OPTIONAL\r
  )\r
{\r
  UINTN       BufSize;\r
  CHAR8       *RetRedPath;\r
  EFI_GUID    SystemUuid;\r
  EFI_STATUS  Status;\r
\r
  if (RedPath == NULL) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Find system UUID from SMBIOS table.\r
  //\r
  if (FromSmbios) {\r
    Status = NetLibGetSystemGuid (&SystemUuid);\r
    if (EFI_ERROR (Status)) {\r
      return NULL;\r
    }\r
\r
    // AsciiStrLen ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") = 36\r
    BufSize = AsciiStrSize (RedPath) + AsciiStrLen ("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");\r
  } else {\r
    BufSize = AsciiStrSize (RedPath) + AsciiStrLen (IdString);\r
  }\r
\r
  RetRedPath = AllocateZeroPool (BufSize);\r
  if (RetRedPath == NULL) {\r
    return NULL;\r
  }\r
\r
  if (FromSmbios) {\r
    AsciiSPrint (RetRedPath, BufSize, RedPath, &SystemUuid);\r
  } else {\r
    AsciiSPrint (RetRedPath, BufSize, RedPath, IdString);\r
  }\r
\r
  return RetRedPath;\r
}\r
\r
/**\r
  Get a redfish response addressed by a RedPath string, including HTTP StatusCode, Headers\r
  and Payload which record any HTTP response messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    RedfishService        The Service to access the Redfish resources.\r
  @param[in]    RedPath               RedPath string to address a resource, must start\r
                                      from the root node.\r
  @param[out]   RedResponse           Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX. The corresponding redfish resource has\r
                                  been returned in Payload within RedResponse.\r
  @retval EFI_INVALID_PARAMETER   RedfishService, RedPath, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned Payload is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is NULL, indicates any error happen.\r
                                  3. If the returned StatusCode is not 2XX, indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishGetByService (\r
  IN     REDFISH_SERVICE   RedfishService,\r
  IN     CONST CHAR8       *RedPath,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  if ((RedfishService == NULL) || (RedPath == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  RedResponse->Payload = (REDFISH_PAYLOAD)getPayloadByPath (RedfishService, RedPath, &(RedResponse->StatusCode));\r
\r
  //\r
  // 1. If the returned Payload is NULL, indicates any error happen.\r
  // 2. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if ((RedResponse->Payload == NULL) || (RedResponse->StatusCode == NULL)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // 3. If the returned StatusCode is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get a redfish response addressed by URI, including HTTP StatusCode, Headers\r
  and Payload which record any HTTP response messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    RedfishService    The Service to access the URI resources.\r
  @param[in]    Uri               String to address a resource.\r
  @param[out]   RedResponse       Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX. The corresponding redfish resource has\r
                                  been returned in Payload within RedResponse.\r
  @retval EFI_INVALID_PARAMETER   RedfishService, RedPath, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned Payload is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is NULL, indicates any error happen.\r
                                  3. If the returned StatusCode is not 2XX, indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishGetByUri (\r
  IN     REDFISH_SERVICE   RedfishService,\r
  IN     CONST CHAR8       *Uri,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  EDKII_JSON_VALUE  JsonValue;\r
\r
  if ((RedfishService == NULL) || (Uri == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  JsonValue            = getUriFromService (RedfishService, Uri, &RedResponse->StatusCode);\r
  RedResponse->Payload = createRedfishPayload (JsonValue, RedfishService);\r
\r
  //\r
  // 1. If the returned Payload is NULL, indicates any error happen.\r
  // 2. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if ((RedResponse->Payload == NULL) || (RedResponse->StatusCode == NULL)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // 3. If the returned StatusCode is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get a redfish response addressed by the input Payload and relative RedPath string,\r
  including HTTP StatusCode, Headers and Payload which record any HTTP response messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    Payload           A existing REDFISH_PAYLOAD instance.\r
  @param[in]    RedPath           Relative RedPath string to address a resource inside Payload.\r
  @param[out]   RedResponse       Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful:\r
                                  1. The HTTP StatusCode is NULL and the returned Payload in\r
                                  RedResponse is not NULL, indicates the Redfish resource has\r
                                  been parsed from the input payload directly.\r
                                  2. The HTTP StatusCode is not NULL and the value is 2XX,\r
                                  indicates the corresponding redfish resource has been returned\r
                                  in Payload within RedResponse.\r
  @retval EFI_INVALID_PARAMETER   Payload, RedPath, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned Payload is NULL, indicates any error happen.\r
                                  2. If StatusCode is not NULL and the returned value of StatusCode\r
                                     is not 2XX, indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishGetByPayload (\r
  IN     REDFISH_PAYLOAD   Payload,\r
  IN     CONST CHAR8       *RedPath,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  if ((Payload == NULL) || (RedPath == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  RedResponse->Payload = (REDFISH_PAYLOAD)getPayloadForPathString (Payload, RedPath, &(RedResponse->StatusCode));\r
\r
  //\r
  // 1. If the returned Payload is NULL, indicates any error happen.\r
  //\r
  if (RedResponse->Payload == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // 2. If StatusCode is not NULL and the returned value of StatusCode is not 2XX, indicates any\r
  //    error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((RedResponse->StatusCode != NULL) && \\r
      ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
       (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT)\r
      ))\r
  {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Use HTTP PATCH to perform updates on pre-existing Redfish resource.\r
\r
  This function uses the RedfishService to patch a Redfish resource addressed by\r
  Uri (only the relative path is required). Changes to one or more properties within\r
  the target resource are represented in the input Content, properties not specified\r
  in Content won't be changed by this request. The corresponding redfish response will\r
  returned, including HTTP StatusCode, Headers and Payload which record any HTTP response\r
  messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    RedfishService        The Service to access the Redfish resources.\r
  @param[in]    Uri                   Relative path to address the resource.\r
  @param[in]    Content               JSON represented properties to be update.\r
  @param[out]   RedResponse           Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX. The Redfish resource will be returned\r
                                  in Payload within RedResponse if server send it back in the HTTP\r
                                  response message body.\r
  @retval EFI_INVALID_PARAMETER   RedfishService, Uri, Content, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned StatusCode is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is not NULL and the value is not 2XX,\r
                                     indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishPatchToUri (\r
  IN     REDFISH_SERVICE   RedfishService,\r
  IN     CONST CHAR8       *Uri,\r
  IN     CONST CHAR8       *Content,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  EFI_STATUS        Status;\r
  EDKII_JSON_VALUE  JsonValue;\r
\r
  Status    = EFI_SUCCESS;\r
  JsonValue = NULL;\r
\r
  if ((RedfishService == NULL) || (Uri == NULL) || (Content == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  JsonValue = (EDKII_JSON_VALUE)patchUriFromService (\r
                                  RedfishService,\r
                                  Uri,\r
                                  Content,\r
                                  &(RedResponse->StatusCode)\r
                                  );\r
\r
  //\r
  // 1. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if (RedResponse->StatusCode == NULL) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
ON_EXIT:\r
  if (JsonValue != NULL) {\r
    RedResponse->Payload = createRedfishPayload (JsonValue, RedfishService);\r
    if (RedResponse->Payload == NULL) {\r
      //\r
      // Ignore the error when create RedfishPayload, just free the JsonValue since it's not what\r
      // we care about if the returned StatusCode is 2XX.\r
      //\r
      JsonValueFree (JsonValue);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Use HTTP PATCH to perform updates on target payload. Patch to odata.id in Payload directly.\r
\r
  This function uses the Payload to patch the Target. Changes to one or more properties\r
  within the target resource are represented in the input Payload, properties not specified\r
  in Payload won't be changed by this request. The corresponding redfish response will\r
  returned, including HTTP StatusCode, Headers and Payload which record any HTTP response\r
  messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    Target           The target payload to be updated.\r
  @param[in]    Payload          Palyoad with properties to be changed.\r
  @param[out]   RedResponse      Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX. The Redfish resource will be returned\r
                                  in Payload within RedResponse if server send it back in the HTTP\r
                                  response message body.\r
  @retval EFI_INVALID_PARAMETER   Target, Payload, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned StatusCode is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is not NULL and the value is not 2XX,\r
                                     indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishPatchToPayload (\r
  IN     REDFISH_PAYLOAD   Target,\r
  IN     REDFISH_PAYLOAD   Payload,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  if ((Target == NULL) || (Payload == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  RedResponse->Payload = (REDFISH_PAYLOAD)patchPayload (\r
                                            Target,\r
                                            Payload,\r
                                            &(RedResponse->StatusCode)\r
                                            );\r
\r
  //\r
  // 1. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if (RedResponse->StatusCode == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Use HTTP POST to create new Redfish resource in the Resource Collection.\r
\r
  The POST request should be submitted to the Resource Collection in which the new resource\r
  is to belong. The Resource Collection is addressed by URI. The Redfish may\r
  ignore any service controlled properties. The corresponding redfish response will returned,\r
  including HTTP StatusCode, Headers and Payload which record any HTTP response messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    RedfishService        The Service to access the Redfish resources.\r
  @param[in]    Uri                   Relative path to address the resource.\r
  @param[in]    Content               JSON represented properties to be update.\r
  @param[in]    ContentSize           Size of the Content to be send to Redfish service\r
  @param[in]    ContentType           Type of the Content to be send to Redfish service\r
  @param[out]   RedResponse           Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX. The Redfish resource will be returned\r
                                  in Payload within RedResponse if server send it back in the HTTP\r
                                  response message body.\r
  @retval EFI_INVALID_PARAMETER   RedfishService, Uri, Content, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned StatusCode is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is not NULL and the value is not 2XX,\r
                                     indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishPostToUri (\r
  IN     REDFISH_SERVICE   RedfishService,\r
  IN     CONST CHAR8       *Uri,\r
  IN     CONST CHAR8       *Content,\r
  IN     UINTN             ContentSize,\r
  IN     CONST CHAR8       *ContentType,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  EFI_STATUS        Status;\r
  EDKII_JSON_VALUE  JsonValue;\r
\r
  Status    = EFI_SUCCESS;\r
  JsonValue = NULL;\r
\r
  if ((RedfishService == NULL) || (Uri == NULL) || (Content == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  JsonValue = (EDKII_JSON_VALUE)postUriFromService (\r
                                  RedfishService,\r
                                  Uri,\r
                                  Content,\r
                                  ContentSize,\r
                                  ContentType,\r
                                  &(RedResponse->StatusCode)\r
                                  );\r
\r
  //\r
  // 1. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if (RedResponse->StatusCode == NULL) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
ON_EXIT:\r
  if (JsonValue != NULL) {\r
    RedResponse->Payload = createRedfishPayload (JsonValue, RedfishService);\r
    if (RedResponse->Payload == NULL) {\r
      //\r
      // Ignore the error when create RedfishPayload, just free the JsonValue since it's not what\r
      // we care about if the returned StatusCode is 2XX.\r
      //\r
      JsonValueFree (JsonValue);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Use HTTP POST to create a new resource in target payload.\r
\r
  The POST request should be submitted to the Resource Collection in which the new resource\r
  is to belong. The Resource Collection is addressed by Target payload. The Redfish may\r
  ignore any service controlled properties. The corresponding redfish response will returned,\r
  including HTTP StatusCode, Headers and Payload which record any HTTP response messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    Target          Target payload of the Resource Collection.\r
  @param[in]    Payload         The new resource to be created.\r
  @param[out]   RedResponse     Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX. The Redfish resource will be returned\r
                                  in Payload within RedResponse if server send it back in the HTTP\r
                                  response message body.\r
  @retval EFI_INVALID_PARAMETER   Target, Payload, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned StatusCode is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is not NULL and the value is not 2XX,\r
                                     indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishPostToPayload (\r
  IN     REDFISH_PAYLOAD   Target,\r
  IN     REDFISH_PAYLOAD   Payload,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  if ((Target == NULL) || (Payload == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  RedResponse->Payload = (REDFISH_PAYLOAD)postPayload (\r
                                            Target,\r
                                            Payload,\r
                                            &(RedResponse->StatusCode)\r
                                            );\r
\r
  //\r
  // 1. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if (RedResponse->StatusCode == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Use HTTP DELETE to remove a resource.\r
\r
  This function uses the RedfishService to remove a Redfish resource which is addressed\r
  by input Uri (only the relative path is required). The corresponding redfish response will\r
  returned, including HTTP StatusCode, Headers and Payload which record any HTTP response\r
  messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    RedfishService        The Service to access the Redfish resources.\r
  @param[in]    Uri                   Relative path to address the resource.\r
  @param[out]   RedResponse           Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX, the Redfish resource has been removed.\r
                                  If there is any message returned from server, it will be returned\r
                                  in Payload within RedResponse.\r
  @retval EFI_INVALID_PARAMETER   RedfishService, Uri, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned StatusCode is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is not NULL and the value is not 2XX,\r
                                     indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishDeleteByUri (\r
  IN     REDFISH_SERVICE   RedfishService,\r
  IN     CONST CHAR8       *Uri,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  EFI_STATUS        Status;\r
  EDKII_JSON_VALUE  JsonValue;\r
\r
  Status    = EFI_SUCCESS;\r
  JsonValue = NULL;\r
\r
  if ((RedfishService == NULL) || (Uri == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  JsonValue = (EDKII_JSON_VALUE)deleteUriFromService (\r
                                  RedfishService,\r
                                  Uri,\r
                                  &(RedResponse->StatusCode)\r
                                  );\r
\r
  //\r
  // 1. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if (RedResponse->StatusCode == NULL) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
ON_EXIT:\r
  if (JsonValue != NULL) {\r
    RedResponse->Payload = createRedfishPayload (JsonValue, RedfishService);\r
    if (RedResponse->Payload == NULL) {\r
      //\r
      // Ignore the error when create RedfishPayload, just free the JsonValue since it's not what\r
      // we care about if the returned StatusCode is 2XX.\r
      //\r
      JsonValueFree (JsonValue);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Use HTTP DELETE to remove a resource.\r
\r
  This function uses the RedfishService to remove a Redfish resource which is addressed\r
  by input Uri (only the relative path is required). The corresponding redfish response will\r
  returned, including HTTP StatusCode, Headers and Payload which record any HTTP response\r
  messages.\r
\r
  Callers are responsible for freeing the HTTP StatusCode, Headers and Payload returned in\r
  redfish response data.\r
\r
  @param[in]    RedfishService        The Service to access the Redfish resources.\r
  @param[in]    Uri                   Relative path to address the resource.\r
  @param[in]    Content               JSON represented properties to be deleted.\r
  @param[out]   RedResponse           Pointer to the Redfish response data.\r
\r
  @retval EFI_SUCCESS             The opeartion is successful, indicates the HTTP StatusCode is not\r
                                  NULL and the value is 2XX, the Redfish resource has been removed.\r
                                  If there is any message returned from server, it will be returned\r
                                  in Payload within RedResponse.\r
  @retval EFI_INVALID_PARAMETER   RedfishService, Uri, or RedResponse is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. Callers can get\r
                                  more error info from returned HTTP StatusCode, Headers and Payload\r
                                  within RedResponse:\r
                                  1. If the returned StatusCode is NULL, indicates any error happen.\r
                                  2. If the returned StatusCode is not NULL and the value is not 2XX,\r
                                     indicates any error happen.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishDeleteByUriEx (\r
  IN     REDFISH_SERVICE   RedfishService,\r
  IN     CONST CHAR8       *Uri,\r
  IN     CONST CHAR8       *Content,\r
  OUT    REDFISH_RESPONSE  *RedResponse\r
  )\r
{\r
  EFI_STATUS        Status;\r
  EDKII_JSON_VALUE  JsonValue;\r
\r
  Status    = EFI_SUCCESS;\r
  JsonValue = NULL;\r
\r
  if ((RedfishService == NULL) || (Content == NULL) || (Uri == NULL) || (RedResponse == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (RedResponse, sizeof (REDFISH_RESPONSE));\r
\r
  JsonValue = (EDKII_JSON_VALUE)deleteUriFromServiceEx (\r
                                  RedfishService,\r
                                  Uri,\r
                                  Content,\r
                                  &(RedResponse->StatusCode)\r
                                  );\r
\r
  //\r
  // 1. If the returned StatusCode is NULL, indicates any error happen.\r
  //\r
  if (RedResponse->StatusCode == NULL) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // 2. If the returned StatusCode is not NULL and the value is not 2XX, indicates any error happen.\r
  //    NOTE: If there is any error message returned from server, it will be returned in\r
  //          Payload within RedResponse.\r
  //\r
  if ((*(RedResponse->StatusCode) < HTTP_STATUS_200_OK) || \\r
      (*(RedResponse->StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT))\r
  {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
ON_EXIT:\r
  if (JsonValue != NULL) {\r
    RedResponse->Payload = createRedfishPayload (JsonValue, RedfishService);\r
    if (RedResponse->Payload == NULL) {\r
      //\r
      // Ignore the error when create RedfishPayload, just free the JsonValue since it's not what\r
      // we care about if the returned StatusCode is 2XX.\r
      //\r
      JsonValueFree (JsonValue);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Dump text in fractions.\r
\r
  @param[in]  String   ASCII string to dump.\r
\r
**/\r
VOID\r
RedfishDumpJsonStringFractions (\r
  IN CHAR8  *String\r
  )\r
{\r
  CHAR8  *NextFraction;\r
  UINTN  StringFractionSize;\r
  UINTN  StrLen;\r
  UINTN  Count;\r
  CHAR8  BackupChar;\r
\r
  StringFractionSize = 200;\r
  if (String == NULL) {\r
    return;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "JSON text:\n"));\r
  NextFraction = String;\r
  StrLen       = AsciiStrLen (String);\r
  if (StrLen == 0) {\r
    return;\r
  }\r
\r
  for (Count = 0; Count < (StrLen / StringFractionSize); Count++) {\r
    BackupChar                           = *(NextFraction + StringFractionSize);\r
    *(NextFraction + StringFractionSize) = 0;\r
    DEBUG ((DEBUG_INFO, "%a", NextFraction));\r
    *(NextFraction + StringFractionSize) = BackupChar;\r
    NextFraction                        += StringFractionSize;\r
  }\r
\r
  if ((StrLen % StringFractionSize) != 0) {\r
    DEBUG ((DEBUG_INFO, "%a\n\n", NextFraction));\r
  }\r
}\r
\r
/**\r
  Dump text in JSON value.\r
\r
  @param[in]  JsonValue       The Redfish JSON value to dump.\r
\r
**/\r
VOID\r
RedfishDumpJson (\r
  IN EDKII_JSON_VALUE  JsonValue\r
  )\r
{\r
  CHAR8  *String;\r
\r
  String = JsonDumpString (JsonValue, 0);\r
  if (String == NULL) {\r
    return;\r
  }\r
\r
  RedfishDumpJsonStringFractions (String);\r
  FreePool (String);\r
}\r
\r
/**\r
  Extract the JSON text content from REDFISH_PAYLOAD and dump to debug console.\r
\r
  @param[in]  Payload       The Redfish payload to dump.\r
\r
**/\r
VOID\r
RedfishDumpPayload (\r
  IN REDFISH_PAYLOAD  Payload\r
  )\r
{\r
  EDKII_JSON_VALUE  JsonValue;\r
  CHAR8             *String;\r
\r
  JsonValue = NULL;\r
  String    = NULL;\r
\r
  if (Payload == NULL) {\r
    return;\r
  }\r
\r
  JsonValue = RedfishJsonInPayload (Payload);\r
  if (JsonValue == NULL) {\r
    return;\r
  }\r
\r
  String = JsonDumpString (JsonValue, 0);\r
  if (String == NULL) {\r
    return;\r
  }\r
\r
  RedfishDumpJsonStringFractions (String);\r
  FreePool (String);\r
}\r
\r
/**\r
  This function will cleanup the HTTP header and Redfish payload resources.\r
\r
  @param[in]  StatusCode        The status code in HTTP response message.\r
  @param[in]  HeaderCount       Number of HTTP header structures in Headers list.\r
  @param[in]  Headers           Array containing list of HTTP headers.\r
  @param[in]  Payload           The Redfish payload to dump.\r
\r
**/\r
VOID\r
RedfishFreeResponse (\r
  IN EFI_HTTP_STATUS_CODE  *StatusCode,\r
  IN UINTN                 HeaderCount,\r
  IN EFI_HTTP_HEADER       *Headers,\r
  IN REDFISH_PAYLOAD       Payload\r
  )\r
{\r
  if (StatusCode != NULL) {\r
    FreePool (StatusCode);\r
    StatusCode = NULL;\r
  }\r
\r
  if ((HeaderCount != 0) && (Headers != NULL)) {\r
    HttpFreeHeaderFields (Headers, HeaderCount);\r
    Headers = NULL;\r
  }\r
\r
  if (Payload != NULL) {\r
    RedfishCleanupPayload (Payload);\r
    Payload = NULL;\r
  }\r
}\r
\r
/**\r
  Check if the "@odata.type" in Payload is valid or not.\r
\r
  @param[in]  Payload                  The Redfish payload to be checked.\r
  @param[in]  OdataTypeName            OdataType will be retrived from mapping list.\r
  @param[in]  OdataTypeMappingList     The list of OdataType.\r
  @param[in]  OdataTypeMappingListSize The number of mapping list\r
\r
  @return TRUE if the "@odata.type" in Payload is valid, otherwise FALSE.\r
\r
**/\r
BOOLEAN\r
RedfishIsValidOdataType (\r
  IN REDFISH_PAYLOAD             Payload,\r
  IN CONST CHAR8                 *OdataTypeName,\r
  IN REDFISH_ODATA_TYPE_MAPPING  *OdataTypeMappingList,\r
  IN UINTN                       OdataTypeMappingListSize\r
  )\r
{\r
  UINTN             Index;\r
  EDKII_JSON_VALUE  OdataType;\r
  EDKII_JSON_VALUE  JsonValue;\r
\r
  if ((Payload == NULL) || (OdataTypeName == NULL)) {\r
    return FALSE;\r
  }\r
\r
  JsonValue = RedfishJsonInPayload (Payload);\r
  if (!JsonValueIsObject (JsonValue)) {\r
    return FALSE;\r
  }\r
\r
  OdataType = JsonObjectGetValue (JsonValueGetObject (JsonValue), "@odata.type");\r
  if (!JsonValueIsString (OdataType) || (JsonValueGetAsciiString (OdataType) == NULL)) {\r
    return FALSE;\r
  }\r
\r
  for (Index = 0; Index < OdataTypeMappingListSize; Index++) {\r
    if ((AsciiStrCmp (OdataTypeMappingList[Index].OdataTypeName, OdataTypeName) == 0) &&\r
        (AsciiStrCmp (OdataTypeMappingList[Index].OdataType, JsonValueGetAsciiString (OdataType)) == 0))\r
    {\r
      return TRUE;\r
    }\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "%a: This Odata type is not in the list.\n", __FUNCTION__));\r
  return FALSE;\r
}\r
\r
/**\r
  Check if the payload is collection\r
\r
  @param[in]  Payload                  The Redfish payload to be checked.\r
\r
  @return TRUE if the payload is  collection.\r
\r
**/\r
BOOLEAN\r
RedfishIsPayloadCollection (\r
  IN REDFISH_PAYLOAD  Payload\r
  )\r
{\r
  return isPayloadCollection (Payload);\r
}\r
\r
/**\r
  Get collection size.\r
\r
  @param[in]  Payload         The Redfish collection payload\r
  @param[in]  CollectionSize  Size of this collection\r
\r
  @return EFI_SUCCESS              Coolection size is returned in CollectionSize\r
  @return EFI_INVALID_PARAMETER    The payload is not a collection.\r
**/\r
EFI_STATUS\r
RedfishGetCollectionSize (\r
  IN REDFISH_PAYLOAD  Payload,\r
  IN UINTN            *CollectionSize\r
  )\r
{\r
  if ((Payload == NULL) || (CollectionSize == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (!RedfishIsPayloadCollection (Payload)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *CollectionSize = (UINTN)getCollectionSize (Payload);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get Redfish payload of collection member\r
\r
  @param[in]  Payload    The Redfish collection payload\r
  @param[in]  Index      Index of collection member\r
\r
  @return NULL           Fail to get collection member.\r
  @return Non NULL       Payload is returned.\r
**/\r
REDFISH_PAYLOAD\r
RedfishGetPayloadByIndex (\r
  IN REDFISH_PAYLOAD  Payload,\r
  IN UINTN            Index\r
  )\r
{\r
  REDFISH_RESPONSE  RedfishResponse;\r
  REDFISH_PAYLOAD   PayloadReturn;\r
\r
  PayloadReturn = (VOID *)getPayloadByIndex (Payload, Index, &RedfishResponse.StatusCode);\r
  if ((PayloadReturn == NULL) ||\r
      ((*(RedfishResponse.StatusCode) < HTTP_STATUS_200_OK) && (*(RedfishResponse.StatusCode) > HTTP_STATUS_206_PARTIAL_CONTENT)))\r
  {\r
    return NULL;\r
  }\r
\r
  return PayloadReturn;\r
}\r
\r
/**\r
  Check and return Redfish resource of the given Redpath.\r
\r
  @param[in]  RedfishService  Pointer to REDFISH_SERVICE\r
  @param[in]  Redpath         Redpath of the resource.\r
  @param[in]  Response        Optional return the resource.\r
\r
  @return EFI_STATUS\r
**/\r
EFI_STATUS\r
RedfishCheckIfRedpathExist (\r
  IN REDFISH_SERVICE   RedfishService,\r
  IN CHAR8             *Redpath,\r
  IN REDFISH_RESPONSE  *Response OPTIONAL\r
  )\r
{\r
  EFI_STATUS        Status;\r
  REDFISH_RESPONSE  TempResponse;\r
\r
  if (Redpath == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = RedfishGetByService (RedfishService, Redpath, &TempResponse);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (Response == NULL) {\r
    RedfishFreeResponse (\r
      TempResponse.StatusCode,\r
      TempResponse.HeaderCount,\r
      TempResponse.Headers,\r
      TempResponse.Payload\r
      );\r
  } else {\r
    CopyMem ((VOID *)Response, (VOID *)&TempResponse, sizeof (REDFISH_RESPONSE));\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r