/src/libmsiecf/libfdatetime/libfdatetime_filetime.c

Source (jump to first uncovered line)
/*
 * FILETIME functions
 *
 * Copyright (C) 2009-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 "libfdatetime_definitions.h"
#include "libfdatetime_date_time_values.h"
#include "libfdatetime_filetime.h"
#include "libfdatetime_libcerror.h"
#include "libfdatetime_types.h"

/* Creates a FILETIME
 * Make sure the value filetime is referencing, is set to NULL
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_initialize(
     libfdatetime_filetime_t **filetime,
     libcerror_error_t **error )
{
  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_initialize";

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  if( *filetime != NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,
     "%s: invalid FILETIME value already set.",
     function );

    return( -1 );
  }
  internal_filetime = memory_allocate_structure(
                       libfdatetime_internal_filetime_t );

  if( internal_filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create FILETIME.",
     function );

    goto on_error;
  }
  if( memory_set(
       internal_filetime,
       0,
       sizeof( libfdatetime_internal_filetime_t ) ) == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_SET_FAILED,
     "%s: unable to clear FILETIME.",
     function );

    goto on_error;
  }
  *filetime = (libfdatetime_filetime_t *) internal_filetime;

  return( 1 );

on_error:
  if( internal_filetime != NULL )
  {
    memory_free(
     internal_filetime );
  }
  return( -1 );
}

/* Frees a FILETIME
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_free(
     libfdatetime_filetime_t **filetime,
     libcerror_error_t **error )
{
  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_free";

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  if( *filetime != NULL )
  {
    internal_filetime = (libfdatetime_internal_filetime_t *) *filetime;
    *filetime         = NULL;

    memory_free(
     internal_filetime );
  }
  return( 1 );
}

/* Adds the additional FILETIME to the FILETIME
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_add(
     libfdatetime_filetime_t *filetime,
     libfdatetime_filetime_t *additional_filetime,
     libcerror_error_t **error )
{
  libfdatetime_internal_filetime_t *internal_additional_filetime = NULL;
  libfdatetime_internal_filetime_t *internal_filetime            = NULL;
  static char *function                                          = "libfdatetime_filetime_add";

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  internal_filetime = (libfdatetime_internal_filetime_t *) filetime;

  if( additional_filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid additional FILETIME.",
     function );

    return( -1 );
  }
  internal_additional_filetime = (libfdatetime_internal_filetime_t *) additional_filetime;

  internal_filetime->lower += internal_additional_filetime->lower;
  internal_filetime->upper += internal_additional_filetime->upper;

  return( 1 );
}

/* Converts a byte stream into a FILETIME
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_from_byte_stream(
     libfdatetime_filetime_t *filetime,
     const uint8_t *byte_stream,
     size_t byte_stream_size,
     int byte_order,
     libcerror_error_t **error )
{
  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_copy_from_byte_stream";

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  internal_filetime = (libfdatetime_internal_filetime_t *) filetime;

  if( byte_stream == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid byte stream.",
     function );

    return( -1 );
  }
  if( byte_stream_size < 8 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
     "%s: byte stream too small.",
     function );

    return( -1 );
  }
  if( byte_stream_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: byte stream size exceeds maximum.",
     function );

    return( -1 );
  }
  if( ( byte_order != LIBFDATETIME_ENDIAN_BIG )
   && ( byte_order != LIBFDATETIME_ENDIAN_LITTLE ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,
     "%s: unsupported byte order.",
     function );

    return( -1 );
  }
  if( byte_order == LIBFDATETIME_ENDIAN_LITTLE )
  {
    byte_stream_copy_to_uint32_little_endian(
     byte_stream,
     internal_filetime->lower );

    byte_stream += 4;

    byte_stream_copy_to_uint32_little_endian(
     byte_stream,
     internal_filetime->upper );
  }
  else if( byte_order == LIBFDATETIME_ENDIAN_BIG )
  {
    byte_stream_copy_to_uint32_big_endian(
     byte_stream,
     internal_filetime->upper );

    byte_stream += 4;

    byte_stream_copy_to_uint32_big_endian(
     byte_stream,
     internal_filetime->lower );
  }
  return( 1 );
}

/* Converts a 64-bit value into a FILETIME
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_from_64bit(
     libfdatetime_filetime_t *filetime,
     uint64_t value_64bit,
     libcerror_error_t **error )
{
  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_copy_from_64bit";

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  internal_filetime = (libfdatetime_internal_filetime_t *) filetime;

  internal_filetime->upper = value_64bit >> 32;
  internal_filetime->lower = value_64bit & 0xffffffffUL;

  return( 1 );
}

/* Converts a FILETIME into a 64-bit value
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_to_64bit(
     libfdatetime_filetime_t *filetime,
     uint64_t *value_64bit,
     libcerror_error_t **error )
{
  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_copy_to_64bit";

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  internal_filetime = (libfdatetime_internal_filetime_t *) filetime;

  if( value_64bit == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid 64-bit value.",
     function );

    return( -1 );
  }
  *value_64bit   = internal_filetime->upper;
  *value_64bit <<= 32;
  *value_64bit  |= internal_filetime->lower;

  return( 1 );
}

/* Converts a FILETIME into date time values
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_internal_filetime_copy_to_date_time_values(
     libfdatetime_internal_filetime_t *internal_filetime,
     libfdatetime_date_time_values_t *date_time_values,
     libcerror_error_t **error )
{
  static char *function    = "libfdatetime_internal_filetime_copy_to_date_time_values";
  uint64_t filetimestamp   = 0;
  uint32_t days_in_century = 0;
  uint16_t days_in_year    = 0;
  uint8_t days_in_month    = 0;

  if( internal_filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  if( date_time_values == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid date time values.",
     function );

    return( -1 );
  }
  /* Combine the lower and upper filetime parts into a single filetime timestamp
   */
  filetimestamp = ( (uint64_t) ( internal_filetime->upper ) << 32 ) + internal_filetime->lower;

  /* The timestamp is in units of 100 nano seconds correct the value to seconds
   */
  date_time_values->nano_seconds = ( filetimestamp % 10 ) * 100;
  filetimestamp                 /= 10;

  date_time_values->micro_seconds = filetimestamp % 1000;
  filetimestamp                  /= 1000;

  date_time_values->milli_seconds = filetimestamp % 1000;
  filetimestamp                  /= 1000;

  /* There are 60 seconds in a minute correct the value to minutes
   */
  date_time_values->seconds = filetimestamp % 60;
  filetimestamp            /= 60;

  /* There are 60 minutes in an hour correct the value to hours
   */
  date_time_values->minutes = filetimestamp % 60;
  filetimestamp            /= 60;

  /* There are 24 hours in a day correct the value to days
   */
  date_time_values->hours = filetimestamp % 24;
  filetimestamp          /= 24;

  /* Add 1 day to compensate that Jan 1 1601 is represented as 0
   */
  filetimestamp += 1;

  /* Determine the number of years starting at '1 Jan 1601 00:00:00'
   * correct the value to days within the year
   */
  date_time_values->year = 1601;

  if( filetimestamp >= 36159 )
  {
    date_time_values->year = 1700;

    filetimestamp -= 36159;
  }
  while( filetimestamp > 0 )
  {
    if( ( date_time_values->year % 400 ) == 0 )
    {
      days_in_century = 36525;
    }
    else
    {
      days_in_century = 36524;
    }
    if( filetimestamp <= days_in_century )
    {
      break;
    }
    filetimestamp -= days_in_century;

    date_time_values->year += 100;
  }
  while( filetimestamp > 0 )
  {
    /* Check for a leap year
     * The year is ( ( dividable by 4 ) and ( not dividable by 100 ) ) or ( dividable by 400 )
     */
    if( ( ( ( date_time_values->year % 4 ) == 0 )
      &&  ( ( date_time_values->year % 100 ) != 0 ) )
     || ( ( date_time_values->year % 400 ) == 0 ) )
    {
      days_in_year = 366;
    }
    else
    {
      days_in_year = 365;
    }
    if( filetimestamp <= days_in_year )
    {
      break;
    }
    filetimestamp -= days_in_year;

    date_time_values->year += 1;
  }
  if( date_time_values->year > 9999 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid FILETIME - year value out of bounds.",
     function );

    return( -1 );
  }
  /* Determine the month correct the value to days within the month
   */
  date_time_values->month = 1;

  while( filetimestamp > 0 )
  {
    /* February (2)
     */
    if( date_time_values->month == 2 )
    {
      if( ( ( ( date_time_values->year % 4 ) == 0 )
        &&  ( ( date_time_values->year % 100 ) != 0 ) )
       || ( ( date_time_values->year % 400 ) == 0 ) )
      {
        days_in_month = 29;
      }
      else
      {
        days_in_month = 28;
      }
    }
    /* April (4), June (6), September (9), November (11)
     */
    else if( ( date_time_values->month == 4 )
          || ( date_time_values->month == 6 )
          || ( date_time_values->month == 9 )
          || ( date_time_values->month == 11 ) )
    {
      days_in_month = 30;
    }
    /* January (1), March (3), May (5), July (7), August (8), October (10), December (12)
     */
    else if( ( date_time_values->month == 1 )
          || ( date_time_values->month == 3 )
          || ( date_time_values->month == 5 )
          || ( date_time_values->month == 7 )
          || ( date_time_values->month == 8 )
          || ( date_time_values->month == 10 )
          || ( date_time_values->month == 12 ) )
    {
      days_in_month = 31;
    }
    /* This should never happen, but just in case
     */
    else
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported month: %d.",
       function,
       date_time_values->month );

      return( -1 );
    }
    if( filetimestamp <= days_in_month )
    {
      break;
    }
    filetimestamp -= days_in_month;

    date_time_values->month += 1;
  }
  /* Determine the day
   */
  date_time_values->day = (uint8_t) filetimestamp;

  return( 1 );
}

