[mirror_edk2.git] / NetworkPkg / HttpUtilitiesDxe / HttpUtilitiesProtocol.c

/** @file\r
  Implementation of EFI_HTTP_PROTOCOL protocol interfaces.\r
\r
  Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "HttpUtilitiesDxe.h"\r
\r
EFI_HTTP_UTILITIES_PROTOCOL  mHttpUtilitiesProtocol = {\r
  HttpUtilitiesBuild,\r
  HttpUtilitiesParse\r
};\r
\r
/**\r
  Create HTTP header based on a combination of seed header, fields\r
  to delete, and fields to append.\r
\r
  The Build() function is used to manage the headers portion of an\r
  HTTP message by providing the ability to add, remove, or replace\r
  HTTP headers.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.\r
  @param[in]  SeedMessageSize     Size of the initial HTTP header. This can be zero.\r
  @param[in]  SeedMessage         Initial HTTP header to be used as a base for\r
                                  building a new HTTP header. If NULL,\r
                                  SeedMessageSize is ignored.\r
  @param[in]  DeleteCount         Number of null-terminated HTTP header field names\r
                                  in DeleteList.\r
  @param[in]  DeleteList          List of null-terminated HTTP header field names to\r
                                  remove from SeedMessage. Only the field names are\r
                                  in this list because the field values are irrelevant\r
                                  to this operation.\r
  @param[in]  AppendCount         Number of header fields in AppendList.\r
  @param[in]  AppendList          List of HTTP headers to populate NewMessage with.\r
                                  If SeedMessage is not NULL, AppendList will be\r
                                  appended to the existing list from SeedMessage in\r
                                  NewMessage.\r
  @param[out] NewMessageSize      Pointer to number of header fields in NewMessage.\r
  @param[out] NewMessage          Pointer to a new list of HTTP headers based on.\r
\r
  @retval EFI_SUCCESS             Add, remove, and replace operations succeeded.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate memory for NewMessage.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpUtilitiesBuild (\r
  IN     EFI_HTTP_UTILITIES_PROTOCOL  *This,\r
  IN     UINTN                        SeedMessageSize,\r
  IN     VOID                         *SeedMessage  OPTIONAL,\r
  IN     UINTN                        DeleteCount,\r
  IN     CHAR8                        *DeleteList[]  OPTIONAL,\r
  IN     UINTN                        AppendCount,\r
  IN     EFI_HTTP_HEADER              *AppendList[]  OPTIONAL,\r
  OUT UINTN                           *NewMessageSize,\r
  OUT VOID                            **NewMessage\r
  )\r
{\r
  EFI_STATUS       Status;\r
  EFI_HTTP_HEADER  *SeedHeaderFields;\r
  UINTN            SeedFieldCount;\r
  UINTN            Index;\r
  EFI_HTTP_HEADER  *TempHeaderFields;\r
  UINTN            TempFieldCount;\r
  EFI_HTTP_HEADER  *NewHeaderFields;\r
  UINTN            NewFieldCount;\r
  EFI_HTTP_HEADER  *HttpHeader;\r
  UINTN            StrLength;\r
  UINT8            *NewMessagePtr;\r
\r
  SeedHeaderFields = NULL;\r
  SeedFieldCount   = 0;\r
  TempHeaderFields = NULL;\r
  TempFieldCount   = 0;\r
  NewHeaderFields  = NULL;\r
  NewFieldCount    = 0;\r
\r
  HttpHeader      = NULL;\r
  StrLength       = 0;\r
  NewMessagePtr   = NULL;\r
  *NewMessageSize = 0;\r
  Status          = EFI_SUCCESS;\r
\r
  if (This == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (SeedMessage != NULL) {\r
    Status = This->Parse (\r
                     This,\r
                     SeedMessage,\r
                     SeedMessageSize,\r
                     &SeedHeaderFields,\r
                     &SeedFieldCount\r
                     );\r
    if (EFI_ERROR (Status)) {\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  //\r
  // Handle DeleteList\r
  //\r
  if ((SeedFieldCount != 0) && (DeleteCount != 0)) {\r
    TempHeaderFields = AllocateZeroPool (SeedFieldCount * sizeof (EFI_HTTP_HEADER));\r
    if (TempHeaderFields == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto ON_EXIT;\r
    }\r
\r
    for (Index = 0, TempFieldCount = 0; Index < SeedFieldCount; Index++) {\r
      //\r
      // Check whether each SeedHeaderFields member is in DeleteList\r
      //\r
      if (HttpIsValidHttpHeader (DeleteList, DeleteCount, SeedHeaderFields[Index].FieldName)) {\r
        Status = HttpSetFieldNameAndValue (\r
                   &TempHeaderFields[TempFieldCount],\r
                   SeedHeaderFields[Index].FieldName,\r
                   SeedHeaderFields[Index].FieldValue\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          goto ON_EXIT;\r
        }\r
\r
        TempFieldCount++;\r
      }\r
    }\r
  } else {\r
    TempHeaderFields = SeedHeaderFields;\r
    TempFieldCount   = SeedFieldCount;\r
  }\r
\r
  //\r
  // Handle AppendList\r
  //\r
  NewHeaderFields = AllocateZeroPool ((TempFieldCount + AppendCount) * sizeof (EFI_HTTP_HEADER));\r
  if (NewHeaderFields == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_EXIT;\r
  }\r
\r
  for (Index = 0; Index < TempFieldCount; Index++) {\r
    Status = HttpSetFieldNameAndValue (\r
               &NewHeaderFields[Index],\r
               TempHeaderFields[Index].FieldName,\r
               TempHeaderFields[Index].FieldValue\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  NewFieldCount = TempFieldCount;\r
\r
  for (Index = 0; Index < AppendCount; Index++) {\r
    HttpHeader = HttpFindHeader (NewFieldCount, NewHeaderFields, AppendList[Index]->FieldName);\r
    if (HttpHeader != NULL) {\r
      Status = HttpSetFieldNameAndValue (\r
                 HttpHeader,\r
                 AppendList[Index]->FieldName,\r
                 AppendList[Index]->FieldValue\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        goto ON_EXIT;\r
      }\r
    } else {\r
      Status = HttpSetFieldNameAndValue (\r
                 &NewHeaderFields[NewFieldCount],\r
                 AppendList[Index]->FieldName,\r
                 AppendList[Index]->FieldValue\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        goto ON_EXIT;\r
      }\r
\r
      NewFieldCount++;\r
    }\r
  }\r
\r
  //\r
  // Calculate NewMessageSize, then build NewMessage\r
  //\r
  for (Index = 0; Index < NewFieldCount; Index++) {\r
    HttpHeader = &NewHeaderFields[Index];\r
\r
    StrLength        = AsciiStrLen (HttpHeader->FieldName);\r
    *NewMessageSize += StrLength;\r
\r
    StrLength        = sizeof (": ") - 1;\r
    *NewMessageSize += StrLength;\r
\r
    StrLength        = AsciiStrLen (HttpHeader->FieldValue);\r
    *NewMessageSize += StrLength;\r
\r
    StrLength        = sizeof ("\r\n") - 1;\r
    *NewMessageSize += StrLength;\r
  }\r
\r
  StrLength        = sizeof ("\r\n") - 1;\r
  *NewMessageSize += StrLength;\r
\r
  *NewMessage = AllocateZeroPool (*NewMessageSize);\r
  if (*NewMessage == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_EXIT;\r
  }\r
\r
  NewMessagePtr = (UINT8 *)(*NewMessage);\r
\r
  for (Index = 0; Index < NewFieldCount; Index++) {\r
    HttpHeader = &NewHeaderFields[Index];\r
\r
    StrLength = AsciiStrLen (HttpHeader->FieldName);\r
    CopyMem (NewMessagePtr, HttpHeader->FieldName, StrLength);\r
    NewMessagePtr += StrLength;\r
\r
    StrLength = sizeof (": ") - 1;\r
    CopyMem (NewMessagePtr, ": ", StrLength);\r
    NewMessagePtr += StrLength;\r
\r
    StrLength = AsciiStrLen (HttpHeader->FieldValue);\r
    CopyMem (NewMessagePtr, HttpHeader->FieldValue, StrLength);\r
    NewMessagePtr += StrLength;\r
\r
    StrLength = sizeof ("\r\n") - 1;\r
    CopyMem (NewMessagePtr, "\r\n", StrLength);\r
    NewMessagePtr += StrLength;\r
  }\r
\r
  StrLength = sizeof ("\r\n") - 1;\r
  CopyMem (NewMessagePtr, "\r\n", StrLength);\r
  NewMessagePtr += StrLength;\r
\r
  ASSERT (*NewMessageSize == (UINTN)NewMessagePtr - (UINTN)(*NewMessage));\r
\r
  //\r
  // Free allocated buffer\r
  //\r
ON_EXIT:\r
  if (SeedHeaderFields != NULL) {\r
    HttpFreeHeaderFields (SeedHeaderFields, SeedFieldCount);\r
  }\r
\r
  if (TempHeaderFields != NULL) {\r
    HttpFreeHeaderFields (TempHeaderFields, TempFieldCount);\r
  }\r
\r
  if (NewHeaderFields != NULL) {\r
    HttpFreeHeaderFields (NewHeaderFields, NewFieldCount);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Parses HTTP header and produces an array of key/value pairs.\r
\r
  The Parse() function is used to transform data stored in HttpHeader\r
  into a list of fields paired with their corresponding values.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.\r
  @param[in]  HttpMessage         Contains raw unformatted HTTP header string.\r
  @param[in]  HttpMessageSize     Size of HTTP header.\r
  @param[out] HeaderFields        Array of key/value header pairs.\r
  @param[out] FieldCount          Number of headers in HeaderFields.\r
\r
  @retval EFI_SUCCESS             Allocation succeeded.\r
  @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been\r
                                  initialized.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  HttpMessage is NULL.\r
                                  HeaderFields is NULL.\r
                                  FieldCount is NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpUtilitiesParse (\r
  IN  EFI_HTTP_UTILITIES_PROTOCOL  *This,\r
  IN  CHAR8                        *HttpMessage,\r
  IN  UINTN                        HttpMessageSize,\r
  OUT EFI_HTTP_HEADER              **HeaderFields,\r
  OUT UINTN                        *FieldCount\r
  )\r
{\r
  EFI_STATUS  Status;\r
  CHAR8       *TempHttpMessage;\r
  CHAR8       *Token;\r
  CHAR8       *NextToken;\r
  CHAR8       *FieldName;\r
  CHAR8       *FieldValue;\r
  UINTN       Index;\r
  UINTN       HttpBufferSize;\r
\r
  Status          = EFI_SUCCESS;\r
  TempHttpMessage = NULL;\r
  Token           = NULL;\r
  NextToken       = NULL;\r
  FieldName       = NULL;\r
  FieldValue      = NULL;\r
  Index           = 0;\r
\r
  if ((This == NULL) || (HttpMessage == NULL) || (HeaderFields == NULL) || (FieldCount == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Append the http response string along with a Null-terminator.\r
  //\r
  HttpBufferSize  = HttpMessageSize + 1;\r
  TempHttpMessage = AllocatePool (HttpBufferSize);\r
  if (TempHttpMessage == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  CopyMem (TempHttpMessage, HttpMessage, HttpMessageSize);\r
  *(TempHttpMessage + HttpMessageSize) = '\0';\r
\r
  //\r
  // Get header number\r
  //\r
  *FieldCount = 0;\r
  Token       = TempHttpMessage;\r
  while (TRUE) {\r
    FieldName  = NULL;\r
    FieldValue = NULL;\r
    NextToken  = HttpGetFieldNameAndValue (Token, &FieldName, &FieldValue);\r
    Token      = NextToken;\r
    if ((FieldName == NULL) || (FieldValue == NULL)) {\r
      break;\r
    }\r
\r
    (*FieldCount)++;\r
  }\r
\r
  if (*FieldCount == 0) {\r
    Status =  EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Allocate buffer for header\r
  //\r
  *HeaderFields = AllocateZeroPool ((*FieldCount) * sizeof (EFI_HTTP_HEADER));\r
  if (*HeaderFields == NULL) {\r
    *FieldCount = 0;\r
    Status      = EFI_OUT_OF_RESOURCES;\r
    goto ON_EXIT;\r
  }\r
\r
  CopyMem (TempHttpMessage, HttpMessage, HttpMessageSize);\r
\r
  //\r
  // Set Field and Value to each header\r
  //\r
  Token = TempHttpMessage;\r
  while (Index < *FieldCount) {\r
    FieldName  = NULL;\r
    FieldValue = NULL;\r
    NextToken  = HttpGetFieldNameAndValue (Token, &FieldName, &FieldValue);\r
    Token      = NextToken;\r
    if ((FieldName == NULL) || (FieldValue == NULL)) {\r
      break;\r
    }\r
\r
    Status = HttpSetFieldNameAndValue (&(*HeaderFields)[Index], FieldName, FieldValue);\r
    if (EFI_ERROR (Status)) {\r
      *FieldCount = 0;\r
      HttpFreeHeaderFields (*HeaderFields, Index);\r
      goto ON_EXIT;\r
    }\r
\r
    Index++;\r
  }\r
\r
  //\r
  // Free allocated buffer\r
  //\r
ON_EXIT:\r
  if (TempHttpMessage != NULL) {\r
    FreePool (TempHttpMessage);\r
  }\r
\r
  return Status;\r
}\r
Commit	Line	Data
d933e70a JW	1	/** @file\r
	2	Implementation of EFI_HTTP_PROTOCOL protocol interfaces.\r
	3	\r
f75a7f56	4	Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
f58554fc	5	(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
ecf98fbc	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
d933e70a JW	7	\r
	8	**/\r
	9	\r
	10	#include "HttpUtilitiesDxe.h"\r
	11	\r
