Add remove_binding functionality

Author: liturner

TASKS

@@ -1,5 +1,6 @@
 v1.0.1
 TODO: Add "can_delete_binding" check to flags or access mode. Nautilus GUI should not offer to delete if it cannot
+TODO: Add "can_add_binding" logic to the nautilus menu. Should catch for e.g. xml files with existing labels, and not show the Classify sub menu
 TODO: Refactor constants into respective namespaces
 TODO: Remove presence checks from binding::supports
 TODO: .gschema.xml i18n

targets/NMBS-Library/include/private/nmbs/nmbs_private.h

@@ -36,16 +36,28 @@ namespace nmbs
 {
     namespace binding
     {
+        /// Holder for nmbs internal metadata. This data is not part of the ADatP-4778
+        /// standard.
+        struct InternalMetadata
+        {
+            /// @brief Set when reading bindings.
+            std::optional<std::string> binding_profile;
+        };
+
         struct DataReference
         {
             std::string uri;
             std::optional<std::string> content_type;
         };
 
+        /// @brief The structure representing the XML Binding structure.
+        /// @details This is not a pure representation, the deserialization will also
+        /// store some metadata.
         struct BindingInformation
         {
             std::vector<ConfidentialityLabel> labels;
             DataReference reference;
+            InternalMetadata internal_metadata;
         };
 
         /// @brief XML namespace defined by ADatP‑4774 Ed. A, Ver. 1.
@@ -112,8 +124,23 @@ namespace nmbs
             return binding_flags & check;
         }
 
+        /// @brief Detects the Read and Write possibilities of the path for the current user.
+        /// @param path
+        /// @return flags with bits set for read or write.
         [[nodiscard]] AccessMode access_mode_filesystem(const std::filesystem::path& path);
 
+        /// @brief Reads the full ADatP-4778 binding from the file.
+        /// @details Returns the full deserialised object. Note that if multiple bindings are present, only one will be
+        /// returned and the precedence is not defined.
+        /// @param path to the file
+        /// @param binding_support flags if already known. The presence of this parameter will save CPU cycles in
+        /// determining the available binding method for the file. Use manually, or via nmbs::binding::support.
+        /// @return the raw XML of the stored binding.
+        /// @since 1.0.0
+        [[nodiscard]] Expected<std::optional<BindingInformation>> read_binding(
+            const std::filesystem::path& path,
+            std::optional<ProfileSupport> binding_support = std::nullopt);
+
         namespace xmp
         {
             inline constexpr std::string_view profile_canonical_identifier = "urn:nato:stanag:4778:profile:xmp";
@@ -240,6 +267,10 @@ namespace nmbs
 
         namespace xml
         {
+            inline constexpr std::string_view profile_canonical_identifier = "urn:nato:stanag:4778:profile:xml:schema";
+
+            inline constexpr std::string_view profile_version_identifier = "urn:nato:stanag:4778:profile:xml:schema:1:0";
+
             [[nodiscard]] AccessMode access_mode(const std::filesystem::path& path);
 
             [[nodiscard]] std::expected<BindingInformation, Error> read(const std::filesystem::path& path);

targets/NMBS-Library/include/public/nmbs/nmbs_c.h

@@ -115,6 +115,14 @@ typedef struct nmbs_security_policies* nmbs_security_policies_ptr;
 /// @see nmbs_security_policies_get
 typedef struct nmbs_security_policy* nmbs_security_policy_ptr;
 
+/// @brief Opaque Pointer to a security binding.
+/// @details Note, that the struct type is not implemented! It is used only to ensure type safety.
+/// @ingroup c_spif
+/// @see nmbs_binding_read
+typedef struct nmbs_binding_information* nmbs_binding_information_ptr;
+typedef struct nmbs_binding_information const * nmbs_binding_information_const_ptr;
+
+
 /// @brief
 /// @ingroup c_bindings
 /// @param file
@@ -134,6 +142,34 @@ int nmbs_remove_binding(const char* file) NMBS_NOEXCEPT;
 /// @return
 [[nodiscard]] bool nmbs_binding_flags_supports_labels(uint32_t flags) NMBS_NOEXCEPT;
 
+/// @brief Creates and returns an instance of nmbs_binding_information.
+/// @ingroup c_bindings
+/// @return Pointer to a "new" nmbs_binding_information
+/// @see nmbs_binding_information_delete
+nmbs_binding_information_ptr nmbs_binding_information_new() NMBS_NOEXCEPT;
+
+/// @brief "delete"s an instance of nmbs_binding_information.
+/// @ingroup c_bindings
+/// @see nmbs_binding_information_new
+void nmbs_binding_information_delete(nmbs_binding_information_ptr binding_information) NMBS_NOEXCEPT;
+
+/// @brief Reads the nmbs_binding_information from a file, regardless of binding profile.
+/// @ingroup c_bindings
+/// @param binding_out A pointer to your buffer which we will fill.
+/// @param file Path to the file to read labels from.
+/// @see nmbs_binding_information_new
+void nmbs_binding_information_read(nmbs_binding_information_ptr binding_out, const char* file) NMBS_NOEXCEPT;
+
+void nmbs_binding_information_read_with_known_binding(nmbs_binding_information_ptr binding_out, const char* file, uint32_t binding_support) NMBS_NOEXCEPT;
+
+/// @brief Opaque Accessor
+/// @ingroup c_bindings
+/// @param binding
+/// @return Pointer to the underlying data. Do not free or delete this!
+const char* nmbs_binding_information_get_binding_profile(nmbs_binding_information_const_ptr binding) NMBS_NOEXCEPT;
+
+nmbs_confidentiality_labels_ptr nmbs_binding_information_get_labels(nmbs_binding_information_ptr binding) NMBS_NOEXCEPT;
+
 /// @brief
 /// @ingroup c_api
 void nmbs_cleanup() NMBS_NOEXCEPT;

targets/NMBS-Library/src/binding/binding.cpp

@@ -38,6 +38,36 @@ namespace nmbs::binding
         return result_flags;
     }
 
+    Expected<std::optional<BindingInformation>> read_binding(const std::filesystem::path& path,
+                                                             std::optional<ProfileSupport> binding_support)
+    {
+        if (!std::filesystem::exists(path))
+        {
+            return std::unexpected(Error::file_not_found());
+        }
+        if (!binding_support.has_value())
+        {
+            binding_support = binding::support(path);
+        }
+        if (!binding::supports_labels(binding_support.value()))
+        {
+            return std::nullopt;
+        }
+        if (binding::supports_xmp(binding_support.value()))
+        {
+            return binding::xmp::read(path);
+        }
+        if (binding::supports_xml(binding_support.value()))
+        {
+            return serialisation::deserialise_binding_information_from_file(path);
+        }
+        if (binding::supports_sidecar(binding_support.value()))
+        {
+            return binding::sidecar::read(path);
+        }
+        return std::nullopt;
+    }
+
     ProfileSupport support(const std::filesystem::path& path)
     {
         if (!std::filesystem::exists(path)) [[unlikely]]

targets/NMBS-Library/src/binding/http.cpp

@@ -64,6 +64,9 @@ namespace nmbs::binding::http
         const std::string_view base64_xml = binding_data.substr(start_pos, end_pos - start_pos);
         const std::string xml = nmbs::serialisation::decode_base64(base64_xml);
 
-        return nmbs::serialisation::deserialise_binding_information(xml);
+        return serialisation::deserialise_binding_information(xml).transform([](auto info) {
+                    info.internal_metadata.binding_profile = profile_version_identifier;
+                    return info;
+                });
     }
 }

targets/NMBS-Library/src/binding/sidecar.cpp

@@ -65,7 +65,13 @@ namespace nmbs::binding::sidecar
 
     Expected<BindingInformation> read(const std::filesystem::path& path)
     {
-        return read_xml(path).and_then(nmbs::serialisation::deserialise_binding_information);
+        return read_xml(path)
+               .and_then(serialisation::deserialise_binding_information)
+               .transform([](auto info)
+               {
+                   info.internal_metadata.binding_profile = profile_version_identifier;
+                   return info;
+               });
     }
 
 

targets/NMBS-Library/src/binding/xml.cpp

@@ -44,7 +44,13 @@ namespace nmbs::binding::xml
 
     std::expected<BindingInformation, Error> read(const std::filesystem::path& path)
     {
-        return read_xml(path).and_then(nmbs::serialisation::deserialise_binding_information);
+        return read_xml(path)
+               .and_then(serialisation::deserialise_binding_information)
+               .transform([](auto info)
+               {
+                   info.internal_metadata.binding_profile = profile_version_identifier;
+                   return info;
+               });
     }
 
 

targets/NMBS-Library/src/binding/xmp.cpp

@@ -89,9 +89,16 @@ namespace nmbs::binding::xmp
         }
     }
 
+
     Expected<BindingInformation> read(const std::filesystem::path& path)
     {
-        return read_xml(path).and_then(nmbs::serialisation::deserialise_binding_information);
+        return read_xml(path)
+               .and_then(serialisation::deserialise_binding_information)
+               .transform([](auto info)
+               {
+                   info.internal_metadata.binding_profile = profile_version_identifier;
+                   return info;
+               });
     }