/* Deterimes the size of the string for the FILETIME
 * The string size includes the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_get_string_size(
     libfdatetime_filetime_t *filetime,
     size_t *string_size,
     uint32_t string_format_flags,
     libcerror_error_t **error )
{
  libfdatetime_date_time_values_t date_time_values;

  static char *function = "libfdatetime_filetime_get_string_size";
  int result            = 0;

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  if( string_size == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid string size.",
     function );

    return( -1 );
  }
  result = libfdatetime_internal_filetime_copy_to_date_time_values(
            (libfdatetime_internal_filetime_t *) filetime,
            &date_time_values,
            error );

  if( result != 1 )
  {
#if defined( HAVE_DEBUG_OUTPUT )
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to set date time values.",
     function );

/* TODO debug print error */

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

    if( ( error != NULL )
     && ( *error != NULL ) )
    {
      libcerror_error_free(
       error );
    }
  }
  else
  {
    result = libfdatetime_date_time_values_get_string_size(
              &date_time_values,
              string_size,
              string_format_flags,
              error );

    if( result == -1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_GET_FAILED,
       "%s: unable to get string size.",
       function );

      return( -1 );
    }
  }
  if( result != 1 )
  {
    /* Make sure the string can hold the hexadecimal representation of the filetime
     */
    *string_size = 24;
  }
  return( 1 );
}

