Loading previous settings doesn't copy symlinks correctly #88670

New Issue

Shinsuke Irie · 2021-05-29T18:13:11+02:00

Shinsuke Irie commented

2021-05-29 18:13:11 +02:00

System Information
Operating system: Linux-5.11.0-17-generic-x86_64-with-glibc2.33 64 Bits
Graphics card: GeForce GTX 1070/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 460.73.01

Blender Version
Broken: version: 2.93.0 Beta, branch: master, commit date: 2021-05-28 16:16, hash: c369382977
Worked: version 2.92.0
Short description of error
When starting Blender first time after upgrading, copying user preferences from previous version goes wrong if there are symlinks in the user preference directory.

The symlinks in the source directory are expected to be symlinks also in the new directory, but actually the contents of the linked files are copied.
Furthermore, if the file pointed by the symlink doesn’t exist, an exception will be raised during copying.

Exact steps for others to reproduce the error

Delete 2.93 user preference directory

$ cd ~/.config/blender
$ rm -rf 2.93

In 2.92 user preference directory, create a symlink

$ cd ~/.config/blender/2.92/scripts/addons
$ ln -s PATH-TO-SOME-ADDON .

Start Blender 2.93 and click "Load 2.92 Settings" button
If the file the symlink points to doesn't exist, we should get an error like below:

Python: Traceback (most recent call last):
  File "/home/irie/build/blender/make/blender-v2.93-release/bin/2.93/scripts/startup/bl_operators/userpref.py", line 147, in execute
    shutil.copytree(self._old_path(), self._new_path(), dirs_exist_ok=True)
  File "/home/irie/build/blender/make/blender-v2.93-release/bin/2.93/python/lib/python3.9/shutil.py", line 557, in copytree
    return _copytree(entries=entries, src=src, dst=dst, symlinks=symlinks,
  File "/home/irie/build/blender/make/blender-v2.93-release/bin/2.93/python/lib/python3.9/shutil.py", line 513, in _copytree
    raise Error(errors)
shutil.Error: [('/home/irie/.config/blender/2.92/scripts/addons/manuelbastionilab', '/home/irie/.config/blender/2.93/scripts/addons/manuelbastionilab', "[Errno 2] No such file or directory: '/home/irie/.config/blender/2.92/scripts/addons/manuelbastionilab'")]

location: <unknown location>:-1

shutil.copytree() in userpref.py seems to need an optional argmuent symlinks=True, which has been removed in 216291ddb3 though I'm not sure why @brecht removed it.
I confirmed the following patch resolves the issue:

diff --git a/release/scripts/startup/bl_operators/userpref.py b/release/scripts/startup/bl_operators/userpref.py
index 3969386bad7..dd84dfa2df8 100644
--- a/release/scripts/startup/bl_operators/userpref.py
+++ b/release/scripts/startup/bl_operators/userpref.py
@@ -153,7 +153,7 @@ class PREFERENCES_OT_copy_prev(Operator):
 
     def execute(self, _context):
         import shutil
-        shutil.copytree(self._old_path(), self._new_path(), dirs_exist_ok=True)
+        shutil.copytree(self._old_path(), self._new_path(), dirs_exist_ok=True, symlinks=True)
 
         # reload preferences and recent-files.txt
         bpy.ops.wm.read_userpref()

**System Information** Operating system: Linux-5.11.0-17-generic-x86_64-with-glibc2.33 64 Bits Graphics card: GeForce GTX 1070/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 460.73.01 **Blender Version** Broken: version: 2.93.0 Beta, branch: master, commit date: 2021-05-28 16:16, hash: `c369382977` Worked: version 2.92.0 **Short description of error** When starting Blender first time after upgrading, copying user preferences from previous version goes wrong if there are symlinks in the user preference directory. The symlinks in the source directory are expected to be symlinks also in the new directory, but actually the contents of the linked files are copied. Furthermore, if the file pointed by the symlink doesn’t exist, an exception will be raised during copying. **Exact steps for others to reproduce the error** 1. Delete 2.93 user preference directory ``` $ cd ~/.config/blender $ rm -rf 2.93 ``` 2. In 2.92 user preference directory, create a symlink ``` $ cd ~/.config/blender/2.92/scripts/addons $ ln -s PATH-TO-SOME-ADDON . ``` 3. Start Blender 2.93 and click "Load 2.92 Settings" button If the file the symlink points to doesn't exist, we should get an error like below: ``` Python: Traceback (most recent call last): File "/home/irie/build/blender/make/blender-v2.93-release/bin/2.93/scripts/startup/bl_operators/userpref.py", line 147, in execute shutil.copytree(self._old_path(), self._new_path(), dirs_exist_ok=True) File "/home/irie/build/blender/make/blender-v2.93-release/bin/2.93/python/lib/python3.9/shutil.py", line 557, in copytree return _copytree(entries=entries, src=src, dst=dst, symlinks=symlinks, File "/home/irie/build/blender/make/blender-v2.93-release/bin/2.93/python/lib/python3.9/shutil.py", line 513, in _copytree raise Error(errors) shutil.Error: [('/home/irie/.config/blender/2.92/scripts/addons/manuelbastionilab', '/home/irie/.config/blender/2.93/scripts/addons/manuelbastionilab', "[Errno 2] No such file or directory: '/home/irie/.config/blender/2.92/scripts/addons/manuelbastionilab'")] location: <unknown location>:-1 ``` `shutil.copytree()` in userpref.py seems to need an optional argmuent `symlinks=True`, which has been removed in 216291ddb3 though I'm not sure why @brecht removed it. I confirmed the following patch resolves the issue: ``` diff --git a/release/scripts/startup/bl_operators/userpref.py b/release/scripts/startup/bl_operators/userpref.py index 3969386bad7..dd84dfa2df8 100644 --- a/release/scripts/startup/bl_operators/userpref.py +++ b/release/scripts/startup/bl_operators/userpref.py @@ -153,7 +153,7 @@ class PREFERENCES_OT_copy_prev(Operator): def execute(self, _context): import shutil - shutil.copytree(self._old_path(), self._new_path(), dirs_exist_ok=True) + shutil.copytree(self._old_path(), self._new_path(), dirs_exist_ok=True, symlinks=True) # reload preferences and recent-files.txt bpy.ops.wm.read_userpref() ```

Shinsuke Irie commented

2021-05-29 18:13:11 +02:00

Added subscribers: @brecht, @IRIEShinsuke

blender-admin commented

2021-05-31 17:24:35 +02:00

This issue was referenced by 46a14bd6a3

This issue was referenced by 46a14bd6a317ead29dfdbf038bd30d49a656249e

Brecht Van Lommel commented

2021-05-31 18:22:54 +02:00

symlinks=True was implicitly assumed in the custom implementation. I'll restore it now we use the built-in implementation.

`symlinks=True` was implicitly assumed in the custom implementation. I'll restore it now we use the built-in implementation.

Brecht Van Lommel commented

2021-05-31 18:23:44 +02:00

Changed status from 'Needs Triage' to: 'Resolved'

Brecht Van Lommel closed this issue

2021-05-31 18:23:44 +02:00

Brecht Van Lommel self-assigned this 2021-05-31 18:23:44 +02:00

Thomas Dinges added this to the 2.93 LTS milestone 2023-02-07 18:46:13 +01:00

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Loading previous settings doesn't copy symlinks correctly #88670