d1050b9d	12	EFI_HTTP_UTILITIES_PROTOCOL mHttpUtilitiesProtocol = {\r
d933e70a JW	13	HttpUtilitiesBuild,\r
	14	HttpUtilitiesParse\r
	15	};\r
	16	\r
d933e70a JW	17	/**\r
	18	Create HTTP header based on a combination of seed header, fields\r
	19	to delete, and fields to append.\r
	20	\r
	21	The Build() function is used to manage the headers portion of an\r
	22	HTTP message by providing the ability to add, remove, or replace\r
	23	HTTP headers.\r
	24	\r
	25	@param[in] This Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.\r
	26	@param[in] SeedMessageSize Size of the initial HTTP header. This can be zero.\r
	27	@param[in] SeedMessage Initial HTTP header to be used as a base for\r
	28	building a new HTTP header. If NULL,\r
	29	SeedMessageSize is ignored.\r
	30	@param[in] DeleteCount Number of null-terminated HTTP header field names\r
	31	in DeleteList.\r
	32	@param[in] DeleteList List of null-terminated HTTP header field names to\r
	33	remove from SeedMessage. Only the field names are\r
	34	in this list because the field values are irrelevant\r
	35	to this operation.\r
	36	@param[in] AppendCount Number of header fields in AppendList.\r
	37	@param[in] AppendList List of HTTP headers to populate NewMessage with.\r
	38	If SeedMessage is not NULL, AppendList will be\r
	39	appended to the existing list from SeedMessage in\r
	40	NewMessage.\r
	41	@param[out] NewMessageSize Pointer to number of header fields in NewMessage.\r
	42	@param[out] NewMessage Pointer to a new list of HTTP headers based on.\r
	43	\r
	44	@retval EFI_SUCCESS Add, remove, and replace operations succeeded.\r
	45	@retval EFI_OUT_OF_RESOURCES Could not allocate memory for NewMessage.\r
	46	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
	47	This is NULL.\r
	48	**/\r
	49	EFI_STATUS\r
	50	EFIAPI\r
	51	HttpUtilitiesBuild (\r
d1050b9d MK	52	IN EFI_HTTP_UTILITIES_PROTOCOL *This,\r
	53	IN UINTN SeedMessageSize,\r
	54	IN VOID *SeedMessage OPTIONAL,\r
	55	IN UINTN DeleteCount,\r
	56	IN CHAR8 *DeleteList[] OPTIONAL,\r
	57	IN UINTN AppendCount,\r
	58	IN EFI_HTTP_HEADER *AppendList[] OPTIONAL,\r
	59	OUT UINTN *NewMessageSize,\r
	60	OUT VOID **NewMessage\r
d933e70a JW	61	)\r
d933e70a JW	62	{\r
d1050b9d MK	63	EFI_STATUS Status;\r
	64	EFI_HTTP_HEADER *SeedHeaderFields;\r
	65	UINTN SeedFieldCount;\r
	66	UINTN Index;\r
	67	EFI_HTTP_HEADER *TempHeaderFields;\r
	68	UINTN TempFieldCount;\r
	69	EFI_HTTP_HEADER *NewHeaderFields;\r
	70	UINTN NewFieldCount;\r
	71	EFI_HTTP_HEADER *HttpHeader;\r
	72	UINTN StrLength;\r
	73	UINT8 *NewMessagePtr;\r
d933e70a JW	74	\r
	75	SeedHeaderFields = NULL;\r
	76	SeedFieldCount = 0;\r
	77	TempHeaderFields = NULL;\r
	78	TempFieldCount = 0;\r
	79	NewHeaderFields = NULL;\r
	80	NewFieldCount = 0;\r
	81	\r
d1050b9d MK	82	HttpHeader = NULL;\r
	83	StrLength = 0;\r
	84	NewMessagePtr = NULL;\r
	85	*NewMessageSize = 0;\r
	86	Status = EFI_SUCCESS;\r
f75a7f56	87	\r
d933e70a JW	88	if (This == NULL) {\r
	89	return EFI_INVALID_PARAMETER;\r
	90	}\r
	91	\r
	92	if (SeedMessage != NULL) {\r
	93	Status = This->Parse (\r
f75a7f56 LG	94	This,\r
	95	SeedMessage,\r
	96	SeedMessageSize,\r
	97	&SeedHeaderFields,\r
d933e70a JW	98	&SeedFieldCount\r
	99	);\r
	100	if (EFI_ERROR (Status)) {\r
	101	goto ON_EXIT;\r
	102	}\r
	103	}\r
	104	\r
	105	//\r
	106	// Handle DeleteList\r
	107	//\r
d1050b9d MK	108	if ((SeedFieldCount != 0) && (DeleteCount != 0)) {\r
d1050b9d MK	109	TempHeaderFields = AllocateZeroPool (SeedFieldCount * sizeof (EFI_HTTP_HEADER));\r
d933e70a JW	110	if (TempHeaderFields == NULL) {\r
	111	Status = EFI_OUT_OF_RESOURCES;\r
	112	goto ON_EXIT;\r
	113	}\r
f75a7f56	114	\r
d933e70a JW	115	for (Index = 0, TempFieldCount = 0; Index < SeedFieldCount; Index++) {\r
	116	//\r
	117	// Check whether each SeedHeaderFields member is in DeleteList\r
	118	//\r
d1050b9d	119	if (HttpIsValidHttpHeader (DeleteList, DeleteCount, SeedHeaderFields[Index].FieldName)) {\r
f58554fc	120	Status = HttpSetFieldNameAndValue (\r
f75a7f56 LG	121	&TempHeaderFields[TempFieldCount],\r
f75a7f56 LG	122	SeedHeaderFields[Index].FieldName,\r
d933e70a JW	123	SeedHeaderFields[Index].FieldValue\r
	124	);\r
	125	if (EFI_ERROR (Status)) {\r
	126	goto ON_EXIT;\r
	127	}\r
d1050b9d	128	\r
d933e70a JW	129	TempFieldCount++;\r
	130	}\r
	131	}\r
	132	} else {\r
	133	TempHeaderFields = SeedHeaderFields;\r
d1050b9d	134	TempFieldCount = SeedFieldCount;\r
d933e70a JW	135	}\r
	136	\r
	137	//\r
	138	// Handle AppendList\r
	139	//\r
	140	NewHeaderFields = AllocateZeroPool ((TempFieldCount + AppendCount) * sizeof (EFI_HTTP_HEADER));\r
	141	if (NewHeaderFields == NULL) {\r
	142	Status = EFI_OUT_OF_RESOURCES;\r
	143	goto ON_EXIT;\r
	144	}\r
	145	\r
	146	for (Index = 0; Index < TempFieldCount; Index++) {\r
f58554fc	147	Status = HttpSetFieldNameAndValue (\r
f75a7f56 LG	148	&NewHeaderFields[Index],\r
f75a7f56 LG	149	TempHeaderFields[Index].FieldName,\r
d933e70a JW	150	TempHeaderFields[Index].FieldValue\r
	151	);\r
	152	if (EFI_ERROR (Status)) {\r
	153	goto ON_EXIT;\r
	154	}\r
	155	}\r
f75a7f56	156	\r
d933e70a JW	157	NewFieldCount = TempFieldCount;\r
	158	\r
	159	for (Index = 0; Index < AppendCount; Index++) {\r
f58554fc	160	HttpHeader = HttpFindHeader (NewFieldCount, NewHeaderFields, AppendList[Index]->FieldName);\r
d933e70a	161	if (HttpHeader != NULL) {\r
f58554fc	162	Status = HttpSetFieldNameAndValue (\r
f75a7f56 LG	163	HttpHeader,\r
f75a7f56 LG	164	AppendList[Index]->FieldName,\r
d933e70a JW	165	AppendList[Index]->FieldValue\r
	166	);\r
	167	if (EFI_ERROR (Status)) {\r
	168	goto ON_EXIT;\r
	169	}\r
	170	} else {\r
f58554fc	171	Status = HttpSetFieldNameAndValue (\r
f75a7f56 LG	172	&NewHeaderFields[NewFieldCount],\r
f75a7f56 LG	173	AppendList[Index]->FieldName,\r
d933e70a JW	174	AppendList[Index]->FieldValue\r
	175	);\r
	176	if (EFI_ERROR (Status)) {\r
	177	goto ON_EXIT;\r
	178	}\r
d1050b9d	179	\r
d933e70a JW	180	NewFieldCount++;\r
	181	}\r
	182	}\r
	183	\r
	184	//\r
	185	// Calculate NewMessageSize, then build NewMessage\r
	186	//\r
	187	for (Index = 0; Index < NewFieldCount; Index++) {\r
	188	HttpHeader = &NewHeaderFields[Index];\r
	189	\r
d1050b9d	190	StrLength = AsciiStrLen (HttpHeader->FieldName);\r
d933e70a JW	191	*NewMessageSize += StrLength;\r
d933e70a JW	192	\r
d1050b9d	193	StrLength = sizeof (": ") - 1;\r
d933e70a JW	194	*NewMessageSize += StrLength;\r
d933e70a JW	195	\r
d1050b9d	196	StrLength = AsciiStrLen (HttpHeader->FieldValue);\r
d933e70a JW	197	*NewMessageSize += StrLength;\r
d933e70a JW	198	\r
d1050b9d	199	StrLength = sizeof ("\r\n") - 1;\r
d933e70a JW	200	*NewMessageSize += StrLength;\r
d933e70a JW	201	}\r
d1050b9d MK	202	\r
d1050b9d MK	203	StrLength = sizeof ("\r\n") - 1;\r
d933e70a JW	204	*NewMessageSize += StrLength;\r
d933e70a JW	205	\r
d933e70a JW	206	NewMessage = AllocateZeroPool (NewMessageSize);\r
	207	if (*NewMessage == NULL) {\r
	208	Status = EFI_OUT_OF_RESOURCES;\r
	209	goto ON_EXIT;\r
	210	}\r
	211	\r
	212	NewMessagePtr = (UINT8 )(NewMessage);\r
	213	\r
	214	for (Index = 0; Index < NewFieldCount; Index++) {\r
	215	HttpHeader = &NewHeaderFields[Index];\r
	216	\r
	217	StrLength = AsciiStrLen (HttpHeader->FieldName);\r
	218	CopyMem (NewMessagePtr, HttpHeader->FieldName, StrLength);\r
	219	NewMessagePtr += StrLength;\r
	220	\r
d1050b9d	221	StrLength = sizeof (": ") - 1;\r
d933e70a JW	222	CopyMem (NewMessagePtr, ": ", StrLength);\r
	223	NewMessagePtr += StrLength;\r
	224	\r
	225	StrLength = AsciiStrLen (HttpHeader->FieldValue);\r
	226	CopyMem (NewMessagePtr, HttpHeader->FieldValue, StrLength);\r
	227	NewMessagePtr += StrLength;\r
	228	\r
d1050b9d	229	StrLength = sizeof ("\r\n") - 1;\r
d933e70a JW	230	CopyMem (NewMessagePtr, "\r\n", StrLength);\r
	231	NewMessagePtr += StrLength;\r
	232	}\r
d1050b9d MK	233	\r
d1050b9d MK	234	StrLength = sizeof ("\r\n") - 1;\r
d933e70a JW	235	CopyMem (NewMessagePtr, "\r\n", StrLength);\r
	236	NewMessagePtr += StrLength;\r
	237	\r
19c25725	238	ASSERT (NewMessageSize == (UINTN)NewMessagePtr - (UINTN)(NewMessage));\r
d933e70a JW	239	\r
d933e70a JW	240	//\r
f75a7f56	241	// Free allocated buffer\r
d933e70a JW	242	//\r
	243	ON_EXIT:\r
	244	if (SeedHeaderFields != NULL) {\r
d1050b9d	245	HttpFreeHeaderFields (SeedHeaderFields, SeedFieldCount);\r
d933e70a	246	}\r
f75a7f56	247	\r
d933e70a	248	if (TempHeaderFields != NULL) {\r
d1050b9d	249	HttpFreeHeaderFields (TempHeaderFields, TempFieldCount);\r
d933e70a JW	250	}\r
	251	\r
	252	if (NewHeaderFields != NULL) {\r
d1050b9d	253	HttpFreeHeaderFields (NewHeaderFields, NewFieldCount);\r
d933e70a	254	}\r
f75a7f56	255	\r
d933e70a JW	256	return Status;\r
	257	}\r
	258	\r
