/*
   BAREOS® - Backup Archiving REcovery Open Sourced

   Copyright (C) 2007-2012 Free Software Foundation Europe e.V.
   Copyright (C) 2011-2012 Planets Communications B.V.
   Copyright (C) 2013-2026 Bareos GmbH & Co. KG

   This program is Free Software; you can redistribute it and/or
   modify it under the terms of version three of the GNU Affero General Public
   License as published by the Free Software Foundation, which is
   listed in the file LICENSE.

   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
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.
*/
/*
 * Application Programming Interface (API) definition for Bareos Plugins
 *
 * Kern Sibbald, October 2007
 */

#ifndef BAREOS_FILED_FD_PLUGINS_H_
#define BAREOS_FILED_FD_PLUGINS_H_

#ifndef BAREOS_INCLUDE_BAREOS_H_
#  ifdef __cplusplus
/* Workaround for SGI IRIX 6.5 */
#    define _LANGUAGE_C_PLUS_PLUS 1
#  endif
#  define _REENTRANT 1
#  define _THREAD_SAFE 1
#  define _POSIX_PTHREAD_SEMANTICS 1
#  define _FILE_OFFSET_BITS 64
#  define _LARGEFILE_SOURCE 1
#  define _LARGE_FILES 1
#endif /* ! BAREOS_INCLUDE_BAREOS_H_ */

#include <sys/types.h>

#include "include/config.h"
#include "include/compiler_macro.h"

#include "lib/version.h"
#include "include/bc_types.h"
#include "include/fileopts.h"
#include "lib/attr.h"
#include "lib/plugins.h"
#include <sys/stat.h>

#ifdef HAVE_WIN32
#  include "vss.h"
#endif

#ifdef FILE_DAEMON
struct BareosFilePacket;
struct FindFilesPacket;
#endif /* FILE_DAEMON */

struct IoStatus {
  static constexpr int error = -1;
  static constexpr int success = 0;
  static constexpr int do_io_in_core = 1;
};

template <typename T> class alist;

namespace filedaemon {

/*
 * This packet is used for the restore objects
 *  It is passed to the plugin when restoring
 *  the object.
 */
struct restore_object_pkt {
  int32_t pkt_size;           /* Size of this packet */
  char* object_name;          /* Object name */
  char* object;               /* Restore object data to save */
  char* plugin_name;          /* Plugin name */
  int32_t object_type;        /* FT_xx for this file */
  int32_t object_len;         /* Restore object length */
  int32_t object_full_len;    /* Restore object uncompressed length */
  int32_t object_index;       /* Restore object index */
  int32_t object_compression; /* Set to compression type */
  int32_t stream;             /* Attribute stream id */
  uint32_t JobId;             /* JobId object came from */
  int32_t pkt_end;            /* End packet sentinel */
};

// This packet is used for file save info transfer.
struct save_pkt {
  int32_t pkt_size{sizeof(save_pkt)}; /* Size of this packet */
  char* fname{};                      /* Full path and filename */
  char* link{};                       /* Link name if any */
  struct stat statp{};                /* System stat() packet for file */
  int32_t type{};                     /* FT_xx for this file */
  char flags[FOPTS_BYTES]{};          /* Bareos internal flags */
  bool no_read{}; /* During the save, the file should not be saved */

  // backup data from windows clients (even plugin data) is assumed to be
  // a valid windows backup data stream by default.
  // If a plugin or the core does _not_ create a valid windows backup data
  // stream, then it should set "portable" to true.

