/*

 * Extension block 0xbeef0027 values functions

 *

 * Copyright (C) 2010-2024, Joachim Metz <joachim.metz@gmail.com>

 *

 * Refer to AUTHORS for acknowledgements.

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU Lesser General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License

 * along with this program.  If not, see <https://www.gnu.org/licenses/>.

 */

#include <common.h>

#include <byte_stream.h>

#include <memory.h>

#include <types.h>

#include "libfwsi_debug.h"

#include "libfwsi_definitions.h"

#include "libfwsi_extension_block_0xbeef0027_values.h"

#include "libfwsi_libcerror.h"

#include "libfwsi_libcnotify.h"

/* Creates extension block 0xbeef0027 values

 * Make sure the value extension_block_0xbeef0027_values is referencing, is set to NULL

 * Returns 1 if successful or -1 on error

 */

int libfwsi_extension_block_0xbeef0027_values_initialize(

     libfwsi_extension_block_0xbeef0027_values_t **extension_block_0xbeef0027_values,

     libcerror_error_t **error )

{

  static char *function = "libfwsi_extension_block_0xbeef0027_values_initialize";

  if( extension_block_0xbeef0027_values == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extension block 0xbeef0027 values.",

     function );

    return( -1 );

  }

  if( *extension_block_0xbeef0027_values != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid extension block 0xbeef0027 values value already set.",

     function );

    return( -1 );

  }

  *extension_block_0xbeef0027_values = memory_allocate_structure(

                                        libfwsi_extension_block_0xbeef0027_values_t );

  if( *extension_block_0xbeef0027_values == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create extension block 0xbeef0027 values.",

     function );

    goto on_error;

  }

  if( memory_set(

       *extension_block_0xbeef0027_values,

       0,

       sizeof( libfwsi_extension_block_0xbeef0027_values_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear extension block 0xbeef0027 values.",

     function );

    goto on_error;

  }

  return( 1 );

on_error:

  if( *extension_block_0xbeef0027_values != NULL )

  {

    memory_free(

     *extension_block_0xbeef0027_values );

    *extension_block_0xbeef0027_values = NULL;

  }

  return( -1 );

}

/* Frees extension block 0xbeef0027 values

 * Returns 1 if successful or -1 on error

 */

int libfwsi_extension_block_0xbeef0027_values_free(

     libfwsi_extension_block_0xbeef0027_values_t **extension_block_0xbeef0027_values,

     libcerror_error_t **error )

{

  static char *function = "libfwsi_extension_block_0xbeef0027_values_free";

  if( extension_block_0xbeef0027_values == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extension block 0xbeef0027 values.",

     function );

    return( -1 );

  }

  if( *extension_block_0xbeef0027_values != NULL )

  {

    memory_free(

     *extension_block_0xbeef0027_values );

    *extension_block_0xbeef0027_values = NULL;

  }

  return( 1 );

}

/* Reads the extension block 0xbeef0027 values

 * Returns 1 if successful, 0 if not supported or -1 on error

 */

int libfwsi_extension_block_0xbeef0027_values_read_data(

     libfwsi_extension_block_0xbeef0027_values_t *extension_block_0xbeef0027_values,

     const uint8_t *data,

     size_t data_size,

     int ascii_codepage,

     libcerror_error_t **error )

{

  static char *function        = "libfwsi_extension_block_0xbeef0027_values_read_data";

  uint32_t signature           = 0;

#if defined( HAVE_DEBUG_OUTPUT )

  uint32_t property_store_size = 0;

#endif

  if( extension_block_0xbeef0027_values == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extension block 0xbeef0027 values.",

     function );

    return( -1 );

  }

  if( data == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid data.",

     function );

    return( -1 );

  }

  if( data_size > (size_t) SSIZE_MAX )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,

     "%s: data size exceeds maximum.",

     function );

    return( -1 );

  }

  /* Do not try to parse unsupported data sizes

   */

  if( data_size < 12 )

  {

    return( 0 );

  }

  /* Do not try to parse unsupported extension block signatures

   */

  byte_stream_copy_to_uint32_little_endian(

   &( data[ 4 ] ),

   signature );

  if( signature != 0xbeef0027 )

  {

    return( 0 );

  }

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    if( libfwsi_debug_print_property_store_value(

         &( data[ 8 ] ),

         data_size - 8 - 2,

         ascii_codepage,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,

       "%s: unable to print property store value.",

       function );

      return( -1 );

    }

  }

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    byte_stream_copy_to_uint32_little_endian(

     &( data[ 8 ] ),

     property_store_size );

    if( property_store_size < ( data_size - 8 ) )

    {

      libcnotify_printf(

       "%s: trailing data:\n",

       function );

      libcnotify_print_data(

       &( data[ 8 + property_store_size ] ),

       data_size - 8 - property_store_size - 2,

       LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    }

    else

    {

      libcnotify_printf(

       "\n" );

    }

  }

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

  return( 1 );

}