/*
    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>

    This file is part of libdcp.

    libdcp is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    libdcp 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.

    You should have received a copy of the GNU General Public License
    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.

    In addition, as a special exception, the copyright holders give
    permission to link the code of portions of this program with the
    OpenSSL library under certain conditions as described in each
    individual source file, and distribute linked combinations
    including the two.

    You must obey the GNU General Public License in all respects
    for all of the code used other than OpenSSL.  If you modify
    file(s) with this exception, you may extend this exception to your
    version of the file(s), but you are not obligated to do so.  If you
    do not wish to do so, delete this exception statement from your
    version.  If you delete this exception statement from all source
    files in the program, then also delete it here.
*/


/** @file  src/dcp.h
 *  @brief DCP class
 */


#ifndef LIBDCP_DCP_H
#define LIBDCP_DCP_H


#include "asset_map.h"
#include "certificate.h"
#include "compose.hpp"
#include "cpl_summary.h"
#include "metadata.h"
#include "name_format.h"
#include "util.h"
#include "verify.h"
#include "version.h"
#include <memory>
#include <string>
#include <vector>


namespace xmlpp {
	class Document;
	class Element;
}


/** @brief Namespace for everything in libdcp */
namespace dcp
{


class Asset;
class CPL;
class CertificateChain;
class Content;
class DecryptedKDM;
class EqualityOptions;
class PKL;
class ReadError;
class Reel;


/** @class DCP
 *  @brief A class to create or read a DCP
 */
class DCP
{
public:
	/** Construct a DCP.  You can pass an existing DCP's directory
	 *  as the parameter; alternatively, directory will be created
	 *  if it does not exist.  Note that if you pass an existing DCP
	 *  into this constructor it will not be read until you call ::read().
	 *
	 *  @param directory Directory containing the DCP's files.
	 */
	explicit DCP (boost::filesystem::path directory);

	DCP (DCP const&) = delete;
	DCP& operator= (DCP const&) = delete;

	DCP (DCP &&);
	DCP& operator= (DCP &&);

	/** Read a DCP.  This method does not do any deep checking of the DCP's validity, but
	 *  if it comes across any bad things it will do one of two things.
	 *
	 *  Errors that are so serious that they prevent the method from working will result
	 *  in an exception being thrown.  For example, a missing ASSETMAP means that the DCP
	 *  can't be read without a lot of guesswork, so this will throw.
	 *
	 *  Errors that are not fatal will be added to notes, if it's non-null.  For example,
	 *  if the DCP contains a mixture of Interop and SMPTE elements this will result
	 *  in a note being added to the vector.
	 *
	 *  For more thorough checking of a DCP's contents, see dcp::verify().
	 *
	 *  @param notes List of notes that will be added to if non-0.
	 *  @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic
	 *  as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think)
	 *  have an incorrect descriptor in their MXF.
	 */
	void read (std::vector<VerificationNote>* notes = nullptr, bool ignore_incorrect_picture_mxf_type = false);

	/** Return summaries of the CPLs in this DCP.  This should only be used if the information
	 *  in CPLSummary is all you need.  It's faster than read(), but if you need more than
	 *  the CPLSummary you will need to just call read().
	 */
	std::vector<CPLSummary> cpl_summaries() const;

	/** Compare this DCP with another, according to various options.
	 *  @param other DCP to compare this one to.
	 *  @param options Options to define what "equality" means.
	 *  @param note Functor to handle notes made by the equality operation.
	 *  @return true if the DCPs are equal according to EqualityOptions, otherwise false.
	 */
	bool equals(DCP const & other, EqualityOptions const& options, NoteHandler note) const;

	void add (std::shared_ptr<CPL> cpl);

	std::vector<std::shared_ptr<CPL>> cpls () const;

	/** @param ignore_unresolved true to silently ignore unresolved assets, otherwise
	 *  an exception is thrown if they are found.
	 *  @return All assets (including CPLs).
	 */
	std::vector<std::shared_ptr<Asset>> assets (bool ignore_unresolved = false) const;

	bool any_encrypted () const;
	bool all_encrypted () const;

	/** Add a KDM to decrypt this DCP.  This method must be called after DCP::read()
	 *  or the KDM you specify will be ignored.
	 *  @param kdm KDM to use.
	 */
	void add (DecryptedKDM const &);

	void set_issuer(std::string issuer);
	void set_creator(std::string creator);
	void set_issue_date(std::string issue_date);
	void set_annotation_text(std::string annotation_text);

	/** Write all the XML files for this DCP.
	 *  @param signer Signer to use
	 *  @param name_format Name format to use for the CPL and PKL filenames
	 *  @param filenames ORIGINAL to use original CPL and PKL filenames where available, NEW to
	 *  always use name_format
	 *  @param group_id Group UUID to write to PKL (or none to not write a GroupID tag)
	 */
	void write_xml(
		std::shared_ptr<const CertificateChain> signer = std::shared_ptr<const CertificateChain>(),
		Filenames filenames = Filenames::NEW,
		NameFormat name_format = NameFormat("%t"),
		boost::optional<std::string> group_id = boost::none
	);

	void resolve_refs (std::vector<std::shared_ptr<Asset>> assets);

	/** @return Standard of a DCP that was read in */
	boost::optional<Standard> standard () const {
		if (!_asset_map) {
			return {};
		}

		return _asset_map->standard();
	}

	boost::filesystem::path directory () const {
		return _directory;
	}

	/** @return PKLs if this DCP was read from an existing one, or if write_xml() has been called on it.
	 *  If neither is true, this method returns an empty vector.
	 */
	std::vector<std::shared_ptr<PKL>> pkls () const {
		return _pkls;
	}

	boost::optional<boost::filesystem::path> asset_map_file() const {
		if (!_asset_map) {
			return {};
		}

		return _asset_map->file();
	}

	boost::optional<AssetMap> asset_map() const {
		return _asset_map;
	}

	bool can_be_read() const;

	static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);

private:

	void write_volindex (Standard standard) const;
	/** Throws MissingAssetmapError if asset map could not be found */
	AssetMap read_assetmap() const;

	static std::string remove_parameters(std::string const& n);

	/** The directory that we are writing to */
	boost::filesystem::path _directory;
	/** The CPLs that make up this DCP */
	std::vector<std::shared_ptr<CPL>> _cpls;
	/** The PKLs that make up this DCP */
	std::vector<std::shared_ptr<PKL>> _pkls;
	boost::optional<AssetMap> _asset_map;

	/* Metadata to use for newly created PKLs and AssetMaps */
	boost::optional<std::string> _new_issuer;
	boost::optional<std::string> _new_creator;
	boost::optional<std::string> _new_issue_date;
	boost::optional<std::string> _new_annotation_text;
};


}


#endif