path: root/src/cpl.cc

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

    This program 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.

    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.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#include <fstream>
#include <libxml/parser.h>
#include "cpl.h"
#include "parse/cpl.h"
#include "util.h"
#include "picture_asset.h"
#include "sound_asset.h"
#include "subtitle_asset.h"
#include "parse/asset_map.h"
#include "reel.h"
#include "metadata.h"
#include "encryption.h"
#include "exceptions.h"
#include "xml.h"
#include "content_version.h"
#include "compose.hpp"

using std::string;
using std::stringstream;
using std::ofstream;
using std::ostream;
using std::list;
using std::pair;
using std::make_pair;
using boost::shared_ptr;
using boost::lexical_cast;
using boost::optional;
using namespace libdcp;

CPL::CPL ()
	: content_kind (FEATURE)
	, _length (0)
{
	id = make_uuid ();
}

CPL::CPL (boost::filesystem::path file)
	: content_kind (FEATURE)
	, _length (0)
{
	cxml::Document f ("CompositionPlaylist");
	f.read_file (file);

	/* Trim urn:uuid: off the front */
	id = f.string_child ("Id");
	annotation_text = f.optional_string_child ("AnnotationText").get_value_or ("");
	issue_date = f.string_child ("IssueDate");
	creator = f.optional_string_child ("Creator").get_value_or ("");
	content_title_text = f.string_child ("ContentTitleText");
	content_kind = content_kind_from_string (f.string_child ("ContentKind"));
	content_version = optional_type_child<ContentVersion> (f, "ContentVersion");
	if (!content_version) {
		content_version.reset (new ContentVersion);
	}
	f.ignore_child ("RatingList");
	reels = type_grand_children<Reel> (f, "ReelList", "Reel");

	f.ignore_child ("Issuer");
	f.ignore_child ("Signer");
	f.ignore_child ("Signature");

	f.done ();	
}

void
CPL::write_xml (boost::filesystem::path directory, bool interop, shared_ptr<Encryption> crypt) const
{
	boost::filesystem::path p;
	p /= directory;
	stringstream s;
	s << id << "_cpl.xml";
	p /= s.str();

	xmlpp::Document doc;
	xmlpp::Element* root;
	if (interop) {
		root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#");
	} else {
		root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL");
	}

	if (crypt) {
		root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
	}

	/* XXX
	   Old maps:
	   _name -> AnnotationText
	   metadata.issue_date -> IssueDate
	   metadata.issuer -> Issuer
	   metadata.creator -> Creator
	   _name -> ContentTitleText
	   _id + metadata.issue_date -> ContentVersion/Id
	   _id + metadata.issue_date -> ContentVersion/LabelText
	*/
	
	root->add_child("Id")->add_child_text ("urn:uuid:" + id);
	root->add_child("AnnotationText")->add_child_text (annotation_text);
	root->add_child("IssueDate")->add_child_text (issue_date);
	root->add_child("Issuer")->add_child_text (issuer);
	root->add_child("Creator")->add_child_text (creator);
	root->add_child("ContentTitleText")->add_child_text (content_title_text);
	root->add_child("ContentKind")->add_child_text (content_kind_to_string (content_kind));
	{
		xmlpp::Node* cv = root->add_child ("ContentVersion");
		cv->add_child ("Id")->add_child_text ("urn:uri:" + content_version->id);
		cv->add_child ("LabelText")->add_child_text (content_version->label_text);
	}
	root->add_child("RatingList");

	xmlpp::Element* reel_list = root->add_child ("ReelList");
	
	for (list<shared_ptr<Reel> >::const_iterator i = reels.begin(); i != reels.end(); ++i) {
		(*i)->write_to_cpl (reel_list, interop);
	}

	if (crypt) {
		sign (root, crypt->certificates, crypt->signer_key, interop);
	}

	doc.write_to_file_formatted (p.string (), "UTF-8");

	_digest = make_digest (p.string (), 0);
	_length = boost::filesystem::file_size (p.string ());
}

void
CPL::write_to_pkl (xmlpp::Node* node) const
{
	xmlpp::Node* asset = node->add_child ("Asset");
	asset->add_child("Id")->add_child_text ("urn:uuid:" + id);
	asset->add_child("Hash")->add_child_text (_digest);
	asset->add_child("Size")->add_child_text (lexical_cast<string> (_length));
	asset->add_child("Type")->add_child_text ("text/xml");
}

