xlnt/include/xlnt/packaging/manifest.hpp

// Copyright (c) 2014-2016 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, WRISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file
#pragma once

#include <string>
#include <unordered_map>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/packaging/relationship.hpp>
#include <xlnt/utils/path.hpp>

namespace xlnt {

/// <summary>
/// The manifest keeps track of all files in the OOXML package and
/// their type and relationships.
/// </summary>
class XLNT_API manifest
{
public:
	/// <summary>
	/// Unregisters all default and override type and all relationships and known parts.
	/// </summary>
    void clear();
    
    /// <summary>
    /// Returns the path to all internal package parts registered as a source
    /// or target of a relationship.
    /// </summary>
	std::vector<path> get_parts() const;
    
    // Relationships
    
	/// <summary>
	/// Returns true if the manifest contains a relationship with the given type with part as the source.
	/// </summary>
	bool has_relationship(const path &source, relationship::type type) const;

	/// <summary>
	/// Returns true if the manifest contains a relationship with the given type with part as the source.
	/// </summary>
	bool has_relationship(const path &source, const std::string &rel_id) const;

    /// <summary>
    /// Returns the relationship with "source" as the source and with a type of "type".
    /// Throws a key_not_found exception if no such relationship is found.
    /// </summary>
	relationship get_relationship(const path &source, relationship::type type) const;

    /// <summary>
    /// Returns the relationship with "source" as the source and with an ID of "rel_id".
    /// Throws a key_not_found exception if no such relationship is found.
    /// </summary>
	relationship get_relationship(const path &source, const std::string &rel_id) const;

    /// <summary>
    /// Returns all relationship with "source" as the source.
    /// </summary>
	std::vector<relationship> get_relationships(const path &source) const;

    /// <summary>
    /// Returns all relationships with "source" as the source and with a type of "type".
    /// </summary>
	std::vector<relationship> get_relationships(const path &source, relationship::type type) const;
    
	/// <summary>
	/// 
	/// </summary>
	std::string register_relationship(const uri &source, relationship::type type, const uri &target, target_mode mode);

	/// <summary>
	/// 
	/// </summary>
	std::string register_relationship(const uri &source, relationship::type type, const uri &target, target_mode mode, const std::string &rel_id);

	/// <summary>
	/// 
	/// </summary>
	void unregister_relationship(const uri &source, const std::string &rel_id);

    // Content Types

	/// <summary>
	/// Given the path to a part, returns the content type of the part as a string.
	/// </summary>
	std::string get_content_type(const path &part) const;

    // Default Content Types
    
	/// <summary>
	/// Returns true if a default content type for the extension has been registered.
	/// </summary>
	bool has_default_type(const std::string &extension) const;

	/// <summary>
	/// Returns a vector of all extensions with registered default content types.
	/// </summary>
	std::vector<std::string> get_extensions_with_default_types() const;

	/// <summary>
	/// Returns the registered default content type for parts of the given extension.
	/// </summary>
	std::string get_default_type(const std::string &extension) const;

	/// <summary>
	/// Associates the given extension with the given content type.
	/// </summary>
    void register_default_type(const std::string &extension, const std::string &type);

	/// <summary>
	/// Unregisters the default content type for the given extension.
	/// </summary>
	void unregister_default_type(const std::string &extension);
    
    // Override Content Types

	/// <summary>
	/// Returns true if a content type overriding the default content type has been registered
    /// for the given part.
	/// </summary>
	bool has_override_type(const path &part) const;

    /// <summary>
    /// Returns the override content type registered for the given part.
    /// Throws key_not_found exception if no override type was found.
    /// </summary>
    std::string get_override_type(const path &part) const;
    
    /// <summary>
    /// Returns the path of every part in this manifest with an overriden content type.
    /// </summary>
	std::vector<path> get_parts_with_overriden_types() const;

    /// <summary>
    /// Overrides any default type registered for the part's extension with the given content type.
    /// </summary>
	void register_override_type(const path &part, const std::string &type);

	/// <summary>
	/// Unregisters the overriding content type of the given part.
	/// </summary>
	void unregister_override_type(const path &part);

private:
	std::string next_relationship_id(const path &part) const;

	std::unordered_map<std::string, std::string> default_content_types_;
    
	std::unordered_map<path, std::string> override_content_types_;
    
    std::unordered_map<path, std::unordered_map<std::string, relationship>> relationships_;
};

} // namespace xlnt