/*
 * Library to access the Extended File System (ext) format
 *
 * Copyright (C) 2021-2023, 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/>.
 */

#if !defined( _LIBFSFAT_H )
#define _LIBFSFAT_H

#include <libfsfat/codepage.h>
#include <libfsfat/definitions.h>
#include <libfsfat/error.h>
#include <libfsfat/extern.h>
#include <libfsfat/features.h>
#include <libfsfat/types.h>

#include <stdio.h>

#if defined( LIBFSFAT_HAVE_BFIO )
#include <libbfio.h>
#endif

#if defined( __cplusplus )
extern "C" {
#endif

/* -------------------------------------------------------------------------
 * Support functions
 * ------------------------------------------------------------------------- */

/* Returns the library version
 */
LIBFSFAT_EXTERN \
const char *libfsfat_get_version(
             void );

/* Returns the access flags for reading
 */
LIBFSFAT_EXTERN \
int libfsfat_get_access_flags_read(
     void );

/* Retrieves the narrow system string codepage
 * A value of 0 represents no codepage, UTF-8 encoding is used instead
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_get_codepage(
     int *codepage,
     libfsfat_error_t **error );

/* Sets the narrow system string codepage
 * A value of 0 represents no codepage, UTF-8 encoding is used instead
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_set_codepage(
     int codepage,
     libfsfat_error_t **error );

/* Determines if a file contains an ext volume signature
 * Returns 1 if true, 0 if not or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_check_volume_signature(
     const char *filename,
     libfsfat_error_t **error );

#if defined( LIBFSFAT_HAVE_WIDE_CHARACTER_TYPE )

/* Determines if a file contains an ext volume signature
 * Returns 1 if true, 0 if not or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_check_volume_signature_wide(
     const wchar_t *filename,
     libfsfat_error_t **error );

#endif /* defined( LIBFSFAT_HAVE_WIDE_CHARACTER_TYPE ) */

#if defined( LIBFSFAT_HAVE_BFIO )

/* Determines if a file contains an ext volume signature using a Basic File IO (bfio) handle
 * Returns 1 if true, 0 if not or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_check_volume_signature_file_io_handle(
     libbfio_handle_t *file_io_handle,
     libfsfat_error_t **error );

#endif /* defined( LIBFSFAT_HAVE_BFIO ) */

/* -------------------------------------------------------------------------
 * Notify functions
 * ------------------------------------------------------------------------- */

/* Sets the verbose notification
 */
LIBFSFAT_EXTERN \
void libfsfat_notify_set_verbose(
      int verbose );

/* Sets the notification stream
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_notify_set_stream(
     FILE *stream,
     libfsfat_error_t **error );

/* Opens the notification stream using a filename
 * The stream is opened in append mode
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_notify_stream_open(
     const char *filename,
     libfsfat_error_t **error );

/* Closes the notification stream if opened using a filename
 * Returns 0 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_notify_stream_close(
     libfsfat_error_t **error );

/* -------------------------------------------------------------------------
 * Error functions
 * ------------------------------------------------------------------------- */

/* Frees an error
 */
LIBFSFAT_EXTERN \
void libfsfat_error_free(
      libfsfat_error_t **error );

/* Prints a descriptive string of the error to the stream
 * Returns the number of printed characters if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_error_fprint(
     libfsfat_error_t *error,
     FILE *stream );

/* Prints a descriptive string of the error to the string
 * The end-of-string character is not included in the return value
 * Returns the number of printed characters if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_error_sprint(
     libfsfat_error_t *error,
     char *string,
     size_t size );

/* Prints a backtrace of the error to the stream
 * Returns the number of printed characters if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_error_backtrace_fprint(
     libfsfat_error_t *error,
     FILE *stream );

/* Prints a backtrace of the error to the string
 * The end-of-string character is not included in the return value
 * Returns the number of printed characters if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_error_backtrace_sprint(
     libfsfat_error_t *error,
     char *string,
     size_t size );

/* -------------------------------------------------------------------------
 * Volume functions
 * ------------------------------------------------------------------------- */

/* Creates a volume
 * Make sure the value volume is referencing, is set to NULL
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_initialize(
     libfsfat_volume_t **volume,
     libfsfat_error_t **error );

/* Frees a volume
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_free(
     libfsfat_volume_t **volume,
     libfsfat_error_t **error );

/* Signals the volume to abort its current activity
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_signal_abort(
     libfsfat_volume_t *volume,
     libfsfat_error_t **error );

/* Opens a volume
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_open(
     libfsfat_volume_t *volume,
     const char *filename,
     int access_flags,
     libfsfat_error_t **error );

#if defined( LIBFSFAT_HAVE_WIDE_CHARACTER_TYPE )

/* Opens a volume
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_open_wide(
     libfsfat_volume_t *volume,
     const wchar_t *filename,
     int access_flags,
     libfsfat_error_t **error );

#endif /* defined( LIBFSFAT_HAVE_WIDE_CHARACTER_TYPE ) */

#if defined( LIBFSFAT_HAVE_BFIO )

/* Opens a volume using a Basic File IO (bfio) handle
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_open_file_io_handle(
     libfsfat_volume_t *volume,
     libbfio_handle_t *file_io_handle,
     int access_flags,
     libfsfat_error_t **error );

#endif /* defined( LIBFSFAT_HAVE_BFIO ) */

/* Closes a volume
 * Returns 0 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_close(
     libfsfat_volume_t *volume,
     libfsfat_error_t **error );

/* Retrieves the file system format
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_file_system_format(
     libfsfat_volume_t *volume,
     uint8_t *file_system_format,
     libfsfat_error_t **error );

/* Retrieves the size of the UTF-8 encoded label
 * The returned size includes the end of string character
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_utf8_label_size(
     libfsfat_volume_t *volume,
     size_t *utf8_string_size,
     libfsfat_error_t **error );

/* Retrieves the UTF-8 encoded label
 * The size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_utf8_label(
     libfsfat_volume_t *volume,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     libfsfat_error_t **error );

/* Retrieves the size of the UTF-16 encoded label
 * The returned size includes the end of string character
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_utf16_label_size(
     libfsfat_volume_t *volume,
     size_t *utf16_string_size,
     libfsfat_error_t **error );

/* Retrieves the UTF-16 encoded label
 * The size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_utf16_label(
     libfsfat_volume_t *volume,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     libfsfat_error_t **error );

/* Retrieves the root directory file entry
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_root_directory(
     libfsfat_volume_t *volume,
     libfsfat_file_entry_t **file_entry,
     libfsfat_error_t **error );

/* Retrieves the file entry of a specific (virtual) identifier
 * The identifier is the offset of the short name directory entry
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_file_entry_by_identifier(
     libfsfat_volume_t *volume,
     uint64_t identifier,
     libfsfat_file_entry_t **file_entry,
     libfsfat_error_t **error );

/* Retrieves the file entry for an UTF-8 encoded path
 * Returns 1 if successful, 0 if no such file entry or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_file_entry_by_utf8_path(
     libfsfat_volume_t *volume,
     const uint8_t *utf8_string,
     size_t utf8_string_length,
     libfsfat_file_entry_t **file_entry,
     libfsfat_error_t **error );

/* Retrieves the file entry for an UTF-16 encoded path
 * Returns 1 if successful, 0 if no such file entry or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_volume_get_file_entry_by_utf16_path(
     libfsfat_volume_t *volume,
     const uint16_t *utf16_string,
     size_t utf16_string_length,
     libfsfat_file_entry_t **file_entry,
     libfsfat_error_t **error );

/* -------------------------------------------------------------------------
 * File entry functions
 * ------------------------------------------------------------------------- */

/* Frees a file entry
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_free(
     libfsfat_file_entry_t **file_entry,
     libfsfat_error_t **error );

/* Retrieves the (virtual) identifier
 * The identifier is the offset of the short name directory entry
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_identifier(
     libfsfat_file_entry_t *file_entry,
     uint64_t *identifier,
     libfsfat_error_t **error );

/* Retrieves the access date and time
 * The timestamp is an unsigned 64-bit integer containing the 10 milli seconds intervals since January 1, 1980
 * This value is retrieved from the short file name directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_access_time(
     libfsfat_file_entry_t *file_entry,
     uint64_t *fat_timestamp,
     libfsfat_error_t **error );

/* Retrieves the creation date and time
 * The timestamp is an unsigned 64-bit integer containing the 10 milli seconds intervals since January 1, 1980
 * This value is retrieved from the short file name directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_creation_time(
     libfsfat_file_entry_t *file_entry,
     uint64_t *fat_timestamp,
     libfsfat_error_t **error );

/* Retrieves the modification date and time
 * The timestamp is an unsigned 64-bit integer containing the 10 milli seconds intervals since January 1, 1980
 * This value is retrieved from the short file name directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_modification_time(
     libfsfat_file_entry_t *file_entry,
     uint64_t *fat_timestamp,
     libfsfat_error_t **error );

/* Retrieves the file attribute flags
 * This value is retrieved from the short file name directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_file_attribute_flags(
     libfsfat_file_entry_t *file_entry,
     uint16_t *file_attribute_flags,
     libfsfat_error_t **error );

/* Retrieves the size of the UTF-8 encoded name
 * The returned size includes the end of string character
 * This value is retrieved from the directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_utf8_name_size(
     libfsfat_file_entry_t *file_entry,
     size_t *utf8_string_size,
     libfsfat_error_t **error );

/* Retrieves the UTF-8 encoded name
 * The size should include the end of string character
 * This value is retrieved from the directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_utf8_name(
     libfsfat_file_entry_t *file_entry,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     libfsfat_error_t **error );

/* Retrieves the size of the UTF-16 encoded name
 * The returned size includes the end of string character
 * This value is retrieved from the directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_utf16_name_size(
     libfsfat_file_entry_t *file_entry,
     size_t *utf16_string_size,
     libfsfat_error_t **error );

/* Retrieves the UTF-16 encoded name
 * The size should include the end of string character
 * This value is retrieved from the directory entry
 * Returns 1 if successful, 0 if not available or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_utf16_name(
     libfsfat_file_entry_t *file_entry,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     libfsfat_error_t **error );

/* Retrieves the number of sub file entries
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_number_of_sub_file_entries(
     libfsfat_file_entry_t *file_entry,
     int *number_of_sub_entries,
     libfsfat_error_t **error );

/* Retrieves the sub file entry for the specific index
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_sub_file_entry_by_index(
     libfsfat_file_entry_t *file_entry,
     int sub_file_entry_index,
     libfsfat_file_entry_t **sub_file_entry,
     libfsfat_error_t **error );

/* Retrieves the sub file entry for an UTF-8 encoded name
 * Returns 1 if successful, 0 if the file entry does not contain such value or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_sub_file_entry_by_utf8_name(
     libfsfat_file_entry_t *file_entry,
     const uint8_t *utf8_string,
     size_t utf8_string_length,
     libfsfat_file_entry_t **sub_file_entry,
     libfsfat_error_t **error );

/* Retrieves the sub file entry for an UTF-16 encoded name
 * Returns 1 if successful, 0 if the file entry does not contain such value or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_sub_file_entry_by_utf16_name(
     libfsfat_file_entry_t *file_entry,
     const uint16_t *utf16_string,
     size_t utf16_string_length,
     libfsfat_file_entry_t **sub_file_entry,
     libfsfat_error_t **error );

/* Reads data at the current offset
 * Returns the number of bytes read or -1 on error
 */
LIBFSFAT_EXTERN \
ssize_t libfsfat_file_entry_read_buffer(
         libfsfat_file_entry_t *file_entry,
         void *buffer,
         size_t buffer_size,
         libfsfat_error_t **error );

/* Reads data at a specific offset
 * Returns the number of bytes read or -1 on error
 */
LIBFSFAT_EXTERN \
ssize_t libfsfat_file_entry_read_buffer_at_offset(
         libfsfat_file_entry_t *file_entry,
         void *buffer,
         size_t buffer_size,
         off64_t offset,
         libfsfat_error_t **error );

/* Seeks a certain offset
 * Returns the offset if seek is successful or -1 on error
 */
LIBFSFAT_EXTERN \
off64_t libfsfat_file_entry_seek_offset(
         libfsfat_file_entry_t *file_entry,
         off64_t offset,
         int whence,
         libfsfat_error_t **error );

/* Retrieves the current offset
 * Returns the offset if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_offset(
     libfsfat_file_entry_t *file_entry,
     off64_t *offset,
     libfsfat_error_t **error );

/* Retrieves the size of the data
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_size(
     libfsfat_file_entry_t *file_entry,
     size64_t *size,
     libfsfat_error_t **error );

/* Retrieves the number of extents
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_number_of_extents(
     libfsfat_file_entry_t *file_entry,
     int *number_of_extents,
     libfsfat_error_t **error );

/* Retrieves a specific extent
 * Returns 1 if successful or -1 on error
 */
LIBFSFAT_EXTERN \
int libfsfat_file_entry_get_extent_by_index(
     libfsfat_file_entry_t *file_entry,
     int extent_index,
     off64_t *extent_offset,
     size64_t *extent_size,
     uint32_t *extent_flags,
     libfsfat_error_t **error );

#if defined( __cplusplus )
}
#endif

#endif /* !defined( _LIBFSFAT_H ) */