d933e70a JW	259	/**\r
	260	Parses HTTP header and produces an array of key/value pairs.\r
	261	\r
	262	The Parse() function is used to transform data stored in HttpHeader\r
	263	into a list of fields paired with their corresponding values.\r
	264	\r
	265	@param[in] This Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.\r
	266	@param[in] HttpMessage Contains raw unformatted HTTP header string.\r
	267	@param[in] HttpMessageSize Size of HTTP header.\r
	268	@param[out] HeaderFields Array of key/value header pairs.\r
	269	@param[out] FieldCount Number of headers in HeaderFields.\r
	270	\r
	271	@retval EFI_SUCCESS Allocation succeeded.\r
	272	@retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been\r
	273	initialized.\r
	274	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
	275	This is NULL.\r
	276	HttpMessage is NULL.\r
	277	HeaderFields is NULL.\r
	278	FieldCount is NULL.\r
	279	**/\r
	280	EFI_STATUS\r
	281	EFIAPI\r
	282	HttpUtilitiesParse (\r
	283	IN EFI_HTTP_UTILITIES_PROTOCOL *This,\r
	284	IN CHAR8 *HttpMessage,\r
	285	IN UINTN HttpMessageSize,\r
	286	OUT EFI_HTTP_HEADER **HeaderFields,\r
	287	OUT UINTN *FieldCount\r
	288	)\r
	289	{\r
d1050b9d MK	290	EFI_STATUS Status;\r
	291	CHAR8 *TempHttpMessage;\r
	292	CHAR8 *Token;\r
	293	CHAR8 *NextToken;\r
	294	CHAR8 *FieldName;\r
	295	CHAR8 *FieldValue;\r
	296	UINTN Index;\r
	297	UINTN HttpBufferSize;\r
f75a7f56	298	\r
d933e70a JW	299	Status = EFI_SUCCESS;\r
d933e70a JW	300	TempHttpMessage = NULL;\r
d933e70a JW	301	Token = NULL;\r
	302	NextToken = NULL;\r
	303	FieldName = NULL;\r
	304	FieldValue = NULL;\r
	305	Index = 0;\r
f75a7f56	306	\r
d1050b9d	307	if ((This == NULL) \|\| (HttpMessage == NULL) \|\| (HeaderFields == NULL) \|\| (FieldCount == NULL)) {\r
d933e70a JW	308	return EFI_INVALID_PARAMETER;\r
d933e70a JW	309	}\r
f75a7f56	310	\r
130e6292 AL	311	//\r
	312	// Append the http response string along with a Null-terminator.\r
	313	//\r
d1050b9d	314	HttpBufferSize = HttpMessageSize + 1;\r
130e6292	315	TempHttpMessage = AllocatePool (HttpBufferSize);\r
d933e70a JW	316	if (TempHttpMessage == NULL) {\r
	317	return EFI_OUT_OF_RESOURCES;\r
	318	}\r
	319	\r
	320	CopyMem (TempHttpMessage, HttpMessage, HttpMessageSize);\r
130e6292	321	*(TempHttpMessage + HttpMessageSize) = '\0';\r
f75a7f56	322	\r
d933e70a JW	323	//\r
	324	// Get header number\r
	325	//\r
2ba88dc5	326	*FieldCount = 0;\r
d1050b9d	327	Token = TempHttpMessage;\r
d933e70a	328	while (TRUE) {\r
d1050b9d MK	329	FieldName = NULL;\r
	330	FieldValue = NULL;\r
	331	NextToken = HttpGetFieldNameAndValue (Token, &FieldName, &FieldValue);\r
	332	Token = NextToken;\r
	333	if ((FieldName == NULL) \|\| (FieldValue == NULL)) {\r
d933e70a JW	334	break;\r
	335	}\r
	336	\r
	337	(*FieldCount)++;\r
	338	}\r
	339	\r
	340	if (*FieldCount == 0) {\r
	341	Status = EFI_INVALID_PARAMETER;\r
	342	goto ON_EXIT;\r
	343	}\r
f75a7f56	344	\r
d933e70a JW	345	//\r
	346	// Allocate buffer for header\r
	347	//\r
d1050b9d	348	HeaderFields = AllocateZeroPool ((FieldCount) * sizeof (EFI_HTTP_HEADER));\r
d933e70a JW	349	if (*HeaderFields == NULL) {\r
d933e70a JW	350	*FieldCount = 0;\r
d1050b9d	351	Status = EFI_OUT_OF_RESOURCES;\r
d933e70a JW	352	goto ON_EXIT;\r
d933e70a JW	353	}\r
f75a7f56	354	\r
d933e70a	355	CopyMem (TempHttpMessage, HttpMessage, HttpMessageSize);\r
f75a7f56	356	\r
d933e70a JW	357	//\r
	358	// Set Field and Value to each header\r
	359	//\r
	360	Token = TempHttpMessage;\r
	361	while (Index < *FieldCount) {\r
d1050b9d MK	362	FieldName = NULL;\r
	363	FieldValue = NULL;\r
	364	NextToken = HttpGetFieldNameAndValue (Token, &FieldName, &FieldValue);\r
	365	Token = NextToken;\r
	366	if ((FieldName == NULL) \|\| (FieldValue == NULL)) {\r
d933e70a JW	367	break;\r
	368	}\r
	369	\r
f58554fc	370	Status = HttpSetFieldNameAndValue (&(*HeaderFields)[Index], FieldName, FieldValue);\r
d933e70a JW	371	if (EFI_ERROR (Status)) {\r
d933e70a JW	372	*FieldCount = 0;\r
f58554fc	373	HttpFreeHeaderFields (*HeaderFields, Index);\r
d933e70a JW	374	goto ON_EXIT;\r
d933e70a JW	375	}\r
f75a7f56	376	\r
d933e70a JW	377	Index++;\r
	378	}\r
	379	\r
	380	//\r
f75a7f56	381	// Free allocated buffer\r
d933e70a JW	382	//\r
	383	ON_EXIT:\r
	384	if (TempHttpMessage != NULL) {\r
	385	FreePool (TempHttpMessage);\r
	386	}\r
f75a7f56	387	\r
d933e70a	388	return Status;\r
f75a7f56	389	}\r