Fix #111332: 4.0 files cannot be opened in 3.6, invalid region types #111483

Julian Eisel · 2023-08-24T18:11:57+02:00

Julian Eisel commented

2023-08-24 18:11:57 +02:00

4.0 files now include asset shelf regions in 3D views. This region type is not
known to older Blender versions. So far, in such cases we would just change
the region type to be the first known region type and keep the region storage
otherwise. This was arbitrary, and in fact unsafe: the reused settings may
violate invariants/assumptions for a region type and worse, the
ARegion.regiondata can only be interpreted and correctly written to files
if the region type is known.

Case in point, in this specific case the asset shelf regions would be set to
use RGN_TYPE_XR or before that was introduced, RGN_TYPE_HUD. Both of
these are not designed to be used as regular regions. Plus, the asset shelf's
region data pointer would be written to files, for a now different region
type and without the necessary SDNA available.

Make sure all invalid regions (regions where the type cannot be restored) are
removed on file read. This is the only safe solution Bastien and I could see.

Note: This patch is made against the 3.6 branch. Should be ported to main
too (to provide a proper solution for future cases like this) but this will
cause conflicts.

4.0 files now include asset shelf regions in 3D views. This region type is not known to older Blender versions. So far, in such cases we would just change the region type to be the first known region type and keep the region storage otherwise. This was arbitrary, and in fact unsafe: the reused settings may violate invariants/assumptions for a region type and worse, the `ARegion.regiondata` can only be interpreted and correctly written to files if the region type is known. Case in point, in this specific case the asset shelf regions would be set to use `RGN_TYPE_XR` or before that was introduced, `RGN_TYPE_HUD`. Both of these are not designed to be used as regular regions. Plus, the asset shelf's region data pointer would be written to files, for a now different region type and without the necessary SDNA available. Make sure all invalid regions (regions where the type cannot be restored) are removed on file read. This is the only safe solution Bastien and I could see. Note: This patch is made against the 3.6 branch. Should be ported to `main` too (to provide a proper solution for future cases like this) but this will cause conflicts.

👍 1

Julian Eisel added 3 commits 2023-08-24 18:12:12 +02:00

28cde71042 Fix 111332: 4.0 files can't be opened in 3.6, invalid region types

44e2b3715f Cleanup: Remove unused function

8642953830 Remove regions on file read, not when activating

Julian Eisel requested review from Campbell Barton 2023-08-24 18:12:24 +02:00

Julian Eisel requested review from Bastien Montagne 2023-08-24 18:12:24 +02:00

Iliya Katushenock changed title from ~~Fix 111332: 4.0 files cannot be opened in 3.6, invalid region types~~ to Fix #111332: 4.0 files cannot be opened in 3.6, invalid region types

2023-08-24 18:20:52 +02:00

Bastien Montagne approved these changes 2023-08-25 11:18:12 +02:00

Bastien Montagne left a comment

LGTM.

Campbell Barton approved these changes 2023-08-29 08:55:52 +02:00

Campbell Barton left a comment

LGTM.

Tested with 4.0 files & 2.49x files (although those files contain space-types which have been removed, not regions.)

Very minor changed requested inline.

LGTM. Tested with 4.0 files & 2.49x files (although those files contain space-types which have been removed, not regions.) Very minor changed requested inline.

Campbell Barton reviewed 2023-08-29 08:57:31 +02:00

source/blender/blenkernel/intern/screen.c Outdated

						
				@ -1484,0 +1479,4 @@

				      continue;

				    }

				    printf("Error, region type %d missing in space type \"%s\" (id: %d) - removing region\n",

Campbell Barton commented

2023-08-29 08:57:31 +02:00

This should be made into a Warning as an error indicates something went wrong, when in fact this is expected when opening newer files.

It could even be suppressed when opening files when newer versions of Blender although I don't have such a strong opinion on this.

This should be made into a `Warning` as an error indicates something went wrong, when in fact this is expected when opening newer files. It could even be suppressed when opening files when newer versions of Blender although I don't have such a strong opinion on this.

JulianEisel marked this conversation as resolved

Julian Eisel added 1 commit 2023-08-29 11:58:44 +02:00

02c87efba5 Address review suggestion: Error -> Warning

Julian Eisel merged commit e2d4403497 into blender-v3.6-release

2023-08-29 13:52:22 +02:00

Julian Eisel referenced this issue from a commit

2023-08-29 13:52:23 +02:00

Fix #111332: 4.0 files cannot be opened in 3.6, invalid region types

Julian Eisel deleted branch temp-fix-invalid-region-type

2023-08-29 13:52:27 +02:00

Julian Eisel referenced this issue from a commit

2023-08-29 14:10:53 +02:00