/*

 * File information functions

 *

 * Copyright (C) 2012-2025, 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 "libvhdi_debug.h"

#include "libvhdi_definitions.h"

#include "libvhdi_file_information.h"

#include "libvhdi_libbfio.h"

#include "libvhdi_libcerror.h"

#include "libvhdi_libcnotify.h"

#include "libvhdi_libuna.h"

#include "vhdi_file_information.h"

/* Creates file information

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

 * Returns 1 if successful or -1 on error

 */

int libvhdi_file_information_initialize(

     libvhdi_file_information_t **file_information,

     libcerror_error_t **error )

{

  static char *function = "libvhdi_file_information_initialize";

  if( file_information == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid file information.",

     function );

    return( -1 );

  }

  if( *file_information != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid file information value already set.",

     function );

    return( -1 );

  }

  *file_information = memory_allocate_structure(

                       libvhdi_file_information_t );

  if( *file_information == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create file information.",

     function );

    goto on_error;

  }

  if( memory_set(

       *file_information,

       0,

       sizeof( libvhdi_file_information_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear file information.",

     function );

    goto on_error;

  }

  return( 1 );

on_error:

  if( *file_information != NULL )

  {

    memory_free(

     *file_information );

    *file_information = NULL;

  }

  return( -1 );

}

/* Frees file information

 * Returns 1 if successful or -1 on error

 */

int libvhdi_file_information_free(

     libvhdi_file_information_t **file_information,

     libcerror_error_t **error )

{

  static char *function = "libvhdi_file_information_free";

  if( file_information == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid file information.",

     function );

    return( -1 );

  }

  if( *file_information != NULL )

  {

    memory_free(

     *file_information );

    *file_information = NULL;

  }

  return( 1 );

}

/* Reads the file information data

 * Returns 1 if successful, 0 if signature does not match or -1 on error

 */

int libvhdi_file_information_read_data(

     libvhdi_file_information_t *file_information,

     const uint8_t *data,

     size_t data_size,

     libcerror_error_t **error )

{

  static char *function = "libvhdi_file_information_read_data";

  if( file_information == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid file information.",

     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 < sizeof( vhdi_file_information_t ) )

   || ( data_size > (size_t) SSIZE_MAX ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid data size value out of bounds.",

     function );

    return( -1 );

  }

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    libcnotify_printf(

     "%s: file information data:\n",

     function );

    libcnotify_print_data(

     data,

     sizeof( vhdi_file_information_t ),

     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

  }

#endif

  if( memory_compare(

       ( (vhdi_file_information_t *) data )->signature,

       "vhdxfile",

       8 ) != 0 )

  {

    return( 0 );

  }

  if( memory_copy(

       file_information->creator,

       ( (vhdi_file_information_t *) data )->creator,

       512 ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_COPY_FAILED,

     "%s: unable to copy creator.",

     function );

    return( -1 );

  }

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    libcnotify_printf(

     "%s: signature\t\t\t\t: %c%c%c%c%c%c%c%c\n",

     function,

     ( (vhdi_file_information_t *) data )->signature[ 0 ],

     ( (vhdi_file_information_t *) data )->signature[ 1 ],

     ( (vhdi_file_information_t *) data )->signature[ 2 ],

     ( (vhdi_file_information_t *) data )->signature[ 3 ],

     ( (vhdi_file_information_t *) data )->signature[ 4 ],

     ( (vhdi_file_information_t *) data )->signature[ 5 ],

     ( (vhdi_file_information_t *) data )->signature[ 6 ],

     ( (vhdi_file_information_t *) data )->signature[ 7 ] );

    if( libvhdi_debug_print_utf16_string_value(

         function,

         "creator\t\t\t\t",

         file_information->creator,

         512,

         LIBUNA_ENDIAN_LITTLE,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,

       "%s: unable to print UTF-16 string value.",

       function );

      return( -1 );

    }

    libcnotify_printf(

     "\n" );

  }

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

  return( 1 );

}

/* Reads the file information

 * Returns 1 if successful, 0 if signature does not match or -1 on error

 */

int libvhdi_file_information_read_file_io_handle(

     libvhdi_file_information_t *file_information,

     libbfio_handle_t *file_io_handle,

     off64_t file_offset,

     libcerror_error_t **error )

{

  uint8_t file_information_data[ sizeof( vhdi_file_information_t ) ];

  static char *function = "libvhdi_file_information_read_file_io_handle";

  ssize_t read_count    = 0;

  int result            = 0;

  if( file_information == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid file information.",

     function );

    return( -1 );

  }

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    libcnotify_printf(

     "%s: reading file information at offset: %" PRIi64 " (0x%08" PRIx64 ").\n",

     function,

     file_offset,

     file_offset );

  }

#endif

  read_count = libbfio_handle_read_buffer_at_offset(

                file_io_handle,

                file_information_data,

                sizeof( vhdi_file_information_t ),

                file_offset,

                error );

  if( read_count != (ssize_t) sizeof( vhdi_file_information_t ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_IO,

     LIBCERROR_IO_ERROR_READ_FAILED,

     "%s: unable to read file information data at offset: %" PRIi64 " (0x%08" PRIx64 ").",

     function,

     file_offset,

     file_offset );

    return( -1 );

  }

  result = libvhdi_file_information_read_data(

            file_information,

            file_information_data,

            sizeof( vhdi_file_information_t ),

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_IO,

     LIBCERROR_IO_ERROR_READ_FAILED,

     "%s: unable to read file information.",

     function );

    return( -1 );

  }

  return( result );

}