No-op; Fix GPL address and mention libdcp by name.
[libdcp.git] / src / asset.cc
index 80b010825b57eb95f72acf39d801bc2a9185fef2..82ef44feccad02ecfc5da0e5534d2bc3472e304a 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    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.
 
-    This program is distributed in the hope that it will be useful,
+    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 this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #include "asset.h"
 #include "util.h"
 #include "exceptions.h"
+#include "dcp_assert.h"
 #include "compose.hpp"
 #include <libxml++/libxml++.h>
+#include <boost/algorithm/string.hpp>
 
 using std::string;
 using boost::function;
@@ -39,8 +42,7 @@ Asset::Asset ()
 
 }
 
-/** Create an Asset from a given file.  The ID will
- *  be extracted from the file.
+/** Create an Asset from a given file.
  *  @param file File name.
  */
 Asset::Asset (boost::filesystem::path file)
@@ -49,20 +51,30 @@ Asset::Asset (boost::filesystem::path file)
 
 }
 
-/** Create an Asset with a specified ID.
- *  @param id ID to use.
- */
-Asset::Asset (string id)
+Asset::Asset (string id, boost::filesystem::path file)
        : Object (id)
+       , _file (file)
 {
 
 }
 
 void
-Asset::write_to_pkl (xmlpp::Node* node, Standard standard) const
+Asset::write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const
 {
-       assert (!_file.empty ());
-       
+       DCP_ASSERT (!_file.empty ());
+
+       optional<boost::filesystem::path> path = relative_to_root (
+               boost::filesystem::canonical (root),
+               boost::filesystem::canonical (_file)
+               );
+
+       if (!path) {
+               /* The path of this asset is not within our DCP, so we assume it's an external
+                  (referenced) one.
+               */
+               return;
+       }
+
        xmlpp::Node* asset = node->add_child ("Asset");
        asset->add_child("Id")->add_child_text ("urn:uuid:" + _id);
        asset->add_child("AnnotationText")->add_child_text (_id);
@@ -74,17 +86,26 @@ Asset::write_to_pkl (xmlpp::Node* node, Standard standard) const
 void
 Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
 {
-       assert (!_file.empty ());
+       DCP_ASSERT (!_file.empty ());
+
+       optional<boost::filesystem::path> path = relative_to_root (
+               boost::filesystem::canonical (root),
+               boost::filesystem::canonical (_file)
+               );
+
+       if (!path) {
+               /* The path of this asset is not within our DCP, so we assume it's an external
+                  (referenced) one.
+               */
+               return;
+       }
 
        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");
-       optional<boost::filesystem::path> path = relative_to_root (root, _file);
-       if (!path) {
-               throw MiscError (String::compose ("Asset %1 is not within the directory %2", _file, root));
-       }
-       chunk->add_child("Path")->add_child_text (path.get().string ());
+
+       chunk->add_child("Path")->add_child_text (path.get().generic_string());
        chunk->add_child("VolumeIndex")->add_child_text ("1");
        chunk->add_child("Offset")->add_child_text ("0");
        chunk->add_child("Length")->add_child_text (raw_convert<string> (boost::filesystem::file_size (_file)));
@@ -93,8 +114,8 @@ Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
 string
 Asset::hash (function<void (float)> progress) const
 {
-       assert (!_file.empty ());
-               
+       DCP_ASSERT (!_file.empty ());
+
        if (_hash.empty ()) {
                _hash = make_digest (_file, progress);
        }
@@ -103,20 +124,25 @@ Asset::hash (function<void (float)> progress) const
 }
 
 bool
-Asset::equals (boost::shared_ptr<const Asset> other, EqualityOptions, function<void (NoteType, string)> note) const
+Asset::equals (boost::shared_ptr<const Asset> other, EqualityOptions, NoteHandler note) const
 {
        if (_hash != other->_hash) {
-               note (DCP_ERROR, "Asset hashes differ");
+               note (DCP_ERROR, "Asset: hashes differ");
                return false;
        }
 
        return true;
 }
 
+/** Set the file that holds this asset on disk.  Calling this function
+ *  clears this object's store of its hash, so you should call ::hash
+ *  after this.
+ *
+ *  @param file New file's path.
+ */
 void
 Asset::set_file (boost::filesystem::path file) const
 {
        _file = boost::filesystem::absolute (file);
        _hash.clear ();
 }
-