Feature translate archives (#342)

Author: andiwand

CMakeLists.txt

@@ -65,11 +65,13 @@ else ()
 endif ()
 
 add_library(odr
+        "src/odr/archive.cpp"
         "src/odr/document.cpp"
         "src/odr/document_element.cpp"
         "src/odr/document_path.cpp"
         "src/odr/exceptions.cpp"
         "src/odr/file.cpp"
+        "src/odr/filesystem.cpp"
         "src/odr/html.cpp"
         "src/odr/open_document_reader.cpp"
         "src/odr/quantity.cpp"
@@ -108,6 +110,7 @@ add_library(odr
         "src/odr/internal/html/document.cpp"
         "src/odr/internal/html/document_style.cpp"
         "src/odr/internal/html/document_element.cpp"
+        "src/odr/internal/html/filesystem.cpp"
         "src/odr/internal/html/html_writer.cpp"
         "src/odr/internal/html/image_file.cpp"
         "src/odr/internal/html/text_file.cpp"

cli/src/translate.cpp

@@ -1,3 +1,4 @@
+#include <odr/exceptions.hpp>
 #include <odr/file.hpp>
 #include <odr/html.hpp>
 
@@ -7,34 +8,33 @@
 using namespace odr;
 
 int main(int argc, char **argv) {
-  const std::string input{argv[1]};
-  const std::string output{argv[2]};
+  std::string input{argv[1]};
+  std::string output{argv[2]};
 
   std::optional<std::string> password;
   if (argc >= 4) {
     password = argv[3];
   }
 
-  DocumentFile document_file{input};
-
-  if (document_file.password_encrypted()) {
-    if (password) {
-      if (!document_file.decrypt(*password)) {
-        std::cerr << "wrong password" << std::endl;
-        return 1;
-      }
-    } else {
-      std::cerr << "document encrypted but no password given" << std::endl;
-      return 2;
-    }
-  }
-
-  auto document = document_file.document();
+  File file{input};
 
   HtmlConfig config;
   config.editable = true;
 
-  html::translate(document, output, config);
+  PasswordCallback password_callback = [&]() {
+    if (!password) {
+      std::cerr << "document encrypted but no password given" << std::endl;
+      std::exit(2);
+    }
+    return *password;
+  };
+
+  try {
+    html::translate(file, output, config, password_callback);
+  } catch (const WrongPassword &e) {
+    std::cerr << "wrong password" << std::endl;
+    return 1;
+  }
 
   return 0;
 }

src/odr/archive.cpp

@@ -0,0 +1,24 @@
+#include <odr/archive.hpp>
+
+#include <odr/filesystem.hpp>
+
+#include <odr/internal/abstract/archive.hpp>
+#include <odr/internal/abstract/filesystem.hpp>
+#include <odr/internal/common/path.hpp>
+
+namespace odr {
+
+Archive::Archive(std::shared_ptr<internal::abstract::Archive> impl)
+    : m_impl{std::move(impl)} {}
+
+Archive::operator bool() const { return m_impl.operator bool(); }
+
+Filesystem Archive::filesystem() const {
+  return Filesystem(
+      std::dynamic_pointer_cast<internal::abstract::ReadableFilesystem>(
+          m_impl->filesystem()));
+}
+
+void Archive::save(const std::string &path) const { m_impl->save(path); }
+
+} // namespace odr

src/odr/archive.hpp

@@ -0,0 +1,30 @@
+#ifndef ODR_ARCHIVE_H
+#define ODR_ARCHIVE_H
+
+#include <memory>
+#include <string>
+
+namespace odr::internal::abstract {
+class Archive;
+} // namespace odr::internal::abstract
+
+namespace odr {
+class Filesystem;
+
+class Archive {
+public:
+  explicit Archive(std::shared_ptr<internal::abstract::Archive>);
+
+  [[nodiscard]] explicit operator bool() const;
+
+  [[nodiscard]] Filesystem filesystem() const;
+
+  void save(const std::string &path) const;
+
+private:
+  std::shared_ptr<internal::abstract::Archive> m_impl;
+};
+
+} // namespace odr
+
+#endif // ODR_ARCHIVE_H

src/odr/document.cpp

@@ -2,6 +2,8 @@
 
 #include <odr/document_element.hpp>
 #include <odr/file.hpp>
+#include <odr/filesystem.hpp>
+
 #include <odr/internal/abstract/document.hpp>
 #include <odr/internal/common/path.hpp>
 
@@ -10,36 +12,36 @@
 
 namespace odr {
 
-Document::Document(std::shared_ptr<internal::abstract::Document> document)
-    : m_document{std::move(document)} {
-  if (!m_document) {
+Document::Document(std::shared_ptr<internal::abstract::Document> impl)
+    : m_impl{std::move(impl)} {
+  if (!m_impl) {
     throw std::runtime_error("document is null");
   }
 }
 
-bool Document::editable() const noexcept { return m_document->is_editable(); }
+bool Document::editable() const noexcept { return m_impl->is_editable(); }
 
 bool Document::savable(const bool encrypted) const noexcept {
-  return m_document->is_savable(encrypted);
+  return m_impl->is_savable(encrypted);
 }
 
-void Document::save(const std::string &path) const { m_document->save(path); }
+void Document::save(const std::string &path) const { m_impl->save(path); }
 
 void Document::save(const std::string &path,
                     const std::string &password) const {
-  m_document->save(path, password.c_str());
+  m_impl->save(path, password.c_str());
 }
 
-FileType Document::file_type() const noexcept {
-  return m_document->file_type();
-}
+FileType Document::file_type() const noexcept { return m_impl->file_type(); }
 
 DocumentType Document::document_type() const noexcept {
-  return m_document->document_type();
+  return m_impl->document_type();
 }
 
 Element Document::root_element() const {
-  return {m_document.get(), m_document->root_element()};
+  return {m_impl.get(), m_impl->root_element()};
 }
 
+Filesystem Document::files() const { return Filesystem(m_impl->files()); }
+
 } // namespace odr

src/odr/document.hpp

@@ -13,10 +13,11 @@ enum class FileType;
 enum class DocumentType;
 class DocumentFile;
 class Element;
+class Filesystem;
 
 class Document final {
 public:
-  explicit Document(std::shared_ptr<internal::abstract::Document> document);
+  explicit Document(std::shared_ptr<internal::abstract::Document>);
 
   [[nodiscard]] bool editable() const noexcept;
   [[nodiscard]] bool savable(bool encrypted = false) const noexcept;
@@ -29,8 +30,10 @@ class Document final {
 
   [[nodiscard]] Element root_element() const;
 
+  [[nodiscard]] Filesystem files() const;
+
 private:
-  std::shared_ptr<internal::abstract::Document> m_document;
+  std::shared_ptr<internal::abstract::Document> m_impl;
 
   friend DocumentFile;
 };

src/odr/exceptions.cpp

@@ -34,6 +34,8 @@ UnknownCharset::UnknownCharset() : std::runtime_error("unknown charset") {}
 
 NoImageFile::NoImageFile() : std::runtime_error("not an image file") {}
 
+NoArchiveFile::NoArchiveFile() : std::runtime_error("not an archive file") {}
+
 NoDocumentFile::NoDocumentFile() : std::runtime_error("not a document file") {}
 
 NoOpenDocumentFile::NoOpenDocumentFile()

src/odr/exceptions.hpp

@@ -64,6 +64,10 @@ struct NoImageFile final : public std::runtime_error {
   NoImageFile();
 };
 
+struct NoArchiveFile final : public std::runtime_error {
+  NoArchiveFile();
+};
+
 struct NoDocumentFile final : public std::runtime_error {
   NoDocumentFile();
 };

src/odr/file.cpp

@@ -1,5 +1,6 @@
 #include <odr/file.hpp>
 
+#include <odr/archive.hpp>
 #include <odr/document.hpp>
 #include <odr/exceptions.hpp>
 
@@ -25,12 +26,16 @@ FileMeta::FileMeta(const FileType type, const bool password_encrypted,
     : type{type}, password_encrypted{password_encrypted},
       document_meta{std::move(document_meta)} {}
 
+File::File() = default;
+
 File::File(std::shared_ptr<internal::abstract::File> impl)
     : m_impl{std::move(impl)} {}
 
 File::File(const std::string &path)
     : m_impl{std::make_shared<internal::common::DiskFile>(path)} {}
 
+File::operator bool() const { return m_impl.operator bool(); }
+
 FileLocation File::location() const noexcept { return m_impl->location(); }
 
 std::size_t File::size() const { return m_impl->size(); }
@@ -82,6 +87,8 @@ DecodedFile::DecodedFile(const std::string &path, FileType as)
     : DecodedFile(internal::open_strategy::open_file(
           std::make_shared<internal::common::DiskFile>(path), as)) {}
 
+DecodedFile::operator bool() const { return m_impl.operator bool(); }
+
 FileType DecodedFile::file_type() const noexcept {
   return m_impl->file_meta().type;
 }
@@ -99,7 +106,7 @@ TextFile DecodedFile::text_file() const {
           std::dynamic_pointer_cast<internal::abstract::TextFile>(m_impl)) {
     return TextFile(text_file);
   }
-  throw NoImageFile();
+  throw NoTextFile();
 }
 
 ImageFile DecodedFile::image_file() const {
@@ -110,6 +117,14 @@ ImageFile DecodedFile::image_file() const {
   throw NoImageFile();
 }
 
+ArchiveFile DecodedFile::archive_file() const {
+  if (auto archive_file =
+          std::dynamic_pointer_cast<internal::abstract::ArchiveFile>(m_impl)) {
+    return ArchiveFile(archive_file);
+  }
+  throw NoArchiveFile();
+}
+
 DocumentFile DecodedFile::document_file() const {
   if (auto document_file =
           std::dynamic_pointer_cast<internal::abstract::DocumentFile>(m_impl)) {
@@ -140,6 +155,11 @@ std::unique_ptr<std::istream> ImageFile::stream() const {
   return m_impl->file()->stream();
 }
 
+ArchiveFile::ArchiveFile(std::shared_ptr<internal::abstract::ArchiveFile> impl)
+    : DecodedFile(impl), m_impl{std::move(impl)} {}
+
+Archive ArchiveFile::archive() const { return Archive(m_impl->archive()); }
+
 FileType DocumentFile::type(const std::string &path) {
   return DocumentFile(path).file_type();
 }