Doversion: reset layer collection properties when needed

This prevents crashes when a file was saved with 2.8, but a new
engine settings property was created.

In those cases any previous collection settings are wiped out. We can do
an elegant merge soon.

3 files changed, 147 insertions, 0 deletions

diff --git a/source/blender/blenkernel/BKE_layer.h b/source/blender/blenkernel/BKE_layer.h
index 7021f0ea0b0..54a047d6802 100644
--- a/source/blender/blenkernel/BKE_layer.h
+++ b/source/blender/blenkernel/BKE_layer.h
@@ -222,6 +222,9 @@ void BKE_visible_bases_Iterator_end(Iterator *iter);
     }                                                                         \
 }
 
+/* temporary doversion functions */
+void BKE_scene_layer_doversion_update(struct Main *bmain);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/source/blender/blenkernel/intern/layer.c b/source/blender/blenkernel/intern/layer.c
index 1d8fa9ee47b..24639f78f26 100644
--- a/source/blender/blenkernel/intern/layer.c
+++ b/source/blender/blenkernel/intern/layer.c
@@ -24,6 +24,8 @@
  *  \ingroup bke
  */
 
+#include <string.h>
+
 #include "BLI_listbase.h"
 #include "BLI_string.h"
 #include "BLI_string_utf8.h"
@@ -1225,3 +1227,136 @@ void BKE_visible_bases_Iterator_end(Iterator *UNUSED(iter))
 {
 	/* do nothing */
 }
+
+
+/* ---------------------------------------------------------------------- */
+/* Doversion routine */
+
+/**
+ * Remove all the CollectionEngineSettings for a set of LayerCollection
+ * and create new ones with all the required CollectionEngineProperty
+ *
+ * \param lb Listbase of LayerCollection
+ */
+static void scene_layer_doversion_update_collections(ListBase *lb)
+{
+	for (LayerCollection *lc = lb->first; lc; lc = lc->next) {
+		layer_collection_engine_settings_free(lc);
+		layer_collection_create_engine_settings(lc);
+		layer_collection_create_mode_settings(lc);
+
+		/* continue recursively */
+		scene_layer_doversion_update_collections(&lc->layer_collections);
+	}
+}
+
+/**
+ * Updates all the CollectionEngineSettings of all
+ * LayerCollection elements in Scene
+ */
+static void scene_layer_doversion_update(Scene *scene)
+{
+	for (SceneLayer *sl = scene->render_layers.first; sl; sl = sl->next) {
+		scene_layer_doversion_update_collections(&sl->layer_collections);
+	}
+}
+
+/**
+ * Return true at the first indicative that the listbases don't match
+ *
+ * It's fine if the individual properties values are different, as long
+ * as we have the same properties across them
+ *
+ * \param lb_ces ListBase of CollectionEngineSettings
+ * \param lb_ces_ref ListBase of CollectionEngineSettings
+ */
+static bool scene_layer_doversion_is_outdated_engines(ListBase *lb_ces, ListBase *lb_ces_ref)
+{
+	if (BLI_listbase_count(lb_ces) != BLI_listbase_count(lb_ces_ref)) {
+		return true;
+	}
+
+	CollectionEngineSettings *ces, *ces_ref;
+	for (ces = lb_ces->first, ces_ref = lb_ces_ref->first; ces; ces = ces->next, ces_ref = ces_ref->next) {
+		if (BLI_listbase_count(&ces->properties) != BLI_listbase_count(&ces_ref->properties)) {
+			return true;
+		}
+
+		CollectionEngineProperty *cep, *cep_ref;
+		for (cep = ces->properties.first, cep_ref = ces_ref->properties.first; cep; cep = cep->next, cep_ref = cep_ref->next) {
+			if (cep->type != cep_ref->type) {
+				return true;
+			}
+
+			if (STREQ(cep->name, cep_ref->name) == false) {
+				return true;
+			}
+		}
+	}
+
+	return false;
+}
+
+/**
+ * Get the first available LayerCollection
+ */
+static LayerCollection *scene_layer_doversion_collection_get(Main *bmain)
+{
+	for (Scene *scene = bmain->scene.first; scene; scene = scene->id.next) {
+		for (SceneLayer *sl = scene->render_layers.first; sl; sl = sl->next) {
+			for (LayerCollection *lc = sl->layer_collections.first; lc; lc = lc->next) {
+				return lc;
+			}
+		}
+	}
+	return NULL;
+}
+
+/**
+ * See if a new LayerCollection have the same CollectionEngineSettings
+ * and properties of the saved LayerCollection
+ */
+static bool scene_layer_doversion_is_outdated(Main *bmain)
+{
+	LayerCollection *lc, lc_ref = {NULL};
+	bool is_outdated = false;
+
+	lc = scene_layer_doversion_collection_get(bmain);
+
+	if (lc == NULL) {
+		return false;
+	}
+
+	layer_collection_create_engine_settings(&lc_ref);
+	layer_collection_create_mode_settings(&lc_ref);
+
+	if (scene_layer_doversion_is_outdated_engines(&lc->engine_settings, &lc_ref.engine_settings)) {
+		is_outdated = true;
+	}
+
+	if (scene_layer_doversion_is_outdated_engines(&lc->mode_settings, &lc_ref.mode_settings)) {
+		is_outdated = true;
+	}
+
+	layer_collection_engine_settings_free(&lc_ref);
+	return is_outdated;
+}
+
+/**
+ * Handle doversion of files during the viewport development
+ *
+ * This is intended to prevent subversion bumping every time a new property
+ * is added to an engine, but it may be relevant in the future as a generic doversion
+ */
+void BKE_scene_layer_doversion_update(Main *bmain)
+{
+	/* if file not outdated, don't bother with the slow merging */
+	if (scene_layer_doversion_is_outdated(bmain) == false) {
+		return;
+	}
+
+	/* bring all the missing properties for the LayerCollections */
+	for (Scene *scene = bmain->scene.first; scene; scene = scene->id.next) {
+		scene_layer_doversion_update(scene);
+	}
+}
diff --git a/source/blender/blenloader/intern/versioning_280.c b/source/blender/blenloader/intern/versioning_280.c
index 432d8be0a6d..b8867f7b621 100644
--- a/source/blender/blenloader/intern/versioning_280.c
+++ b/source/blender/blenloader/intern/versioning_280.c
@@ -173,6 +173,11 @@ void do_versions_after_linking_280(Main *main)
 	}
 }
 
+void blo_do_version_temporary(Main *main)
+{
+	BKE_scene_layer_doversion_update(main);
+}
+
 void blo_do_versions_280(FileData *fd, Library *UNUSED(lib), Main *main)
 {
 	if (!MAIN_VERSION_ATLEAST(main, 280, 0)) {
@@ -183,5 +188,9 @@ void blo_do_versions_280(FileData *fd, Library *UNUSED(lib), Main *main)
 				BLI_strncpy(scene->collection->name, "Master Collection", sizeof(scene->collection->name));
 			}
 		}
+
+		/* temporary validation of 280 files for layers */
+		blo_do_version_temporary(main);
 	}
+
 }