/* Converts the FILETIME into an UTF-8 string in hexadecimal representation
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_internal_filetime_copy_to_utf8_string_in_hexadecimal(
     libfdatetime_internal_filetime_t *internal_filetime,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     size_t *utf8_string_index,
     libcerror_error_t **error )
{
  static char *function = "libfdatetime_internal_filetime_copy_to_utf8_string_in_hexadecimal";
  size_t string_index   = 0;
  uint8_t byte_value    = 0;
  int8_t byte_shift     = 0;

  if( internal_filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  if( utf8_string == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid UTF-8 string.",
     function );

    return( -1 );
  }
  if( utf8_string_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid UTF-8 string size value exceeds maximum.",
     function );

    return( -1 );
  }
  if( utf8_string_index == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid UTF-8 string index.",
     function );

    return( -1 );
  }
  if( ( utf8_string_size < 24 )
   || ( *utf8_string_index > ( utf8_string_size - 24 ) ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
     "%s: UTF-8 string is too small.",
     function );

    return( -1 );
  }
  string_index = *utf8_string_index;

  utf8_string[ string_index++ ] = (uint8_t) '(';
  utf8_string[ string_index++ ] = (uint8_t) '0';
  utf8_string[ string_index++ ] = (uint8_t) 'x';

  byte_shift = 28;

  do
  {
    byte_value = ( internal_filetime->upper >> byte_shift ) & 0x0f;

    if( byte_value <= 9 )
    {
      utf8_string[ string_index++ ] = (uint8_t) '0' + byte_value;
    }
    else
    {
      utf8_string[ string_index++ ] = (uint8_t) 'a' + byte_value - 10;
    }
    byte_shift -= 4;
  }
  while( byte_shift >= 0 );

  utf8_string[ string_index++ ] = (uint8_t) ' ';
  utf8_string[ string_index++ ] = (uint8_t) '0';
  utf8_string[ string_index++ ] = (uint8_t) 'x';

  byte_shift = 28;

  do
  {
    byte_value = ( internal_filetime->lower >> byte_shift ) & 0x0f;

    if( byte_value <= 9 )
    {
      utf8_string[ string_index++ ] = (uint8_t) '0' + byte_value;
    }
    else
    {
      utf8_string[ string_index++ ] = (uint8_t) 'a' + byte_value - 10;
    }
    byte_shift -= 4;
  }
  while( byte_shift >= 0 );

  utf8_string[ string_index++ ] = (uint8_t) ')';

  utf8_string[ string_index++ ] = 0;

  *utf8_string_index = string_index;

  return( 1 );
}

/* Converts the FILETIME into an UTF-8 string
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_to_utf8_string(
     libfdatetime_filetime_t *filetime,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     uint32_t string_format_flags,
     libcerror_error_t **error )
{
  static char *function    = "libfdatetime_filetime_copy_to_utf8_string";
  size_t utf8_string_index = 0;

  if( libfdatetime_filetime_copy_to_utf8_string_with_index(
       filetime,
       utf8_string,
       utf8_string_size,
       &utf8_string_index,
       string_format_flags,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_COPY_FAILED,
     "%s: unable to copy FILETIME to UTF-8 string.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Converts the FILETIME into an UTF-8 string
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_to_utf8_string_with_index(
     libfdatetime_filetime_t *filetime,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     size_t *utf8_string_index,
     uint32_t string_format_flags,
     libcerror_error_t **error )
{
  libfdatetime_date_time_values_t date_time_values;

  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_copy_to_utf8_string_with_index";
  int result                                          = 0;

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  internal_filetime = (libfdatetime_internal_filetime_t *) filetime;

  result = libfdatetime_internal_filetime_copy_to_date_time_values(
            internal_filetime,
            &date_time_values,
            error );

  if( result != 1 )
  {
#if defined( HAVE_DEBUG_OUTPUT )
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to set date time values.",
     function );

/* TODO debug print error */

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

    if( ( error != NULL )
     && ( *error != NULL ) )
    {
      libcerror_error_free(
       error );
    }
  }
  else
  {
    result = libfdatetime_date_time_values_copy_to_utf8_string_with_index(
              &date_time_values,
              utf8_string,
              utf8_string_size,
              utf8_string_index,
              string_format_flags,
              error );

    if( result == -1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_SET_FAILED,
       "%s: unable to copy date time values to UTF-8 string.",
       function );

      return( -1 );
    }
  }
  if( result != 1 )
  {
    result = libfdatetime_internal_filetime_copy_to_utf8_string_in_hexadecimal(
              internal_filetime,
              utf8_string,
              utf8_string_size,
              utf8_string_index,
              error );

    if( result == -1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_SET_FAILED,
       "%s: unable to FILETIME to hexadecimal UTF-8 string.",
       function );

      return( -1 );
    }
  }
  return( 1 );
}