  // pre-25.0.0 plugin data was always assumed to be nonportable,
  // so non-windows clients could not even try to restore that data from
  // windows clients.
  // now plugin data is always assumed to be portable,
  // so this has no meaning anymore for the plugin (previously it was)
  // also not used at all and just set to true.
  bool portable{};       /* Set if data format is portable */
  bool accurate_found{}; /* Found in accurate list (valid after CheckChanges())
                          */
  char* cmd{};           /* Command */
  time_t save_time{};    /* Start of incremental time */
  uint32_t delta_seq{};  /* Delta sequence number */
  char* object_name{};   /* Object name to create */
  char* object{};        /* Restore object data to save */
  int32_t object_len{};  /* Restore object length */
  int32_t index{};       /* Restore object index */
  int32_t pkt_end{sizeof(save_pkt)}; /* End packet sentinel */
};

// This packet is used for file restore info transfer.
struct restore_pkt {
  int32_t pkt_size{sizeof(restore_pkt)}; /* Size of this packet */
  int32_t stream{};                      /* Attribute stream id */
  int32_t data_stream{};                 /* Id of data stream to follow */
  int32_t type{};                        /* File type FT */
  int32_t file_index{};                  /* File index */
  int32_t LinkFI{};                      /* File index to data if hard link */
  uid_t uid{};                           /* Userid */
  struct stat statp{};                   /* Decoded stat packet */
  const char* attrEx{};                  /* Extended attributes if any */
  const char* ofname{};                  /* Output filename */
  const char* olname{};                  /* Output link name */
  const char* where{};                   /* Where */
  const char* RegexWhere{};              /* Regex where */
  int replace{};                         /* Replace flag */
  int create_status{};                   /* Status from createFile() */
  uint32_t delta_seq{};                  /* Delta sequence number */
#if HAVE_WIN32
  HANDLE hndl; /* HANDLE to read/write in core */
#else
  int filedes{}; /* file descriptor to read/write in core */
#endif

  const char* original_file_name{}; /* original file name (without
                                       where/regexwhere applied) */
  const char* original_link_name{}; /* original link name (without
                                       where/regexwhere applied) */

