filesystem.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */
 
#pragma once
 
#ifndef C_API_FILESYSTEM_H
#define C_API_FILESYSTEM_H
 
#include <stdbool.h>
#include <stdint.h>
#include <time.h>
 
#ifdef _WIN32 // windows
#ifndef _SSIZE_T_DEFINED
typedef intptr_t ssize_t;
#define _SSIZE_T_DEFINED
#endif // !_SSIZE_T_DEFINED
 
// Prevent conflicts with Windows macros where have this names.
#ifdef CreateDirectory
#undef CreateDirectory
#endif // CreateDirectory
#ifdef DeleteFile
#undef DeleteFile
#endif // DeleteFile
#ifdef RemoveDirectory
#undef RemoveDirectory
#endif // RemoveDirectory
#endif // _WIN32
 
#ifdef TARGET_POSIX // Linux, Mac, FreeBSD
#include <sys/types.h>
#endif // TARGET_POSIX
 
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
 
  //¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  // "C" Definitions, structures and enumerators of filesystem
  //{{{
 
  //============================================================================
  typedef enum OpenFileFlags
  {
    ADDON_READ_TRUNCATED = 0x01,
 
    ADDON_READ_CHUNKED = 0x02,
 
    ADDON_READ_CACHED = 0x04,
 
    ADDON_READ_NO_CACHE = 0x08,
 
    ADDON_READ_BITRATE = 0x10,
 
    ADDON_READ_MULTI_STREAM = 0x20,
 
    ADDON_READ_AUDIO_VIDEO = 0x40,
 
    ADDON_READ_AFTER_WRITE = 0x80,
 
    ADDON_READ_REOPEN = 0x100
  } OpenFileFlags;
  //----------------------------------------------------------------------------
 
  //============================================================================
 
  typedef enum CURLOptiontype
  {
    ADDON_CURL_OPTION_OPTION,
 
    ADDON_CURL_OPTION_PROTOCOL,
 
    ADDON_CURL_OPTION_CREDENTIALS,
 
    ADDON_CURL_OPTION_HEADER
  } CURLOptiontype;
  //----------------------------------------------------------------------------
 
  //============================================================================
 
  typedef enum FilePropertyTypes
  {
    ADDON_FILE_PROPERTY_RESPONSE_PROTOCOL,
    ADDON_FILE_PROPERTY_RESPONSE_HEADER,
    ADDON_FILE_PROPERTY_CONTENT_TYPE,
    ADDON_FILE_PROPERTY_CONTENT_CHARSET,
    ADDON_FILE_PROPERTY_MIME_TYPE,
    ADDON_FILE_PROPERTY_EFFECTIVE_URL
  } FilePropertyTypes;
  //----------------------------------------------------------------------------
 
  //}}}
 
  //¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  // "C" Internal interface tables for intercommunications between addon and kodi
  //{{{
 
  struct KODI_HTTP_HEADER
  {
    void* handle;
 
    char* (*get_value)(void* kodiBase, void* handle, const char* param);
    char** (*get_values)(void* kodiBase, void* handle, const char* param, int* length);
    char* (*get_header)(void* kodiBase, void* handle);
    char* (*get_mime_type)(void* kodiBase, void* handle);
    char* (*get_charset)(void* kodiBase, void* handle);
    char* (*get_proto_line)(void* kodiBase, void* handle);
  };
 
  struct STAT_STRUCTURE
  {
    uint32_t deviceId;
    uint64_t size;
    time_t accessTime;
    time_t modificationTime;
    time_t statusTime;
    bool isDirectory;
    bool isSymLink;
    bool isBlock;
    bool isCharacter;
    bool isFifo;
    bool isRegular;
    bool isSocket;
    uint64_t fileSerialNumber;
  };
 
  struct VFS_CACHE_STATUS_DATA
  {
    uint64_t forward;
    unsigned int maxrate;
    unsigned int currate;
    bool lowspeed;
  };
 
  struct VFSProperty
  {
    char* name;
    char* val;
  };
 
  struct VFSDirEntry
  {
    char* label; 
    char* title; 
    char* path; 
    unsigned int num_props; 
    struct VFSProperty* properties; 
    time_t date_time; 
    bool folder; 
    uint64_t size; 
  };
 
  typedef struct AddonToKodiFuncTable_kodi_filesystem
  {
    bool (*can_open_directory)(void* kodiBase, const char* url);
    bool (*create_directory)(void* kodiBase, const char* path);
    bool (*remove_directory)(void* kodiBase, const char* path);
    bool (*directory_exists)(void* kodiBase, const char* path);
    bool (*get_directory)(void* kodiBase,
                          const char* path,
                          const char* mask,
                          struct VFSDirEntry** items,
                          unsigned int* num_items);
    void (*free_directory)(void* kodiBase, struct VFSDirEntry* items, unsigned int num_items);
 
    bool (*file_exists)(void* kodiBase, const char* filename, bool useCache);
    bool (*stat_file)(void* kodiBase, const char* filename, struct STAT_STRUCTURE* buffer);
    bool (*delete_file)(void* kodiBase, const char* filename);
    bool (*rename_file)(void* kodiBase, const char* filename, const char* newFileName);
    bool (*copy_file)(void* kodiBase, const char* filename, const char* dest);
 
    char* (*get_file_md5)(void* kodiBase, const char* filename);
    char* (*get_cache_thumb_name)(void* kodiBase, const char* filename);
    char* (*make_legal_filename)(void* kodiBase, const char* filename);
    char* (*make_legal_path)(void* kodiBase, const char* path);
    char* (*translate_special_protocol)(void* kodiBase, const char* strSource);
    bool (*is_internet_stream)(void* kodiBase, const char* path, bool strictCheck);
    bool (*is_on_lan)(void* kodiBase, const char* path);
    bool (*is_remote)(void* kodiBase, const char* path);
    bool (*is_local)(void* kodiBase, const char* path);
    bool (*is_url)(void* kodiBase, const char* path);
    bool (*get_http_header)(void* kodiBase, const char* url, struct KODI_HTTP_HEADER* headers);
    bool (*get_mime_type)(void* kodiBase, const char* url, char** content, const char* useragent);
    bool (*get_content_type)(void* kodiBase,
                             const char* url,
                             char** content,
                             const char* useragent);
    bool (*get_cookies)(void* kodiBase, const char* url, char** cookies);
    bool (*http_header_create)(void* kodiBase, struct KODI_HTTP_HEADER* headers);
    void (*http_header_free)(void* kodiBase, struct KODI_HTTP_HEADER* headers);
 
    void* (*open_file)(void* kodiBase, const char* filename, unsigned int flags);
    void* (*open_file_for_write)(void* kodiBase, const char* filename, bool overwrite);
    ssize_t (*read_file)(void* kodiBase, void* file, void* ptr, size_t size);
    bool (*read_file_string)(void* kodiBase, void* file, char* szLine, int iLineLength);
    ssize_t (*write_file)(void* kodiBase, void* file, const void* ptr, size_t size);
    void (*flush_file)(void* kodiBase, void* file);
    int64_t (*seek_file)(void* kodiBase, void* file, int64_t position, int whence);
    int (*truncate_file)(void* kodiBase, void* file, int64_t size);
    int64_t (*get_file_position)(void* kodiBase, void* file);
    int64_t (*get_file_length)(void* kodiBase, void* file);
    double (*get_file_download_speed)(void* kodiBase, void* file);
    void (*close_file)(void* kodiBase, void* file);
    int (*get_file_chunk_size)(void* kodiBase, void* file);
    bool (*io_control_get_seek_possible)(void* kodiBase, void* file);
    bool (*io_control_get_cache_status)(void* kodiBase,
                                        void* file,
                                        struct VFS_CACHE_STATUS_DATA* status);
    bool (*io_control_set_cache_rate)(void* kodiBase, void* file, unsigned int rate);
    bool (*io_control_set_retry)(void* kodiBase, void* file, bool retry);
    char** (*get_property_values)(
        void* kodiBase, void* file, int type, const char* name, int* numValues);
 
    void* (*curl_create)(void* kodiBase, const char* url);
    bool (*curl_add_option)(
        void* kodiBase, void* file, int type, const char* name, const char* value);
    bool (*curl_open)(void* kodiBase, void* file, unsigned int flags);
 
    bool (*get_disk_space)(
        void* kodiBase, const char* path, uint64_t* capacity, uint64_t* free, uint64_t* available);
    bool (*remove_directory_recursive)(void* kodiBase, const char* path);
  } AddonToKodiFuncTable_kodi_filesystem;
 
  //}}}
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* !C_API_FILESYSTEM_H */