multi-user/multi_user/operators.py

1012 lines
30 KiB
Python
Raw Normal View History

2020-03-20 21:56:50 +08:00
# ##### BEGIN GPL LICENSE BLOCK #####
#
# This program 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 3 of the License, or
# (at your option) any later version.
#
# This program 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, see <https://www.gnu.org/licenses/>.
#
# ##### END GPL LICENSE BLOCK #####
2019-05-02 23:58:37 +08:00
import asyncio
2020-12-16 18:05:58 +08:00
import copy
import gzip
2019-02-12 00:02:25 +08:00
import logging
2019-05-02 23:58:37 +08:00
import os
import queue
2019-02-22 23:46:35 +08:00
import random
2020-10-06 05:38:52 +08:00
import shutil
2019-02-22 23:46:35 +08:00
import string
2020-12-02 21:21:49 +08:00
import sys
2019-03-25 21:56:09 +08:00
import time
2020-12-12 06:02:20 +08:00
from datetime import datetime
2019-04-03 21:07:35 +08:00
from operator import itemgetter
from pathlib import Path
from queue import Queue
2020-12-16 18:05:58 +08:00
from time import gmtime, strftime
try:
import _pickle as pickle
except ImportError:
import pickle
2019-09-30 19:35:50 +08:00
2019-03-25 21:56:09 +08:00
import bpy
import mathutils
2019-09-16 17:42:53 +08:00
from bpy.app.handlers import persistent
2020-12-16 18:05:58 +08:00
from bpy_extras.io_utils import ExportHelper, ImportHelper
from replication.constants import (COMMITED, FETCHED, RP_COMMON, STATE_ACTIVE,
STATE_INITIAL, STATE_SYNCING, UP)
2020-07-10 22:50:09 +08:00
from replication.data import ReplicatedDataFactory
from replication.exception import NonAuthorizedOperationError, ContextError
from replication.interface import session
2019-03-25 21:56:09 +08:00
from . import bl_types, environment, timers, ui, utils
2020-12-02 21:21:49 +08:00
from .presence import SessionStatusWidget, renderer, view3d_find
from .timers import registry
background_execution_queue = Queue()
stagging = list()
2020-12-10 01:35:29 +08:00
deleyables = []
stop_modal_executor = False
def session_callback(name):
""" Session callback wrapper
This allow to encapsulate session callbacks to background_execution_queue.
By doing this way callback are executed from the main thread.
"""
def func_wrapper(func):
@session.register(name)
def add_background_task(**kwargs):
background_execution_queue.put((func, kwargs))
return add_background_task
return func_wrapper
@session_callback('on_connection')
def initialize_session():
"""Session connection init hander
"""
settings = utils.get_preferences()
runtime_settings = bpy.context.window_manager.session
# Step 1: Constrect nodes
for node in session._graph.list_ordered():
node_ref = session.get(uuid=node)
if node_ref.state == FETCHED:
node_ref.resolve()
# Step 2: Load nodes
for node in session._graph.list_ordered():
node_ref = session.get(uuid=node)
if node_ref.state == FETCHED:
node_ref.apply()
# Step 4: Register blender timers
2020-12-10 01:35:29 +08:00
for d in deleyables:
d.register()
bpy.app.handlers.depsgraph_update_post.append(depsgraph_evaluation)
bpy.ops.session.apply_armature_operator('INVOKE_DEFAULT')
2020-12-24 00:27:43 +08:00
# Step 0: Clearing history
utils.flush_history()
2020-12-24 00:27:43 +08:00
@session_callback('on_exit')
def on_connection_end(reason="none"):
"""Session connection finished handler
"""
2020-12-10 01:35:29 +08:00
global deleyables, stop_modal_executor
settings = utils.get_preferences()
# Step 1: Unregister blender timers
2020-12-10 01:35:29 +08:00
for d in deleyables:
try:
d.unregister()
except:
continue
2020-12-10 01:35:29 +08:00
deleyables.clear()
stop_modal_executor = True
if depsgraph_evaluation in bpy.app.handlers.depsgraph_update_post:
bpy.app.handlers.depsgraph_update_post.remove(depsgraph_evaluation)
# Step 3: remove file handled
logger = logging.getLogger()
for handler in logger.handlers:
if isinstance(handler, logging.FileHandler):
logger.removeHandler(handler)
if reason != "user":
bpy.ops.session.notify('INVOKE_DEFAULT', message=f"Disconnected from session. Reason: {reason}. ")
2020-11-26 05:53:38 +08:00
# OPERATORS
class SessionStartOperator(bpy.types.Operator):
bl_idname = "session.start"
bl_label = "start"
2019-02-11 22:48:07 +08:00
bl_description = "connect to a net server"
host: bpy.props.BoolProperty(default=False)
2019-02-11 22:48:07 +08:00
@classmethod
def poll(cls, context):
return True
def execute(self, context):
2020-12-10 01:35:29 +08:00
global deleyables
settings = utils.get_preferences()
runtime_settings = context.window_manager.session
users = bpy.data.window_managers['WinMan'].online_users
2020-06-10 16:15:39 +08:00
admin_pass = runtime_settings.password
users.clear()
2020-12-10 01:35:29 +08:00
deleyables.clear()
logger = logging.getLogger()
if len(logger.handlers) == 1:
2020-09-15 22:33:49 +08:00
formatter = logging.Formatter(
fmt='%(asctime)s CLIENT %(levelname)-8s %(message)s',
datefmt='%H:%M:%S'
)
2020-09-15 22:33:49 +08:00
log_directory = os.path.join(
settings.cache_directory,
"multiuser_client.log")
os.makedirs(settings.cache_directory, exist_ok=True)
2020-09-15 22:33:49 +08:00
handler = logging.FileHandler(log_directory, mode='w')
logger.addHandler(handler)
for handler in logger.handlers:
if isinstance(handler, logging.NullHandler):
continue
handler.setFormatter(formatter)
2019-08-08 19:41:53 +08:00
bpy_factory = ReplicatedDataFactory()
supported_bl_types = []
2020-01-22 21:33:34 +08:00
2019-08-08 19:41:53 +08:00
# init the factory with supported types
for type in bl_types.types_to_register():
type_module = getattr(bl_types, type)
2020-11-11 21:09:57 +08:00
name = [e.capitalize() for e in type.split('_')[1:]]
type_impl_name = 'Bl'+''.join(name)
type_module_class = getattr(type_module, type_impl_name)
supported_bl_types.append(type_module_class.bl_id)
if type_impl_name not in settings.supported_datablocks:
logging.info(f"{type_impl_name} not found, \
regenerate type settings...")
settings.generate_supported_types()
type_local_config = settings.supported_datablocks[type_impl_name]
2019-08-23 18:28:57 +08:00
bpy_factory.register_type(
type_module_class.bl_class,
type_module_class,
timer=type_local_config.bl_delay_refresh*1000,
2020-09-18 04:47:11 +08:00
automatic=type_local_config.auto_push,
check_common=type_module_class.bl_check_common)
2019-08-23 18:28:57 +08:00
if type_local_config.bl_delay_apply > 0:
deleyables.append(
timers.ApplyTimer(
timeout=type_local_config.bl_delay_apply,
target_type=type_module_class))
2019-08-23 18:28:57 +08:00
2020-12-02 21:21:49 +08:00
if bpy.app.version[1] >= 91:
python_binary_path = sys.executable
else:
python_binary_path = bpy.app.binary_path_python
session.configure(
factory=bpy_factory,
2020-12-02 21:21:49 +08:00
python_path=python_binary_path,
external_update_handling=True)
2020-02-07 21:11:23 +08:00
# Host a session
if self.host:
2020-06-27 04:46:38 +08:00
if settings.init_method == 'EMPTY':
utils.clean_scene()
2020-06-18 04:11:20 +08:00
runtime_settings.is_host = True
runtime_settings.internet_ip = environment.get_ip()
try:
2020-09-22 00:52:27 +08:00
for scene in bpy.data.scenes:
session.add(scene)
2020-09-22 00:52:27 +08:00
session.host(
2020-02-07 21:11:23 +08:00
id=settings.username,
port=settings.port,
2020-04-08 17:15:29 +08:00
ipc_port=settings.ipc_port,
timeout=settings.connection_timeout,
password=admin_pass,
cache_directory=settings.cache_directory,
server_log_level=logging.getLevelName(
logging.getLogger().level),
2020-04-08 17:15:29 +08:00
)
2020-02-07 21:11:23 +08:00
except Exception as e:
self.report({'ERROR'}, repr(e))
2020-04-22 23:04:14 +08:00
logging.error(f"Error: {e}")
import traceback
traceback.print_exc()
2020-02-07 21:11:23 +08:00
# Join a session
else:
2020-06-10 16:15:39 +08:00
if not runtime_settings.admin:
utils.clean_scene()
# regular session, no password needed
2020-06-10 16:15:39 +08:00
admin_pass = None
2020-02-07 21:11:23 +08:00
try:
session.connect(
2020-02-07 21:11:23 +08:00
id=settings.username,
address=settings.ip,
port=settings.port,
2020-04-08 17:15:29 +08:00
ipc_port=settings.ipc_port,
timeout=settings.connection_timeout,
2020-06-10 16:15:39 +08:00
password=admin_pass
2020-02-07 21:11:23 +08:00
)
except Exception as e:
self.report({'ERROR'}, str(e))
logging.error(str(e))
2020-02-07 21:11:23 +08:00
# Background client updates service
deleyables.append(timers.ClientUpdate())
deleyables.append(timers.DynamicRightSelectTimer())
deleyables.append(timers.PushTimer(queue=stagging))
session_update = timers.SessionStatusUpdate()
session_user_sync = timers.SessionUserSync()
session_background_executor = timers.MainThreadExecutor(
execution_queue=background_execution_queue)
session_update.register()
session_user_sync.register()
session_background_executor.register()
2020-12-10 01:35:29 +08:00
deleyables.append(session_background_executor)
deleyables.append(session_update)
deleyables.append(session_user_sync)
2019-09-27 04:42:42 +08:00
self.report(
2019-09-17 05:34:12 +08:00
{'INFO'},
2020-04-22 23:04:14 +08:00
f"connecting to tcp://{settings.ip}:{settings.port}")
2019-02-11 22:48:07 +08:00
return {"FINISHED"}
2019-02-26 01:05:46 +08:00
2020-06-11 00:43:21 +08:00
class SessionInitOperator(bpy.types.Operator):
bl_idname = "session.init"
bl_label = "Init session repostitory from"
bl_description = "Init the current session"
bl_options = {"REGISTER"}
init_method: bpy.props.EnumProperty(
name='init_method',
description='Init repo',
items={
('EMPTY', 'an empty scene', 'start empty'),
('BLEND', 'current scenes', 'use current scenes')},
default='BLEND')
@classmethod
def poll(cls, context):
return True
2020-06-11 00:43:21 +08:00
def draw(self, context):
layout = self.layout
col = layout.column()
col.prop(self, 'init_method', text="")
def invoke(self, context, event):
wm = context.window_manager
return wm.invoke_props_dialog(self)
def execute(self, context):
if self.init_method == 'EMPTY':
utils.clean_scene()
for scene in bpy.data.scenes:
session.add(scene)
session.init()
2020-06-11 00:43:21 +08:00
return {"FINISHED"}
2019-08-06 17:34:39 +08:00
class SessionStopOperator(bpy.types.Operator):
bl_idname = "session.stop"
bl_label = "close"
bl_description = "Exit current session"
2019-02-12 00:02:25 +08:00
bl_options = {"REGISTER"}
@classmethod
def poll(cls, context):
return True
def execute(self, context):
2020-12-10 01:35:29 +08:00
global deleyables, stop_modal_executor
if session:
try:
session.disconnect()
except Exception as e:
self.report({'ERROR'}, repr(e))
else:
self.report({'WARNING'}, "No session to quit.")
return {"FINISHED"}
return {"FINISHED"}
2020-04-03 20:59:33 +08:00
class SessionKickOperator(bpy.types.Operator):
bl_idname = "session.kick"
bl_label = "Kick"
2020-10-16 16:57:45 +08:00
bl_description = "Kick the target user"
2020-04-03 20:59:33 +08:00
bl_options = {"REGISTER"}
user: bpy.props.StringProperty()
@classmethod
def poll(cls, context):
return True
def execute(self, context):
2020-12-10 01:35:29 +08:00
global deleyables, stop_modal_executor
assert(session)
2020-04-03 20:59:33 +08:00
try:
session.kick(self.user)
2020-04-03 20:59:33 +08:00
except Exception as e:
self.report({'ERROR'}, repr(e))
return {"FINISHED"}
def invoke(self, context, event):
return context.window_manager.invoke_props_dialog(self)
def draw(self, context):
row = self.layout
row.label(text=f" Do you really want to kick {self.user} ? ")
class SessionPropertyRemoveOperator(bpy.types.Operator):
bl_idname = "session.remove_prop"
2020-10-16 16:57:45 +08:00
bl_label = "Delete cache"
bl_description = "Stop tracking modification on the target datablock." + \
"The datablock will no longer be updated for others client. "
bl_options = {"REGISTER"}
property_path: bpy.props.StringProperty(default="None")
@classmethod
def poll(cls, context):
return True
def execute(self, context):
try:
session.remove(self.property_path)
return {"FINISHED"}
2019-09-17 05:34:12 +08:00
except: # NonAuthorizedOperationError:
2019-08-28 21:02:57 +08:00
self.report(
{'ERROR'},
"Non authorized operation")
return {"CANCELLED"}
2019-02-26 01:05:46 +08:00
class SessionPropertyRightOperator(bpy.types.Operator):
2019-04-24 23:42:23 +08:00
bl_idname = "session.right"
2020-10-16 16:57:45 +08:00
bl_label = "Change modification rights"
bl_description = "Modify the owner of the target datablock"
2019-04-24 23:42:23 +08:00
bl_options = {"REGISTER"}
key: bpy.props.StringProperty(default="None")
recursive: bpy.props.BoolProperty(default=True)
2019-04-24 23:42:23 +08:00
@classmethod
def poll(cls, context):
return True
def invoke(self, context, event):
wm = context.window_manager
return wm.invoke_props_dialog(self)
def draw(self, context):
layout = self.layout
runtime_settings = context.window_manager.session
2019-04-24 23:42:23 +08:00
2020-10-16 16:57:45 +08:00
row = layout.row()
row.label(text="Give the owning rights to:")
row.prop(runtime_settings, "clients", text="")
row = layout.row()
row.label(text="Affect dependencies")
row.prop(self, "recursive", text="")
2019-04-24 23:42:23 +08:00
def execute(self, context):
runtime_settings = context.window_manager.session
2019-04-24 23:42:23 +08:00
if session:
2020-10-21 20:40:15 +08:00
session.change_owner(self.key,
runtime_settings.clients,
ignore_warnings=True,
affect_dependencies=self.recursive)
2019-04-24 23:42:23 +08:00
return {"FINISHED"}
class SessionSnapUserOperator(bpy.types.Operator):
2019-03-14 18:04:41 +08:00
bl_idname = "session.snapview"
bl_label = "snap to user"
bl_description = "Snap 3d view to selected user"
2019-03-14 18:04:41 +08:00
bl_options = {"REGISTER"}
2019-10-15 21:04:34 +08:00
_timer = None
2019-07-10 23:16:44 +08:00
target_client: bpy.props.StringProperty(default="None")
2019-03-14 18:04:41 +08:00
@classmethod
def poll(cls, context):
return True
def execute(self, context):
2019-10-15 21:04:34 +08:00
wm = context.window_manager
runtime_settings = context.window_manager.session
if runtime_settings.time_snap_running:
runtime_settings.time_snap_running = False
return {'CANCELLED'}
else:
runtime_settings.time_snap_running = True
2019-10-15 21:04:34 +08:00
self._timer = wm.event_timer_add(0.1, window=context.window)
wm.modal_handler_add(self)
return {'RUNNING_MODAL'}
2019-03-14 18:04:41 +08:00
2019-10-15 21:04:34 +08:00
def cancel(self, context):
wm = context.window_manager
wm.event_timer_remove(self._timer)
2019-05-02 23:58:37 +08:00
2019-10-15 21:04:34 +08:00
def modal(self, context, event):
session_sessings = context.window_manager.session
is_running = session_sessings.time_snap_running
if event.type in {'RIGHTMOUSE', 'ESC'} or not is_running:
2019-10-15 21:04:34 +08:00
self.cancel(context)
return {'CANCELLED'}
if event.type == 'TIMER':
2020-10-06 05:38:52 +08:00
area, region, rv3d = view3d_find()
2019-10-15 21:04:34 +08:00
if session:
target_ref = session.online_users.get(self.target_client)
2020-01-22 22:15:44 +08:00
if target_ref:
target_scene = target_ref['metadata']['scene_current']
# Handle client on other scenes
if target_scene != context.scene.name:
blender_scene = bpy.data.scenes.get(target_scene, None)
if blender_scene is None:
self.report(
{'ERROR'}, f"Scene {target_scene} doesn't exist on the local client.")
session_sessings.time_snap_running = False
return {"CANCELLED"}
bpy.context.window.scene = blender_scene
# Update client viewmatrix
client_vmatrix = target_ref['metadata'].get(
'view_matrix', None)
if client_vmatrix:
rv3d.view_matrix = mathutils.Matrix(client_vmatrix)
else:
self.report({'ERROR'}, f"Client viewport not ready.")
session_sessings.time_snap_running = False
return {"CANCELLED"}
2019-10-15 21:04:34 +08:00
else:
return {"CANCELLED"}
2019-03-14 18:04:41 +08:00
2019-10-15 21:04:34 +08:00
return {'PASS_THROUGH'}
2019-03-14 18:04:41 +08:00
2019-03-25 21:56:09 +08:00
class SessionSnapTimeOperator(bpy.types.Operator):
bl_idname = "session.snaptime"
bl_label = "snap to user time"
bl_description = "Snap time to selected user time's"
bl_options = {"REGISTER"}
_timer = None
target_client: bpy.props.StringProperty(default="None")
@classmethod
def poll(cls, context):
return True
def execute(self, context):
runtime_settings = context.window_manager.session
if runtime_settings.user_snap_running:
runtime_settings.user_snap_running = False
return {'CANCELLED'}
else:
runtime_settings.user_snap_running = True
wm = context.window_manager
self._timer = wm.event_timer_add(0.05, window=context.window)
wm.modal_handler_add(self)
return {'RUNNING_MODAL'}
def cancel(self, context):
wm = context.window_manager
wm.event_timer_remove(self._timer)
def modal(self, context, event):
is_running = context.window_manager.session.user_snap_running
if event.type in {'RIGHTMOUSE', 'ESC'} or not is_running:
self.cancel(context)
return {'CANCELLED'}
if event.type == 'TIMER':
if session:
target_ref = session.online_users.get(self.target_client)
if target_ref:
context.scene.frame_current = target_ref['metadata']['frame_current']
else:
return {"CANCELLED"}
return {'PASS_THROUGH'}
2019-08-10 00:14:32 +08:00
class SessionApply(bpy.types.Operator):
bl_idname = "session.apply"
2020-10-16 16:57:45 +08:00
bl_label = "Revert"
bl_description = "Revert the selected datablock from his cached" + \
" version."
bl_options = {"REGISTER"}
target: bpy.props.StringProperty()
2020-10-15 18:11:28 +08:00
reset_dependencies: bpy.props.BoolProperty(default=False)
@classmethod
def poll(cls, context):
return True
def execute(self, context):
2020-10-15 01:12:28 +08:00
logging.debug(f"Running apply on {self.target}")
try:
session.apply(self.target,
force=True,
force_dependencies=self.reset_dependencies)
except Exception as e:
self.report({'ERROR'}, repr(e))
return {"CANCELED"}
2019-08-10 00:14:32 +08:00
return {"FINISHED"}
2019-07-02 00:04:35 +08:00
2019-09-17 05:34:12 +08:00
2019-08-28 19:13:32 +08:00
class SessionCommit(bpy.types.Operator):
bl_idname = "session.commit"
2020-10-16 16:57:45 +08:00
bl_label = "Force server update"
bl_description = "Commit and push the target datablock to server"
2019-08-28 19:13:32 +08:00
bl_options = {"REGISTER"}
target: bpy.props.StringProperty()
2019-08-28 19:13:32 +08:00
@classmethod
def poll(cls, context):
return True
def execute(self, context):
try:
session.commit(uuid=self.target)
session.push(self.target)
return {"FINISHED"}
except Exception as e:
self.report({'ERROR'}, repr(e))
return {"CANCELED"}
2019-12-03 00:34:08 +08:00
class ApplyArmatureOperator(bpy.types.Operator):
"""Operator which runs its self from a timer"""
2019-12-03 00:34:08 +08:00
bl_idname = "session.apply_armature_operator"
bl_label = "Modal Executor Operator"
_timer = None
def modal(self, context, event):
global stop_modal_executor, modal_executor_queue
if stop_modal_executor:
self.cancel(context)
return {'CANCELLED'}
if event.type == 'TIMER':
if session and session.state['STATE'] == STATE_ACTIVE:
nodes = session.list(filter=bl_types.bl_armature.BlArmature)
for node in nodes:
node_ref = session.get(uuid=node)
if node_ref.state == FETCHED:
try:
session.apply(node)
except Exception as e:
2020-07-09 21:52:42 +08:00
logging.error("Fail to apply armature: {e}")
2019-12-03 00:34:08 +08:00
return {'PASS_THROUGH'}
def execute(self, context):
wm = context.window_manager
self._timer = wm.event_timer_add(2, window=context.window)
wm.modal_handler_add(self)
return {'RUNNING_MODAL'}
def cancel(self, context):
global stop_modal_executor
wm = context.window_manager
wm.event_timer_remove(self._timer)
stop_modal_executor = False
2019-12-03 00:34:08 +08:00
2019-09-17 05:34:12 +08:00
2020-11-26 05:53:38 +08:00
class SessionClearCache(bpy.types.Operator):
2020-09-21 22:47:49 +08:00
"Clear local session cache"
bl_idname = "session.clear_cache"
bl_label = "Modal Executor Operator"
@classmethod
def poll(cls, context):
return True
def execute(self, context):
cache_dir = utils.get_preferences().cache_directory
2020-09-21 22:47:49 +08:00
try:
for root, dirs, files in os.walk(cache_dir):
for name in files:
Path(root, name).unlink()
except Exception as e:
self.report({'ERROR'}, repr(e))
return {"FINISHED"}
def invoke(self, context, event):
return context.window_manager.invoke_props_dialog(self)
def draw(self, context):
row = self.layout
row.label(text=f" Do you really want to remove local cache ? ")
2020-11-26 05:53:38 +08:00
class SessionNotifyOperator(bpy.types.Operator):
"""Dialog only operator"""
bl_idname = "session.notify"
bl_label = "Multi-user"
bl_description = "multiuser notification"
2020-11-26 05:53:38 +08:00
message: bpy.props.StringProperty()
@classmethod
def poll(cls, context):
return True
def execute(self, context):
return {'FINISHED'}
def draw(self, context):
layout = self.layout
2020-12-03 20:30:54 +08:00
layout.row().label(text=self.message)
2020-11-26 05:53:38 +08:00
def invoke(self, context, event):
return context.window_manager.invoke_props_dialog(self)
2020-11-26 05:53:38 +08:00
2020-12-12 06:02:20 +08:00
def dump_db(filepath):
# Replication graph
nodes_ids = session.list()
#TODO: add dump graph to replication
nodes =[]
for n in nodes_ids:
nd = session.get(uuid=n)
nodes.append((
n,
{
'owner': nd.owner,
'str_type': nd.str_type,
'data': nd.data,
'dependencies': nd.dependencies,
}
))
db = dict()
db['nodes'] = nodes
db['users'] = copy.copy(session.online_users)
stime = datetime.now().strftime('%Y_%m_%d_%H-%M-%S')
filepath = Path(filepath)
filepath = filepath.with_name(f"{filepath.stem}_{stime}{filepath.suffix}")
with gzip.open(filepath, "wb") as f:
logging.info(f"Writing session snapshot to {filepath}")
2020-12-12 06:02:20 +08:00
pickle.dump(db, f, protocol=4)
class SessionSaveBackupOperator(bpy.types.Operator, ExportHelper):
bl_idname = "session.save"
bl_label = "Save session data"
bl_description = "Save a snapshot of the collaborative session"
2020-12-10 20:31:43 +08:00
# ExportHelper mixin class uses this
filename_ext = ".db"
filter_glob: bpy.props.StringProperty(
default="*.db",
options={'HIDDEN'},
maxlen=255, # Max internal buffer length, longer would be clamped.
)
enable_autosave: bpy.props.BoolProperty(
name="Auto-save",
description="Enable session auto-save",
default=True,
)
save_interval: bpy.props.FloatProperty(
name="Auto save interval",
description="auto-save interval (seconds)",
default=10,
)
2020-12-10 20:31:43 +08:00
def execute(self, context):
if self.enable_autosave:
recorder = timers.SessionBackupTimer(
filepath=self.filepath,
timeout=self.save_interval)
recorder.register()
deleyables.append(recorder)
else:
dump_db(self.filepath)
2020-12-10 20:31:43 +08:00
return {'FINISHED'}
2020-12-10 22:50:43 +08:00
@classmethod
def poll(cls, context):
return session.state['STATE'] == STATE_ACTIVE
class SessionStopAutoSaveOperator(bpy.types.Operator):
bl_idname = "session.cancel_autosave"
bl_label = "Cancel auto-save"
bl_description = "Cancel session auto-save"
@classmethod
def poll(cls, context):
return (session.state['STATE'] == STATE_ACTIVE and 'SessionBackupTimer' in registry)
def execute(self, context):
autosave_timer = registry.get('SessionBackupTimer')
autosave_timer.unregister()
return {'FINISHED'}
class SessionLoadSaveOperator(bpy.types.Operator, ImportHelper):
2020-12-16 18:05:58 +08:00
bl_idname = "session.load"
bl_label = "Load session save"
bl_description = "Load a Multi-user session save"
2020-12-16 18:05:58 +08:00
bl_options = {'REGISTER', 'UNDO'}
# ExportHelper mixin class uses this
filename_ext = ".db"
filter_glob: bpy.props.StringProperty(
default="*.db",
options={'HIDDEN'},
maxlen=255, # Max internal buffer length, longer would be clamped.
)
2020-12-16 18:05:58 +08:00
def execute(self, context):
from replication.graph import ReplicationGraph
2020-12-16 18:05:58 +08:00
# TODO: add filechecks
try:
f = gzip.open(self.filepath, "rb")
db = pickle.load(f)
except OSError as e:
f = open(self.filepath, "rb")
db = pickle.load(f)
if db:
logging.info(f"Reading {self.filepath}")
nodes = db.get("nodes")
logging.info(f"{len(nodes)} Nodes to load")
# init the factory with supported types
bpy_factory = ReplicatedDataFactory()
for type in bl_types.types_to_register():
type_module = getattr(bl_types, type)
name = [e.capitalize() for e in type.split('_')[1:]]
type_impl_name = 'Bl'+''.join(name)
type_module_class = getattr(type_module, type_impl_name)
bpy_factory.register_type(
type_module_class.bl_class,
type_module_class)
graph = ReplicationGraph()
for node, node_data in nodes:
node_type = node_data.get('str_type')
impl = bpy_factory.get_implementation_from_net(node_type)
if impl:
logging.info(f"Loading {node}")
instance = impl(owner=node_data['owner'],
uuid=node,
dependencies=node_data['dependencies'],
data=node_data['data'])
instance.store(graph)
instance.state = FETCHED
logging.info("Graph succefully loaded")
utils.clean_scene()
# Step 1: Construct nodes
for node in graph.list_ordered():
graph[node].resolve()
# Step 2: Load nodes
for node in graph.list_ordered():
graph[node].apply()
return {'FINISHED'}
@classmethod
def poll(cls, context):
return True
def menu_func_import(self, context):
self.layout.operator(SessionLoadSaveOperator.bl_idname, text='Multi-user session snapshot (.db)')
2020-12-16 18:05:58 +08:00
2020-12-10 20:31:43 +08:00
classes = (
SessionStartOperator,
SessionStopOperator,
SessionPropertyRemoveOperator,
SessionSnapUserOperator,
SessionSnapTimeOperator,
SessionPropertyRightOperator,
2019-08-10 00:14:32 +08:00
SessionApply,
2019-08-28 19:13:32 +08:00
SessionCommit,
2019-12-03 00:34:08 +08:00
ApplyArmatureOperator,
2020-04-03 20:59:33 +08:00
SessionKickOperator,
2020-06-11 00:43:21 +08:00
SessionInitOperator,
2020-11-26 05:53:38 +08:00
SessionClearCache,
SessionNotifyOperator,
SessionSaveBackupOperator,
SessionLoadSaveOperator,
SessionStopAutoSaveOperator,
)
@persistent
def sanitize_deps_graph(dummy):
"""sanitize deps graph
Temporary solution to resolve each node pointers after a Undo.
A future solution should be to avoid storing dataclock reference...
"""
if session and session.state['STATE'] == STATE_ACTIVE:
start = utils.current_milli_time()
for node_key in session.list():
2020-12-24 00:27:43 +08:00
node = session.get(node_key)
node.resolve(construct=False)
logging.debug(f"Sanitize took { utils.current_milli_time()-start}ms")
2020-12-24 00:27:43 +08:00
@persistent
def load_pre_handler(dummy):
if session and session.state['STATE'] in [STATE_ACTIVE, STATE_SYNCING]:
bpy.ops.session.stop()
@persistent
def update_client_frame(scene):
if session and session.state['STATE'] == STATE_ACTIVE:
session.update_user_metadata({
'frame_current': scene.frame_current
})
2020-01-25 00:52:10 +08:00
@persistent
def depsgraph_evaluation(scene):
if session and session.state['STATE'] == STATE_ACTIVE:
2020-01-25 00:52:10 +08:00
context = bpy.context
blender_depsgraph = bpy.context.view_layer.depsgraph
dependency_updates = [u for u in blender_depsgraph.updates]
settings = utils.get_preferences()
2020-01-25 00:52:10 +08:00
# NOTE: maybe we don't need to check each update but only the first
for update in reversed(dependency_updates):
# Is the object tracked ?
if update.id.uuid:
# Retrieve local version
node = session.get(uuid=update.id.uuid)
2020-01-25 00:52:10 +08:00
# Check our right on this update:
# - if its ours or ( under common and diff), launch the
# update process
# - if its to someone else, ignore the update (go deeper ?)
if node and node.owner in [session.id, RP_COMMON]:
if node.state == UP:
# Avoid slow geometry update
if 'EDIT' in context.mode and \
not settings.sync_flags.sync_during_editmode:
break
if node.uuid not in stagging:
stagging.append(node.uuid)
2020-01-25 00:52:10 +08:00
else:
# Distant update
continue
# else:
# # New items !
2020-02-23 21:08:45 +08:00
# logger.error("UPDATE: ADD")
2020-01-25 00:52:10 +08:00
2019-02-09 01:34:10 +08:00
def register():
from bpy.utils import register_class
2020-10-06 21:46:35 +08:00
2020-12-17 21:04:00 +08:00
for cls in classes:
2019-02-09 01:34:10 +08:00
register_class(cls)
2019-07-10 23:16:44 +08:00
bpy.app.handlers.undo_post.append(sanitize_deps_graph)
bpy.app.handlers.redo_post.append(sanitize_deps_graph)
bpy.app.handlers.load_pre.append(load_pre_handler)
bpy.app.handlers.frame_change_pre.append(update_client_frame)
def unregister():
if session and session.state['STATE'] == STATE_ACTIVE:
session.disconnect()
2019-02-09 01:34:10 +08:00
from bpy.utils import unregister_class
for cls in reversed(classes):
unregister_class(cls)
bpy.app.handlers.undo_post.remove(sanitize_deps_graph)
bpy.app.handlers.redo_post.remove(sanitize_deps_graph)
2019-09-17 05:34:12 +08:00
bpy.app.handlers.load_pre.remove(load_pre_handler)
bpy.app.handlers.frame_change_pre.remove(update_client_frame)