/* Converts the FILETIME into an UTF-16 string in hexadecimal representation
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_internal_filetime_copy_to_utf16_string_in_hexadecimal(
     libfdatetime_internal_filetime_t *internal_filetime,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     size_t *utf16_string_index,
     libcerror_error_t **error )
{
  static char *function = "libfdatetime_internal_filetime_copy_to_utf16_string_in_hexadecimal";
  size_t string_index   = 0;
  uint8_t byte_value    = 0;
  int8_t byte_shift     = 0;

  if( internal_filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  if( utf16_string == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid UTF-16 string.",
     function );

    return( -1 );
  }
  if( utf16_string_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid UTF-16 string size value exceeds maximum.",
     function );

    return( -1 );
  }
  if( utf16_string_index == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid UTF-16 string index.",
     function );

    return( -1 );
  }
  if( ( utf16_string_size < 24 )
   || ( *utf16_string_index > ( utf16_string_size - 24 ) ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
     "%s: UTF-16 string is too small.",
     function );

    return( -1 );
  }
  string_index = *utf16_string_index;

  utf16_string[ string_index++ ] = (uint16_t) '(';
  utf16_string[ string_index++ ] = (uint16_t) '0';
  utf16_string[ string_index++ ] = (uint16_t) 'x';

  byte_shift = 28;

  do
  {
    byte_value = ( internal_filetime->upper >> byte_shift ) & 0x0f;

    if( byte_value <= 9 )
    {
      utf16_string[ string_index++ ] = (uint16_t) '0' + byte_value;
    }
    else
    {
      utf16_string[ string_index++ ] = (uint16_t) 'a' + byte_value - 10;
    }
    byte_shift -= 4;
  }
  while( byte_shift >= 0 );

  utf16_string[ string_index++ ] = (uint16_t) ' ';
  utf16_string[ string_index++ ] = (uint16_t) '0';
  utf16_string[ string_index++ ] = (uint16_t) 'x';

  byte_shift = 28;

  do
  {
    byte_value = ( internal_filetime->lower >> byte_shift ) & 0x0f;

    if( byte_value <= 9 )
    {
      utf16_string[ string_index++ ] = (uint16_t) '0' + byte_value;
    }
    else
    {
      utf16_string[ string_index++ ] = (uint16_t) 'a' + byte_value - 10;
    }
    byte_shift -= 4;
  }
  while( byte_shift >= 0 );

  utf16_string[ string_index++ ] = (uint16_t) ')';

  utf16_string[ string_index++ ] = 0;

  *utf16_string_index = string_index;

  return( 1 );
}

/* Converts the FILETIME into an UTF-16 string
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_to_utf16_string(
     libfdatetime_filetime_t *filetime,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     uint32_t string_format_flags,
     libcerror_error_t **error )
{
  static char *function     = "libfdatetime_filetime_copy_to_utf16_string";
  size_t utf16_string_index = 0;

  if( libfdatetime_filetime_copy_to_utf16_string_with_index(
       filetime,
       utf16_string,
       utf16_string_size,
       &utf16_string_index,
       string_format_flags,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_COPY_FAILED,
     "%s: unable to copy FILETIME to UTF-16 string.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Converts the FILETIME into an UTF-16 string
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_to_utf16_string_with_index(
     libfdatetime_filetime_t *filetime,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     size_t *utf16_string_index,
     uint32_t string_format_flags,
     libcerror_error_t **error )
{
  libfdatetime_date_time_values_t date_time_values;

  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_copy_to_utf16_string_with_index";
  int result                                          = 0;

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  internal_filetime = (libfdatetime_internal_filetime_t *) filetime;

  result = libfdatetime_internal_filetime_copy_to_date_time_values(
            internal_filetime,
            &date_time_values,
            error );

  if( result != 1 )
  {
#if defined( HAVE_DEBUG_OUTPUT )
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to set date time values.",
     function );

/* TODO debug print error */

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

    if( ( error != NULL )
     && ( *error != NULL ) )
    {
      libcerror_error_free(
       error );
    }
  }
  else
  {
    result = libfdatetime_date_time_values_copy_to_utf16_string_with_index(
              &date_time_values,
              utf16_string,
              utf16_string_size,
              utf16_string_index,
              string_format_flags,
              error );

    if( result == -1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_SET_FAILED,
       "%s: unable to set UTF-16 string.",
       function );

      return( -1 );
    }
  }
  if( result != 1 )
  {
    if( utf16_string == NULL )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
       LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
       "%s: invalid UTF-16 string.",
       function );

      return( -1 );
    }
    if( utf16_string_size > (size_t) SSIZE_MAX )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
       LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
       "%s: unable to copy date time values to UTF-16 string.",
       function );

      return( -1 );
    }
  }
  if( result != 1 )
  {
    result = libfdatetime_internal_filetime_copy_to_utf16_string_in_hexadecimal(
              internal_filetime,
              utf16_string,
              utf16_string_size,
              utf16_string_index,
              error );

    if( result == -1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_SET_FAILED,
       "%s: unable to FILETIME to hexadecimal UTF-16 string.",
       function );

      return( -1 );
    }
  }
  return( 1 );
}