  int32_t pkt_end{sizeof(restore_pkt)}; /* End packet sentinel */
};

enum
{
  IO_OPEN = 1,
  IO_READ = 2,
  IO_WRITE = 3,
  IO_CLOSE = 4,
  IO_SEEK = 5
};

struct io_pkt {
  int32_t pkt_size{sizeof(io_pkt)}; /* Size of this packet */
  int32_t func{IO_OPEN};            /* Function code */
  int32_t count{};                  /* Read/write count */
  int32_t flags{};                  /* Open flags */
  mode_t mode{};                    /* Permissions for created files */
  char* buf{};                      /* Read/write buffer */
  const char* fname{};              /* Open filename */
  int32_t status{};                 /* Return status */
  int32_t io_errno{};               /* Errno code */
  int32_t lerror{};                 /* Win32 error code */
  int32_t whence{};                 /* Lseek argument */
  boffset_t offset{};               /* Lseek argument */
  bool win32{};                     /* Win32 GetLastError returned */
#if HAVE_WIN32
  HANDLE hndl{}; /* file descriptor to read/write in core */
#else
  int filedes{}; /* file descriptor to read/write in core */
#endif
  int32_t pkt_end{sizeof(io_pkt)}; /* End packet sentinel */
};

struct acl_pkt {
  int32_t pkt_size{sizeof(acl_pkt)}; /* Size of this packet */
  const char* fname{};               /* Full path and filename */
  uint32_t content_length{};         /* ACL content length */
  char* content{};                   /* ACL content */
  int32_t pkt_end{sizeof(acl_pkt)};  /* End packet sentinel */
};

struct xattr_pkt {
  int32_t pkt_size{sizeof(xattr_pkt)}; /* Size of this packet */
  const char* fname{};                 /* Full path and filename */
  uint32_t name_length{};              /* XATTR name length */
  char* name{};                        /* XATTR name */
  uint32_t value_length{};             /* XATTR value length */
  char* value{};                       /* XATTR value */
  int32_t pkt_end{sizeof(xattr_pkt)};  /* End packet sentinel */
};

/****************************************************************************
 *                                                                          *
 *                Bareos definitions                                        *
 *                                                                          *
 ****************************************************************************/

// Bareos Variable Ids
typedef enum
    : int
{
  bVarJobId = 1,
  bVarFDName = 2,
  bVarLevel = 3,
  bVarType = 4,
  bVarClient = 5,
  bVarJobName = 6,
  bVarJobStatus = 7,
  bVarSinceTime = 8,
  bVarAccurate = 9,
  bVarFileSeen = 10,
  bVarVssClient = 11,
  bVarWorkingDir = 12,
  bVarWhere = 13,
  bVarRegexWhere = 14,
  bVarExePath = 15,
  bVarVersion = 16,
  bVarDistName = 17,
  bVarPrevJobName = 18,
  bVarPrefixLinks = 19,
  bVarCheckChanges = 20,
  bVarUsedConfig = 21,
  bVarPluginPath = 22,
} bVariable;

// Events that are passed to plugin
typedef enum
{
  bEventJobStart = 1,
  bEventJobEnd = 2,
  bEventStartBackupJob = 3,
  bEventEndBackupJob = 4,
  bEventStartRestoreJob = 5,
  bEventEndRestoreJob = 6,
  bEventStartVerifyJob = 7,
  bEventEndVerifyJob = 8,
  bEventBackupCommand = 9,
  bEventRestoreCommand = 10,
  bEventEstimateCommand = 11,
  bEventLevel = 12,
  bEventSince = 13,
  bEventCancelCommand = 14,
  bEventRestoreObject = 15,
  bEventEndFileSet = 16,
  bEventPluginCommand = 17,
  /* UNUSED */ bEventOptionPlugin = 18,
  bEventHandleBackupFile = 19,
  bEventNewPluginOptions = 20,
  bEventVssInitializeForBackup = 21,
  bEventVssInitializeForRestore = 22,
  bEventVssSetBackupState = 23,
  bEventVssPrepareForBackup = 24,
  bEventVssBackupAddComponents = 25,
  bEventVssPrepareSnapshot = 26,
  bEventVssCreateSnapshots = 27,
  bEventVssRestoreLoadComponentMetadata = 28,
  bEventVssRestoreSetComponentsSelected = 29,
  bEventVssCloseRestore = 30,
  bEventVssBackupComplete = 31
} bEventType;

#define FD_NR_EVENTS bEventVssBackupComplete /* keep this updated ! */

typedef struct s_bEvent {
  uint32_t eventType;
} bEvent;

typedef struct s_bareosInfo {
  uint32_t size;
  uint32_t version;
} PluginApiDefinition;

// Bareos Core Routines -- not used within a plugin
#ifdef FILE_DAEMON
void LoadFdPlugins(const char* plugin_dir, alist<const char*>* plugin_names);
void UnloadFdPlugins(void);
int ListFdPlugins(PoolMem& msg);
void NewPlugins(JobControlRecord* jcr);
void FreePlugins(JobControlRecord* jcr);
bRC GeneratePluginEvent(JobControlRecord* jcr,
                        bEventType event,
                        void* value = NULL);
bool SendPluginName(JobControlRecord* jcr, BareosSocket* sd, bool start);
bool PluginNameStream(JobControlRecord* jcr, char* name);
int PluginCreateFile(JobControlRecord* jcr,
                     Attributes* attr,
                     BareosFilePacket* bfd,
                     int replace);
bool PluginSetAttributes(JobControlRecord* jcr,
                         Attributes* attr,
                         BareosFilePacket* ofd);
bacl_exit_code PluginBuildAclStreams(JobControlRecord* jcr,
                                     AclBuildData* acl_data,
                                     FindFilesPacket* ff_pkt);
bacl_exit_code plugin_parse_acl_streams(JobControlRecord* jcr,
                                        AclData* acl_data,
                                        int stream,
                                        char* content,
                                        uint32_t content_length);
BxattrExitCode PluginBuildXattrStreams(JobControlRecord* jcr,
                                       XattrBuildData* xattr_data,
                                       FindFilesPacket* ff_pkt);
BxattrExitCode PluginParseXattrStreams(JobControlRecord* jcr,
                                       XattrData* xattr_data,
                                       int stream,
                                       char* content,
                                       uint32_t content_length);
int PluginSave(JobControlRecord* jcr, FindFilesPacket* ff_pkt, bool top_level);
int PluginEstimate(JobControlRecord* jcr,
                   FindFilesPacket* ff_pkt,
                   bool top_level);
bool PluginCheckFile(JobControlRecord* jcr, char* fname);
void PluginUpdateFfPkt(FindFilesPacket* ff_pkt, save_pkt* sp);
bRC PluginOptionHandleFile(JobControlRecord* jcr,
                           FindFilesPacket* ff_pkt,
                           save_pkt* sp);
#endif

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Bareos interface version and function pointers --
 *  i.e. callbacks from the plugin to Bareos
 */
typedef struct s_bareosFuncs {
  uint32_t size;
  uint32_t version;
  bRC (*registerBareosEvents)(PluginContext* ctx, int nr_events, ...);
  bRC (*unregisterBareosEvents)(PluginContext* ctx, int nr_events, ...);
  bRC (*getInstanceCount)(PluginContext* ctx, int* ret);
  bRC (*getBareosValue)(PluginContext* ctx, bVariable var, void* value);
  bRC (*setBareosValue)(PluginContext* ctx, bVariable var, const void* value);
  bRC (*JobMessage)(PluginContext* ctx,
                    const char* file,
                    int line,
                    int type,
                    utime_t mtime,
                    const char* fmt,
                    ...) PRINTF_LIKE(6, 7);
  bRC (*DebugMessage)(PluginContext* ctx,
                      const char* file,
                      int line,
                      int level,
                      const char* fmt,
                      ...) PRINTF_LIKE(5, 6);
  void* (*bareosMalloc)(PluginContext* ctx,
                        const char* file,
                        int line,
                        size_t size);
  void (*bareosFree)(PluginContext* ctx, const char* file, int line, void* mem);
  bRC (*AddExclude)(PluginContext* ctx, const char* file);
  bRC (*AddInclude)(PluginContext* ctx, const char* file);
  bRC (*AddOptions)(PluginContext* ctx, const char* opts);
  bRC (*AddRegex)(PluginContext* ctx, const char* item, int type);
  bRC (*AddWild)(PluginContext* ctx, const char* item, int type);
  bRC (*NewOptions)(PluginContext* ctx);
  bRC (*NewInclude)(PluginContext* ctx);
  bRC (*NewPreInclude)(PluginContext* ctx);
  bRC (*checkChanges)(PluginContext* ctx, save_pkt* sp);
  bRC (*AcceptFile)(PluginContext* ctx,
                    save_pkt* sp); /* Need fname and statp */
  bRC (*SetSeenBitmap)(PluginContext* ctx, bool all, char* fname);
  bRC (*ClearSeenBitmap)(PluginContext* ctx, bool all, char* fname);
} CoreFunctions;

/****************************************************************************
 *                                                                          *
 *                Plugin definitions                                        *
 *                                                                          *
 ****************************************************************************/

typedef enum
{
  pVarName = 1,
  pVarDescription = 2
} pVariable;

#define FD_PLUGIN_MAGIC "*FDPluginData*"
#define FD_PLUGIN_INTERFACE_VERSION 10

// This is a set of function pointers that Bareos can call within the plugin.
typedef struct s_pluginFuncs {
  uint32_t size;
  uint32_t version;
  bRC (*newPlugin)(PluginContext* ctx);
  bRC (*freePlugin)(PluginContext* ctx);
  bRC (*getPluginValue)(PluginContext* ctx, pVariable var, void* value);
  bRC (*setPluginValue)(PluginContext* ctx, pVariable var, void* value);
  bRC (*handlePluginEvent)(PluginContext* ctx, bEvent* event, void* value);
  bRC (*startBackupFile)(PluginContext* ctx, save_pkt* sp);
  bRC (*endBackupFile)(PluginContext* ctx);
  bRC (*startRestoreFile)(PluginContext* ctx, const char* cmd);
  bRC (*endRestoreFile)(PluginContext* ctx);
  bRC (*pluginIO)(PluginContext* ctx, io_pkt* io);
  bRC (*createFile)(PluginContext* ctx, restore_pkt* rp);
  bRC (*setFileAttributes)(PluginContext* ctx, restore_pkt* rp);
  bRC (*checkFile)(PluginContext* ctx, char* fname);
  bRC (*getAcl)(PluginContext* ctx, acl_pkt* ap);
  bRC (*setAcl)(PluginContext* ctx, acl_pkt* ap);
  bRC (*getXattr)(PluginContext* ctx, xattr_pkt* xp);
  bRC (*setXattr)(PluginContext* ctx, xattr_pkt* xp);
} PluginFunctions;

#define PlugFunc(plugin) ((PluginFunctions*)(plugin->plugin_functions))
#define plug_info(plugin) ((PluginInformation*)(plugin->plugin_information))

#ifdef __cplusplus
}
#endif

} /* namespace filedaemon */
#endif  // BAREOS_FILED_FD_PLUGINS_H_
