Files
test2/scripts/startup/bl_operators/file.py
Campbell Barton e955c94ed3 License Headers: Set copyright to "Blender Authors", add AUTHORS
Listing the "Blender Foundation" as copyright holder implied the Blender
Foundation holds copyright to files which may include work from many
developers.

While keeping copyright on headers makes sense for isolated libraries,
Blender's own code may be refactored or moved between files in a way
that makes the per file copyright holders less meaningful.

Copyright references to the "Blender Foundation" have been replaced with
"Blender Authors", with the exception of `./extern/` since these this
contains libraries which are more isolated, any changed to license
headers there can be handled on a case-by-case basis.

Some directories in `./intern/` have also been excluded:

- `./intern/cycles/` it's own `AUTHORS` file is planned.
- `./intern/opensubdiv/`.

An "AUTHORS" file has been added, using the chromium projects authors
file as a template.

Design task: #110784

Ref !110783.
2023-08-16 00:20:26 +10:00

308 lines
9.9 KiB
Python

# SPDX-FileCopyrightText: 2015-2023 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
import bpy
from bpy.types import (
Operator,
OperatorFileListElement,
)
from bpy.props import (
BoolProperty,
CollectionProperty,
StringProperty,
)
from bpy.app.translations import pgettext_tip as tip_
# ########## Datablock previews... ##########
class WM_OT_previews_batch_generate(Operator):
"""Generate selected .blend file's previews"""
bl_idname = "wm.previews_batch_generate"
bl_label = "Batch-Generate Previews"
bl_options = {'REGISTER'}
# -----------
# File props.
files: CollectionProperty(
type=OperatorFileListElement,
options={'HIDDEN', 'SKIP_SAVE'},
name="",
description="Collection of file paths with common `directory` root",
)
directory: StringProperty(
maxlen=1024,
subtype='FILE_PATH',
options={'HIDDEN', 'SKIP_SAVE'},
name="",
description="Root path of all files listed in `files` collection",
)
# Show only images/videos, and directories!
filter_blender: BoolProperty(
default=True,
options={'HIDDEN', 'SKIP_SAVE'},
name="",
description="Show Blender files in the File Browser",
)
filter_folder: BoolProperty(
default=True,
options={'HIDDEN', 'SKIP_SAVE'},
name="",
description="Show folders in the File Browser",
)
# -----------
# Own props.
use_scenes: BoolProperty(
default=True,
name="Scenes",
description="Generate scenes' previews",
)
use_collections: BoolProperty(
default=True,
name="Collections",
description="Generate collections' previews",
)
use_objects: BoolProperty(
default=True,
name="Objects",
description="Generate objects' previews",
)
use_intern_data: BoolProperty(
default=True,
name="Materials & Textures",
description="Generate 'internal' previews (materials, textures, images, etc.)",
)
use_trusted: BoolProperty(
default=False,
name="Trusted Blend Files",
description="Enable Python evaluation for selected files",
)
use_backups: BoolProperty(
default=True,
name="Save Backups",
description="Keep a backup (.blend1) version of the files when saving with generated previews",
)
def invoke(self, context, _event):
context.window_manager.fileselect_add(self)
return {'RUNNING_MODAL'}
def execute(self, context):
import os
import subprocess
from bl_previews_utils import bl_previews_render as preview_render
context.window_manager.progress_begin(0, len(self.files))
context.window_manager.progress_update(0)
for i, fn in enumerate(self.files):
blen_path = os.path.join(self.directory, fn.name)
cmd = [
bpy.app.binary_path,
"--background",
"--factory-startup",
"-noaudio",
]
if self.use_trusted:
cmd.append("--enable-autoexec")
cmd.extend([
blen_path,
"--python",
os.path.join(os.path.dirname(preview_render.__file__), "bl_previews_render.py"),
"--",
])
if not self.use_scenes:
cmd.append('--no_scenes')
if not self.use_collections:
cmd.append('--no_collections')
if not self.use_objects:
cmd.append('--no_objects')
if not self.use_intern_data:
cmd.append('--no_data_intern')
if not self.use_backups:
cmd.append("--no_backups")
if subprocess.call(cmd):
self.report({'ERROR'}, tip_("Previews generation process failed for file '%s'!") % blen_path)
context.window_manager.progress_end()
return {'CANCELLED'}
context.window_manager.progress_update(i + 1)
context.window_manager.progress_end()
return {'FINISHED'}
class WM_OT_previews_batch_clear(Operator):
"""Clear selected .blend file's previews"""
bl_idname = "wm.previews_batch_clear"
bl_label = "Batch-Clear Previews"
bl_options = {'REGISTER'}
# -----------
# File props.
files: CollectionProperty(
type=OperatorFileListElement,
options={'HIDDEN', 'SKIP_SAVE'},
)
directory: StringProperty(
maxlen=1024,
subtype='FILE_PATH',
options={'HIDDEN', 'SKIP_SAVE'},
)
# Show only images/videos, and directories!
filter_blender: BoolProperty(
default=True,
options={'HIDDEN', 'SKIP_SAVE'},
)
filter_folder: BoolProperty(
default=True,
options={'HIDDEN', 'SKIP_SAVE'},
)
# -----------
# Own props.
use_scenes: BoolProperty(
default=True,
name="Scenes",
description="Clear scenes' previews",
)
use_collections: BoolProperty(
default=True,
name="Collections",
description="Clear collections' previews",
)
use_objects: BoolProperty(
default=True,
name="Objects",
description="Clear objects' previews",
)
use_intern_data: BoolProperty(
default=True,
name="Materials & Textures",
description="Clear 'internal' previews (materials, textures, images, etc.)",
)
use_trusted: BoolProperty(
default=False,
name="Trusted Blend Files",
description="Enable Python evaluation for selected files",
)
use_backups: BoolProperty(
default=True,
name="Save Backups",
description="Keep a backup (.blend1) version of the files when saving with cleared previews",
)
def invoke(self, context, _event):
context.window_manager.fileselect_add(self)
return {'RUNNING_MODAL'}
def execute(self, context):
import os
import subprocess
from bl_previews_utils import bl_previews_render as preview_render
context.window_manager.progress_begin(0, len(self.files))
context.window_manager.progress_update(0)
for i, fn in enumerate(self.files):
blen_path = os.path.join(self.directory, fn.name)
cmd = [
bpy.app.binary_path,
"--background",
"--factory-startup",
"-noaudio",
]
if self.use_trusted:
cmd.append("--enable-autoexec")
cmd.extend([
blen_path,
"--python",
os.path.join(os.path.dirname(preview_render.__file__), "bl_previews_render.py"),
"--",
"--clear",
])
if not self.use_scenes:
cmd.append('--no_scenes')
if not self.use_collections:
cmd.append('--no_collections')
if not self.use_objects:
cmd.append('--no_objects')
if not self.use_intern_data:
cmd.append('--no_data_intern')
if not self.use_backups:
cmd.append("--no_backups")
if subprocess.call(cmd):
self.report({'ERROR'}, tip_("Previews clear process failed for file '%s'!") % blen_path)
context.window_manager.progress_end()
return {'CANCELLED'}
context.window_manager.progress_update(i + 1)
context.window_manager.progress_end()
return {'FINISHED'}
class WM_OT_blend_strings_utf8_validate(Operator):
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode """ \
"""(needed for some old, 2.4x area files)"""
bl_idname = "wm.blend_strings_utf8_validate"
bl_label = "Validate .blend strings"
bl_options = {'REGISTER'}
def validate_strings(self, item, done_items):
if item is None:
return False
if item in done_items:
return False
done_items.add(item)
if getattr(item, "library", None) is not None:
return False # No point in checking library data, we cannot fix it anyway...
changed = False
for prop in item.bl_rna.properties:
if prop.identifier in {"bl_rna", "rna_type"}:
continue # Or we'd recurse 'till Hell freezes.
if prop.is_readonly:
continue
if prop.type == 'STRING':
val_bytes = item.path_resolve(prop.identifier, False).as_bytes()
val_utf8 = val_bytes.decode('utf-8', 'replace')
val_bytes_valid = val_utf8.encode('utf-8')
if val_bytes_valid != val_bytes:
print("found bad utf8 encoded string %r, fixing to %r (%r)..."
"" % (val_bytes, val_bytes_valid, val_utf8))
setattr(item, prop.identifier, val_utf8)
changed = True
elif prop.type == 'POINTER':
it = getattr(item, prop.identifier)
changed |= self.validate_strings(it, done_items)
elif prop.type == 'COLLECTION':
for it in getattr(item, prop.identifier):
changed |= self.validate_strings(it, done_items)
return changed
def execute(self, _context):
changed = False
done_items = set()
for prop in bpy.data.bl_rna.properties:
if prop.type == 'COLLECTION':
for it in getattr(bpy.data, prop.identifier):
changed |= self.validate_strings(it, done_items)
if changed:
self.report({'WARNING'},
"Some strings were fixed, don't forget to save the .blend file to keep those changes")
return {'FINISHED'}
classes = (
WM_OT_previews_batch_clear,
WM_OT_previews_batch_generate,
WM_OT_blend_strings_utf8_validate,
)