/* Converts the FILETIME into an UTF-32 string in hexadecimal representation
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_internal_filetime_copy_to_utf32_string_in_hexadecimal(
     libfdatetime_internal_filetime_t *internal_filetime,
     uint32_t *utf32_string,
     size_t utf32_string_size,
     size_t *utf32_string_index,
     libcerror_error_t **error )
{
  static char *function = "libfdatetime_internal_filetime_copy_to_utf32_string_in_hexadecimal";
  size_t string_index   = 0;
  uint8_t byte_value    = 0;
  int8_t byte_shift     = 0;

  if( internal_filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  if( utf32_string == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid UTF-32 string.",
     function );

    return( -1 );
  }
  if( utf32_string_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid UTF-32 string size value exceeds maximum.",
     function );

    return( -1 );
  }
  if( utf32_string_index == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid UTF-32 string index.",
     function );

    return( -1 );
  }
  if( ( utf32_string_size < 24 )
   || ( *utf32_string_index > ( utf32_string_size - 24 ) ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
     "%s: UTF-32 string is too small.",
     function );

    return( -1 );
  }
  string_index = *utf32_string_index;

  utf32_string[ string_index++ ] = (uint32_t) '(';
  utf32_string[ string_index++ ] = (uint32_t) '0';
  utf32_string[ string_index++ ] = (uint32_t) 'x';

  byte_shift = 28;

  do
  {
    byte_value = ( internal_filetime->upper >> byte_shift ) & 0x0f;

    if( byte_value <= 9 )
    {
      utf32_string[ string_index++ ] = (uint32_t) '0' + byte_value;
    }
    else
    {
      utf32_string[ string_index++ ] = (uint32_t) 'a' + byte_value - 10;
    }
    byte_shift -= 4;
  }
  while( byte_shift >= 0 );

  utf32_string[ string_index++ ] = (uint32_t) ' ';
  utf32_string[ string_index++ ] = (uint32_t) '0';
  utf32_string[ string_index++ ] = (uint32_t) 'x';

  byte_shift = 28;

  do
  {
    byte_value = ( internal_filetime->lower >> byte_shift ) & 0x0f;

    if( byte_value <= 9 )
    {
      utf32_string[ string_index++ ] = (uint32_t) '0' + byte_value;
    }
    else
    {
      utf32_string[ string_index++ ] = (uint32_t) 'a' + byte_value - 10;
    }
    byte_shift -= 4;
  }
  while( byte_shift >= 0 );

  utf32_string[ string_index++ ] = (uint32_t) ')';

  utf32_string[ string_index++ ] = 0;

  *utf32_string_index = string_index;

  return( 1 );
}

/* Converts the FILETIME into an UTF-32 string
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_to_utf32_string(
     libfdatetime_filetime_t *filetime,
     uint32_t *utf32_string,
     size_t utf32_string_size,
     uint32_t string_format_flags,
     libcerror_error_t **error )
{
  static char *function     = "libfdatetime_filetime_copy_to_utf32_string";
  size_t utf32_string_index = 0;

  if( libfdatetime_filetime_copy_to_utf32_string_with_index(
       filetime,
       utf32_string,
       utf32_string_size,
       &utf32_string_index,
       string_format_flags,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_COPY_FAILED,
     "%s: unable to copy FILETIME to UTF-32 string.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Converts the FILETIME into an UTF-32 string
 * The string size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfdatetime_filetime_copy_to_utf32_string_with_index(
     libfdatetime_filetime_t *filetime,
     uint32_t *utf32_string,
     size_t utf32_string_size,
     size_t *utf32_string_index,
     uint32_t string_format_flags,
     libcerror_error_t **error )
{
  libfdatetime_date_time_values_t date_time_values;

  libfdatetime_internal_filetime_t *internal_filetime = NULL;
  static char *function                               = "libfdatetime_filetime_copy_to_utf32_string_with_index";
  int result                                          = 0;

  if( filetime == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid FILETIME.",
     function );

    return( -1 );
  }
  internal_filetime = (libfdatetime_internal_filetime_t *) filetime;

  result = libfdatetime_internal_filetime_copy_to_date_time_values(
            internal_filetime,
            &date_time_values,
            error );

  if( result != 1 )
  {
#if defined( HAVE_DEBUG_OUTPUT )
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to set date time values.",
     function );

/* TODO debug print error */

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

    if( ( error != NULL )
     && ( *error != NULL ) )
    {
      libcerror_error_free(
       error );
    }
  }
  else
  {
    result = libfdatetime_date_time_values_copy_to_utf32_string_with_index(
              &date_time_values,
              utf32_string,
              utf32_string_size,
              utf32_string_index,
              string_format_flags,
              error );

    if( result == -1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_SET_FAILED,
       "%s: unable to copy date time values to UTF-32 string.",
       function );

      return( -1 );
    }
  }
  if( result != 1 )
  {
    result = libfdatetime_internal_filetime_copy_to_utf32_string_in_hexadecimal(
              internal_filetime,
              utf32_string,
              utf32_string_size,
              utf32_string_index,
              error );

    if( result == -1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_SET_FAILED,
       "%s: unable to FILETIME to hexadecimal UTF-32 string.",
       function );

      return( -1 );
    }
  }
  return( 1 );
}


Coverage Report

Created: 2025-06-13 07:21