/*
 * @project      The CERN Tape Archive (CTA)
 * @copyright    Copyright © 2021-2022 CERN
 * @license      This program is free software, distributed under the terms of the GNU General Public
 *               Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING". You can
 *               redistribute it and/or modify it under the terms of the GPL Version 3, 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.
 *
 *               In applying this licence, CERN does not waive the privileges and immunities
 *               granted to it by virtue of its status as an Intergovernmental Organization or
 *               submit itself to any jurisdiction.
 */

#pragma once

#include "version.h"

#include <list>
#include <optional>
#include <string>

namespace cta::cliTool {

/**
* Enum value for each of the tools
*/
enum class StandaloneCliTool {
  RESTORE_FILES,
  CTA_SEND_EVENT,
  CTA_VERIFY_FILE,
  CTA_CHANGE_STORAGE_CLASS,
  EOS_NAMESPACE_INJECTION
};

/**
 * Structure to store the command-line arguments of the command-line tool
 * named cta-restore-deleted-archive.
 */
struct CmdLineArgs {
  /**
   * True if the usage message should be printed.
   */
  bool m_help;

  /**
   * True if debug messages should be printed
   */
  bool m_debug;

  /**
   * Archive file id of the files to restore
   */
  std::optional<std::string> m_archiveFileId;

  /**
   * Archive file id of the files to restore
   */
  std::optional<std::list<std::string>> m_archiveFileIds;

  /**
   * Location of json file
   */
  std::optional<std::string> m_json;

  /**
   * Disk instance of the files to restore
   */
  std::optional<std::string> m_diskInstance;

  /**
   * Fids of the files to restore
   */
  std::optional<std::list<std::string>> m_fids;

  /**
   * Vid of the tape of the files to restore
   */
  std::optional<std::string> m_vid;

  /**
   *Copy number of the files to restore
   */
  std::optional<uint64_t> m_copyNumber;

  /**
   * Eos endpoint
   */
  std::optional<std::string> m_eosEndpoint;

  /**
   * Request user
   */
  std::optional<std::string> m_requestUser;

  /**
   * Request user
   */
  std::optional<std::string> m_requestGroup;

  /**
   * The tool parsing the arguments
   */
  StandaloneCliTool m_standaloneCliTool;

  /**
   * The tool parsing the arguments
   */
  std::optional<std::string> m_storageClassName;

  /**
   * Frequency
   */
  std::optional<uint64_t> m_frequency;

  /**
   * Constructor that parses the specified command-line arguments.
   *
   * @param argc The number of command-line arguments including the name of the
   * executable.
   * @param argv The vector of command-line arguments.
   * @param standaloneCliTool The tool calling the constructor
   */
  CmdLineArgs(const int &argc, char *const *const &argv, const StandaloneCliTool &standaloneCliTool);

   /**
   * Read a list of eos file ids from a file and write the options to a list
   *
   * @param filename The name of the file to read
   * @param fidList The list of file IDs
   */
   void readIdListFromFile(const std::string &filename);

  /**
   * Prints the usage message of the command-line tool.
   *
   * @param os The output stream to which the usage message is to be printed.
   */
  void printUsage(std::ostream &os) const;

}; // class RestoreFilesCmdLineArgs

} // namespace cta::cliTool