void
CPL::write_to_assetmap (xmlpp::Node* node) const
{
	xmlpp::Node* asset = node->add_child ("Asset");
	asset->add_child("Id")->add_child_text ("urn:uuid:" + id);
	xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
	xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
	chunk->add_child("Path")->add_child_text (id + "_cpl.xml");
	chunk->add_child("VolumeIndex")->add_child_text ("1");
	chunk->add_child("Offset")->add_child_text("0");
	chunk->add_child("Length")->add_child_text(lexical_cast<string> (_length));
}

#define EQUALS_COMPARE(property, message) if (property != other->property) { note (ERROR, message " differ"); return false; }
	
bool
CPL::equals (shared_ptr<const CPL> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
{
	EQUALS_COMPARE (id, "CPL ids");
	EQUALS_COMPARE (annotation_text, "CPL annotation texts");
	EQUALS_COMPARE (issue_date, "CPL issue dates");
	EQUALS_COMPARE (creator, "CPL creators");
	EQUALS_COMPARE (content_title_text, "CPL content title texts");
	EQUALS_COMPARE (content_kind, "CPL content kinds");

	/* XXX: content_version */
	
	if (reels.size() != other->reels.size()) {
		note (ERROR, String::compose ("reel counts differ (%1 vs %2)", reels.size(), other->reels.size()));
		return false;
	}
	
	list<shared_ptr<Reel> >::const_iterator a = reels.begin ();
	list<shared_ptr<Reel> >::const_iterator b = other->reels.begin ();
	
	while (a != reels.end ()) {
		if (!(*a)->equals (*b, opt, note)) {
			return false;
		}
		++a;
		++b;
	}

	return true;
}

#undef EQUALS_COMPARE

shared_ptr<xmlpp::Document>
CPL::make_kdm (
	CertificateChain const & certificates,
	string const & signer_key,
	shared_ptr<const Certificate> recipient_cert,
	boost::posix_time::ptime from,
	boost::posix_time::ptime until,
	bool interop,
	MXFMetadata const & mxf_metadata,
	XMLMetadata const & xml_metadata
	) const
{
	assert (recipient_cert);
	
	shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
	xmlpp::Element* root = doc->create_root_node ("DCinemaSecurityMessage");
	root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/430-3/2006/ETM", "");
	root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "ds");
	root->set_namespace_declaration ("http://www.w3.org/2001/04/xmlenc#", "enc");

	{
		xmlpp::Element* authenticated_public = root->add_child("AuthenticatedPublic");
		authenticated_public->set_attribute("Id", "ID_AuthenticatedPublic");
		xmlAddID (0, doc->cobj(), (const xmlChar *) "ID_AuthenticatedPublic", authenticated_public->get_attribute("Id")->cobj());
		
		authenticated_public->add_child("MessageId")->add_child_text ("urn:uuid:" + make_uuid());
		authenticated_public->add_child("MessageType")->add_child_text ("http://www.smpte-ra.org/430-1/2006/KDM#kdm-key-type");
		authenticated_public->add_child("AnnotationText")->add_child_text (mxf_metadata.product_name);
		authenticated_public->add_child("IssueDate")->add_child_text (xml_metadata.issue_date);

		{
			xmlpp::Element* signer = authenticated_public->add_child("Signer");
			signer->add_child("X509IssuerName", "ds")->add_child_text (recipient_cert->issuer());
			signer->add_child("X509SerialNumber", "ds")->add_child_text (recipient_cert->serial());
		}

		{
			xmlpp::Element* required_extensions = authenticated_public->add_child("RequiredExtensions");

			{
				xmlpp::Element* kdm_required_extensions = required_extensions->add_child("KDMRequiredExtensions");
				kdm_required_extensions->set_namespace_declaration ("http://www.smpte-ra.org/schemas/430-1/2006/KDM");
				{
					xmlpp::Element* recipient = kdm_required_extensions->add_child("Recipient");
					{
						xmlpp::Element* serial_element = recipient->add_child("X509IssuerSerial");
						serial_element->add_child("X509IssuerName", "ds")->add_child_text (recipient_cert->issuer());
						serial_element->add_child("X509SerialNumber", "ds")->add_child_text (recipient_cert->serial());
					}

					recipient->add_child("X509SubjectName")->add_child_text (recipient_cert->subject());
				}

				kdm_required_extensions->add_child("CompositionPlaylistId")->add_child_text("urn:uuid:" + id);
				kdm_required_extensions->add_child("ContentTitleText")->add_child_text(content_title_text);
				kdm_required_extensions->add_child("ContentAuthenticator")->add_child_text(certificates.leaf()->thumbprint());
				kdm_required_extensions->add_child("ContentKeysNotValidBefore")->add_child_text("XXX");
				kdm_required_extensions->add_child("ContentKeysNotValidAfter")->add_child_text("XXX");

				{
					xmlpp::Element* authorized_device_info = kdm_required_extensions->add_child("AuthorizedDeviceInfo");
					authorized_device_info->add_child("DeviceListIdentifier")->add_child_text("urn:uuid:" + make_uuid());
					authorized_device_info->add_child("DeviceListDescription")->add_child_text(recipient_cert->subject());
					{
						xmlpp::Element* device_list = authorized_device_info->add_child("DeviceList");
						device_list->add_child("CertificateThumbprint")->add_child_text(recipient_cert->thumbprint());
					}
				}

				#if 0
				XXX
				{
					xmlpp::Element* key_id_list = kdm_required_extensions->add_child("KeyIdList");
					list<shared_ptr<const Asset> > a = assets();
					for (list<shared_ptr<const Asset> >::iterator i = a.begin(); i != a.end(); ++i) {
						/* XXX: non-MXF assets? */
						shared_ptr<const MXFAsset> mxf = boost::dynamic_pointer_cast<const MXFAsset> (*i);
						if (mxf) {
							mxf->add_typed_key_id (key_id_list);
						}
					}
				}
				#endif

				{
					xmlpp::Element* forensic_mark_flag_list = kdm_required_extensions->add_child("ForensicMarkFlagList");
					forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text ( 
						"http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable"
						);
					forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text ( 
						"http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable"
						);
				}
			}
		}
					 
		authenticated_public->add_child("NonCriticalExtensions");
	}

	{
		xmlpp::Element* authenticated_private = root->add_child("AuthenticatedPrivate");
		authenticated_private->set_attribute ("Id", "ID_AuthenticatedPrivate");
		xmlAddID (0, doc->cobj(), (const xmlChar *) "ID_AuthenticatedPrivate", authenticated_private->get_attribute("Id")->cobj());
		{
			xmlpp::Element* encrypted_key = authenticated_private->add_child ("EncryptedKey", "enc");
			{
				xmlpp::Element* encryption_method = encrypted_key->add_child ("EncryptionMethod", "enc");
				encryption_method->set_attribute ("Algorithm", "http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p");
				encryption_method->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
			}

			xmlpp::Element* cipher_data = authenticated_private->add_child ("CipherData", "enc");
			cipher_data->add_child("CipherValue", "enc")->add_child_text("XXX");
		}
	}
	
	/* XXX: x2 one for each mxf? */

	{
		xmlpp::Element* signature = root->add_child("Signature", "ds");
		
		{
			xmlpp::Element* signed_info = signature->add_child("SignedInfo", "ds");
			signed_info->add_child("CanonicalizationMethod", "ds")->set_attribute(
				"Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"
				);

			if (interop) {
				signed_info->add_child("SignatureMethod", "ds")->set_attribute(
					"Algorithm", "http://www.w3.org/2000/09/xmldsig#rsa-sha1"
					);
			} else {
				signed_info->add_child("SignatureMethod", "ds")->set_attribute(
					"Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"
					);
			}
			
			{
				xmlpp::Element* reference = signed_info->add_child("Reference", "ds");
				reference->set_attribute("URI", "#ID_AuthenticatedPublic");
				reference->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256");
				reference->add_child("DigestValue", "ds");
			}
			
			{				
				xmlpp::Element* reference = signed_info->add_child("Reference", "ds");
				reference->set_attribute("URI", "#ID_AuthenticatedPrivate");
				reference->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256");
				reference->add_child("DigestValue", "ds");
			}
		}
		
		add_signature_value (signature, certificates, signer_key, "ds");
	}

	return doc;
}

/** @return true if we have any encrypted content */
bool
CPL::encrypted () const
{
	for (list<shared_ptr<Reel> >::const_iterator i = reels.begin(); i != reels.end(); ++i) {
		if ((*i)->encrypted ()) {
			return true;
		}
	}

	return false;
}

void
CPL::add_kdm (KDM const & kdm)
{
	for (list<shared_ptr<Reel> >::const_iterator i = reels.begin(); i != reels.end(); ++i) {
		(*i)->add_kdm (kdm);
	}
}