/*
   BAREOS® - Backup Archiving REcovery Open Sourced

   Copyright (C) 2018-2026 Bareos GmbH & Co. KG
   Copyright (C) 2009 Free Software Foundation Europe e.V.

   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 and included
   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.
*/

#ifndef BAREOS_FILED_RESTORE_H_
#define BAREOS_FILED_RESTORE_H_

#include "findlib/bfile.h"
#include "lib/attr.h"
template <typename T> class alist;

namespace filedaemon {

struct DelayedDataStream {
  int32_t stream;          /* stream less new bits */
  char* content;           /* stream data */
  uint32_t content_length; /* stream length */
};

struct RestoreCipherContext {
  CIPHER_CONTEXT* cipher;
  uint32_t block_size;
  POOLMEM* buf;       /* Pointer to decryption buffer */
  int32_t buf_len;    /* Count of bytes currently in buf */
  int32_t packet_len; /* Total bytes in packet */
};

/* clang-format off */
struct r_ctx {
  JobControlRecord* jcr{nullptr};
  int32_t stream{0};           /* stream less new bits */
  int32_t prev_stream{0};      /* previous stream */
  int32_t full_stream{0};      /* full stream including new bits */
  int32_t comp_stream{0};      /* last compressed stream found. needed only to
                                  restore encrypted compressed backup */
  BareosFilePacket bfd;     /* File content */
  uint64_t fileAddr{0};        /* file write address */
  uint32_t size{0};            /* Size of file */
  char flags[FOPTS_BYTES]{};   /* Options for ExtractData() */
  BareosFilePacket forkbfd; /* Alternative data stream */
  uint64_t fork_addr{0};       /* Write address for alternative stream */
  int64_t fork_size{0};        /* Size of alternate stream */
  char fork_flags[FOPTS_BYTES]{0};    /* Options for ExtractData() */
  int32_t type{0};                    /* file type FT_ */
  Attributes* attr{nullptr};          /* Pointer to attributes */
  bool extract{false};                /* set when extracting */
  alist<DelayedDataStream*>* delayed_streams{nullptr};    /* streams that should be restored as last */
  SIGNATURE* sig{nullptr};            /* Cryptographic signature (if any) for file */
  CRYPTO_SESSION* cs{nullptr};        /* Cryptographic session data (if any) for file */
  RestoreCipherContext cipher_ctx{}; /* Cryptographic restore context (if any) for file */
  RestoreCipherContext fork_cipher_ctx{}; /* Cryptographic restore context (if any)
                                              for alternative stream */
};
/* clang-format on */

void DoRestore(JobControlRecord* jcr);
void FreeSession(r_ctx& rctx);
int DoFileDigest(JobControlRecord* jcr,
                 FindFilesPacket* ff_pkt,
                 bool top_level);
bool SparseData(JobControlRecord* jcr,
                BareosFilePacket* bfd,
                uint64_t* addr,
                char** data,
                uint32_t* length);
bool StoreData(JobControlRecord* jcr,
               BareosFilePacket* bfd,
               char* data,
               const int32_t length,
               bool win32_decomp);

} /* namespace filedaemon */
#endif  // BAREOS_FILED_RESTORE_H_
