Fix T50954: Improve Blender Cloud add-on project selector

Attract and Flamenco features are (de)activated based on the extensions
enabled on the selected project. As a result, anyone can use the add-on
again, without seeing Attract or Flamenco things they can't use.
This commit is contained in:
Sybren A. Stüvel 2017-03-17 15:08:09 +01:00
parent 5b77ae50a1
commit c24501661e
5 changed files with 217 additions and 60 deletions

View File

@ -94,6 +94,8 @@ def register():
image_sharing.register()
attract.register()
blender.handle_project_update()
def _monkey_patch_requests():
"""Monkey-patch old versions of Requests.

View File

@ -60,6 +60,9 @@ from bpy.types import Operator, Panel, AddonPreferences
log = logging.getLogger(__name__)
# Global flag used to determine whether panels etc. can be drawn.
attract_is_active = False
def active_strip(context):
try:
@ -139,6 +142,9 @@ def shot_id_use(strips):
def compute_strip_conflicts(scene):
"""Sets the strip property atc_object_id_conflict for each strip."""
if not attract_is_active:
return
if not scene or not scene.sequence_editor or not scene.sequence_editor.sequences_all:
return
@ -161,7 +167,13 @@ def scene_update_post_handler(scene):
compute_strip_conflicts(scene)
class ToolsPanel(Panel):
class AttractPollMixin:
@classmethod
def poll(cls, context):
return attract_is_active
class ToolsPanel(AttractPollMixin, Panel):
bl_label = 'Attract'
bl_space_type = 'SEQUENCE_EDITOR'
bl_region_type = 'UI'
@ -238,7 +250,7 @@ class ToolsPanel(Panel):
layout.operator(ATTRACT_OT_submit_all.bl_idname)
class AttractOperatorMixin:
class AttractOperatorMixin(AttractPollMixin):
"""Mix-in class for all Attract operators."""
def _project_needs_setup_error(self):
@ -261,7 +273,7 @@ class AttractOperatorMixin:
from .. import pillar, blender
prefs = blender.preferences()
project = self.find_project(prefs.attract_project.project)
project = self.find_project(prefs.project.project)
# FIXME: Eve doesn't seem to handle the $elemMatch projection properly,
# even though it works fine in MongoDB itself. As a result, we have to
@ -295,7 +307,7 @@ class AttractOperatorMixin:
'cut_in_timeline_in_frames': strip.frame_final_start},
'order': 0,
'node_type': 'attract_shot',
'project': blender.preferences().attract_project.project,
'project': blender.preferences().project.project,
'user': user_uuid}
# Create a Node item with the attract API
@ -373,7 +385,7 @@ class AttractShotFetchUpdate(AttractOperatorMixin, Operator):
@classmethod
def poll(cls, context):
return any(selected_shots(context))
return AttractOperatorMixin.poll(context) and any(selected_shots(context))
def execute(self, context):
for strip in selected_shots(context):
@ -393,6 +405,9 @@ class AttractShotRelink(AttractShotFetchUpdate):
@classmethod
def poll(cls, context):
if not AttractOperatorMixin.poll(context):
return False
strip = active_strip(context)
return strip is not None and not getattr(strip, 'atc_object_id', None)
@ -433,7 +448,8 @@ class ATTRACT_OT_shot_open_in_browser(AttractOperatorMixin, Operator):
@classmethod
def poll(cls, context):
return bool(context.selected_sequences and active_strip(context))
return AttractOperatorMixin.poll(context) and \
bool(context.selected_sequences and active_strip(context))
def execute(self, context):
from ..blender import PILLAR_WEB_SERVER_URL
@ -459,7 +475,8 @@ class AttractShotDelete(AttractOperatorMixin, Operator):
@classmethod
def poll(cls, context):
return bool(context.selected_sequences)
return AttractOperatorMixin.poll(context) and \
bool(context.selected_sequences)
def execute(self, context):
from .. import pillar
@ -511,7 +528,8 @@ class AttractStripUnlink(AttractOperatorMixin, Operator):
@classmethod
def poll(cls, context):
return bool(context.selected_sequences)
return AttractOperatorMixin.poll(context) and \
bool(context.selected_sequences)
def execute(self, context):
unlinked_ids = set()
@ -554,7 +572,8 @@ class AttractShotSubmitSelected(AttractOperatorMixin, Operator):
@classmethod
def poll(cls, context):
return bool(context.selected_sequences)
return AttractOperatorMixin.poll(context) and \
bool(context.selected_sequences)
def execute(self, context):
# Check that the project is set up for Attract.
@ -610,7 +629,8 @@ class ATTRACT_OT_open_meta_blendfile(AttractOperatorMixin, Operator):
@classmethod
def poll(cls, context):
return bool(any(cls.filename_from_metadata(s) for s in context.selected_sequences))
return AttractOperatorMixin.poll(context) and \
bool(any(cls.filename_from_metadata(s) for s in context.selected_sequences))
@staticmethod
def filename_from_metadata(strip):
@ -677,7 +697,7 @@ class ATTRACT_OT_make_shot_thumbnail(AttractOperatorMixin,
@classmethod
def poll(cls, context):
return bool(context.selected_sequences)
return AttractOperatorMixin.poll(context) and bool(context.selected_sequences)
@contextlib.contextmanager
def thumbnail_render_settings(self, context, thumbnail_width=512):
@ -843,7 +863,7 @@ class ATTRACT_OT_make_shot_thumbnail(AttractOperatorMixin,
from .. import blender
prefs = blender.preferences()
project = self.find_project(prefs.attract_project.project)
project = self.find_project(prefs.project.project)
self.log.info('Uploading file %s', filename)
resp = await pillar.pillar_call(
@ -873,7 +893,8 @@ class ATTRACT_OT_copy_id_to_clipboard(AttractOperatorMixin, Operator):
@classmethod
def poll(cls, context):
return bool(context.selected_sequences and active_strip(context))
return AttractOperatorMixin.poll(context) and \
bool(context.selected_sequences and active_strip(context))
def execute(self, context):
strip = active_strip(context)
@ -905,6 +926,29 @@ def draw_strip_movie_meta(self, context):
box.label('Original Frame Range: %s-%s' % (sfra, efra))
def activate():
global attract_is_active
log.info('Activating Attract')
attract_is_active = True
bpy.app.handlers.scene_update_post.append(scene_update_post_handler)
draw.callback_enable()
def deactivate():
global attract_is_active
log.info('Deactivating Attract')
attract_is_active = False
draw.callback_disable()
try:
bpy.app.handlers.scene_update_post.remove(scene_update_post_handler)
except ValueError:
# This is thrown when scene_update_post_handler does not exist in the handler list.
pass
def register():
bpy.types.Sequence.atc_is_synced = bpy.props.BoolProperty(name="Is Synced")
bpy.types.Sequence.atc_object_id = bpy.props.StringProperty(name="Attract Object ID")
@ -942,13 +986,9 @@ def register():
bpy.utils.register_class(ATTRACT_OT_make_shot_thumbnail)
bpy.utils.register_class(ATTRACT_OT_copy_id_to_clipboard)
bpy.app.handlers.scene_update_post.append(scene_update_post_handler)
draw.callback_enable()
def unregister():
draw.callback_disable()
bpy.app.handlers.scene_update_post.remove(scene_update_post_handler)
deactivate()
bpy.utils.unregister_module(__name__)
del bpy.types.Sequence.atc_is_synced
del bpy.types.Sequence.atc_object_id

View File

@ -172,6 +172,11 @@ def callback_disable():
if not cb_handle:
return
bpy.types.SpaceSequenceEditor.draw_handler_remove(cb_handle[0], 'WINDOW')
try:
bpy.types.SpaceSequenceEditor.draw_handler_remove(cb_handle[0], 'WINDOW')
except ValueError:
# Thrown when already removed.
pass
cb_handle.clear()
tag_redraw_all_sequencer_editors()

View File

@ -20,7 +20,7 @@
Separated from __init__.py so that we can import & run from non-Blender environments.
"""
import functools
import logging
import os.path
@ -109,13 +109,61 @@ class SyncStatusProperties(PropertyGroup):
def bcloud_available_projects(self, context):
"""Returns the list of items used by BlenderCloudProjectGroup.project EnumProperty."""
attr_proj = preferences().attract_project
projs = attr_proj.available_projects
projs = preferences().project.available_projects
if not projs:
return [('', 'No projects available in your Blender Cloud', '')]
return [(p['_id'], p['name'], '') for p in projs]
@functools.lru_cache(1)
def project_extensions(project_id) -> set:
"""Returns the extensions the project is enabled for.
At the moment of writing these are 'attract' and 'flamenco'.
"""
log.debug('Finding extensions for project %s', project_id)
# We can't use our @property, since the preferences may be loaded from a
# preferences blend file, in which case it is not constructed from Python code.
available_projects = preferences().project.get('available_projects', [])
if not available_projects:
log.debug('No projects available.')
return set()
proj = next((p for p in available_projects
if p['_id'] == project_id), None)
if proj is None:
log.debug('Project %s not found in available projects.', project_id)
return set()
return set(proj.get('enabled_for', ()))
def handle_project_update(_=None, _2=None):
"""Handles changing projects, which may cause extensions to be disabled/enabled.
Ignores arguments so that it can be used as property update callback.
"""
project_id = preferences().project.project
log.info('Updating internal state to reflect extensions enabled on current project %s.',
project_id)
project_extensions.cache_clear()
from blender_cloud import attract, flamenco
attract.deactivate()
flamenco.deactivate()
enabled_for = project_extensions(project_id)
log.info('Project extensions: %s', enabled_for)
if 'attract' in enabled_for:
attract.activate()
if 'flamenco' in enabled_for:
flamenco.activate()
class BlenderCloudProjectGroup(PropertyGroup):
status = EnumProperty(
items=[
@ -129,7 +177,9 @@ class BlenderCloudProjectGroup(PropertyGroup):
project = EnumProperty(
items=bcloud_available_projects,
name='Cloud project',
description='Which Blender Cloud project to work with')
description='Which Blender Cloud project to work with',
update=handle_project_update
)
# List of projects is stored in 'available_projects' ID property,
# because I don't know how to store a variable list of strings in a proper RNA property.
@ -140,6 +190,7 @@ class BlenderCloudProjectGroup(PropertyGroup):
@available_projects.setter
def available_projects(self, new_projects):
self['available_projects'] = new_projects
handle_project_update()
class BlenderCloudPreferences(AddonPreferences):
@ -165,9 +216,10 @@ class BlenderCloudPreferences(AddonPreferences):
default=True
)
# TODO: store local path with the Attract project, so that people
# can switch projects and the local path switches with it.
attract_project = PointerProperty(type=BlenderCloudProjectGroup)
# TODO: store project-dependent properties with the project, so that people
# can switch projects and the Attract and Flamenco properties switch with it.
project = PointerProperty(type=BlenderCloudProjectGroup)
attract_project_local_path = StringProperty(
name='Local Project Path',
description='Local path of your Attract project, used to search for blend files; '
@ -219,8 +271,8 @@ class BlenderCloudPreferences(AddonPreferences):
blender_id_profile = None
else:
blender_id_profile = blender_id.get_active_profile()
if blender_id is None:
msg_icon = 'ERROR'
text = 'This add-on requires Blender ID'
help_text = 'Make sure that the Blender ID add-on is installed and activated'
@ -286,13 +338,22 @@ class BlenderCloudPreferences(AddonPreferences):
share_box.label('Image Sharing on Blender Cloud', icon_value=icon('CLOUD'))
share_box.prop(self, 'open_browser_after_share')
# Project selector
project_box = layout.box()
project_box.enabled = self.project.status in {'NONE', 'IDLE'}
self.draw_project_selector(project_box, self.project)
extensions = project_extensions(self.project.project)
# Attract stuff
attract_box = layout.box()
self.draw_attract_buttons(attract_box, self.attract_project)
if 'attract' in extensions:
attract_box = project_box.column()
self.draw_attract_buttons(attract_box, self.project)
# Flamenco stuff
flamenco_box = layout.box()
self.draw_flamenco_buttons(flamenco_box, self.flamenco_manager, context)
if 'flamenco' in extensions:
flamenco_box = project_box.column()
self.draw_flamenco_buttons(flamenco_box, self.flamenco_manager, context)
def draw_subscribe_button(self, layout):
layout.operator('pillar.subscribe', icon='WORLD')
@ -328,12 +389,11 @@ class BlenderCloudPreferences(AddonPreferences):
else:
row_pull.label('Cloud Sync is running.')
def draw_attract_buttons(self, attract_box, bcp: BlenderCloudProjectGroup):
attract_row = attract_box.row(align=True)
attract_row.label('Attract', icon_value=icon('CLOUD'))
def draw_project_selector(self, project_box, bcp: BlenderCloudProjectGroup):
project_row = project_box.row(align=True)
project_row.label('Project settings', icon_value=icon('CLOUD'))
attract_row.enabled = bcp.status in {'NONE', 'IDLE'}
row_buttons = attract_row.row(align=True)
row_buttons = project_row.row(align=True)
projects = bcp.available_projects
project = bcp.project
@ -350,27 +410,38 @@ class BlenderCloudPreferences(AddonPreferences):
else:
row_buttons.label('Fetching available projects.')
attract_box.prop(self, 'attract_project_local_path')
enabled_for = project_extensions(project)
if project:
if enabled_for:
project_box.label('This project is set up for: %s' %
', '.join(sorted(enabled_for)))
else:
project_box.label('This project is not set up for Attract or Flamenco')
def draw_attract_buttons(self, attract_box, bcp: BlenderCloudProjectGroup):
header_row = attract_box.row(align=True)
header_row.label('Attract:', icon_value=icon('CLOUD'))
attract_box.prop(self, 'attract_project_local_path',
text='Local Attract project path')
def draw_flamenco_buttons(self, flamenco_box, bcp: flamenco.FlamencoManagerGroup, context):
flamenco_row = flamenco_box.row(align=True)
flamenco_row.label('Flamenco', icon_value=icon('CLOUD'))
header_row = flamenco_box.row(align=True)
header_row.label('Flamenco:', icon_value=icon('CLOUD'))
flamenco_row.enabled = bcp.status in {'NONE', 'IDLE'}
row_buttons = flamenco_row.row(align=True)
manager_box = flamenco_box.row(align=True)
if bcp.status in {'NONE', 'IDLE'}:
if not bcp.available_managers or not bcp.manager:
row_buttons.operator('flamenco.managers',
manager_box.operator('flamenco.managers',
text='Find Flamenco Managers',
icon='FILE_REFRESH')
else:
row_buttons.prop(bcp, 'manager', text='Manager')
row_buttons.operator('flamenco.managers',
manager_box.prop(bcp, 'manager', text='Manager')
manager_box.operator('flamenco.managers',
text='',
icon='FILE_REFRESH')
else:
row_buttons.label('Fetching available managers.')
manager_box.label('Fetching available managers.')
path_box = flamenco_box.row(align=True)
path_box.prop(self, 'flamenco_job_file_path')
@ -400,11 +471,6 @@ class BlenderCloudPreferences(AddonPreferences):
flamenco_box.prop(self, 'flamenco_open_browser_after_submit')
# TODO: make a reusable way to select projects, and use that for Attract and Flamenco.
note_box = flamenco_box.column(align=True)
note_box.label('NOTE: For now, Flamenco uses the same project as Attract.')
note_box.label('This will change in a future version of the add-on.')
class PillarCredentialsUpdate(pillar.PillarOperatorMixin,
Operator):
@ -488,7 +554,7 @@ class PILLAR_OT_projects(async_loop.AsyncModalOperatorMixin,
self.log.info('Going to fetch projects for user %s', self.user_id)
preferences().attract_project.status = 'FETCHING'
preferences().project.status = 'FETCHING'
# Get all projects, except the home project.
projects_user = await pillar_call(
@ -497,7 +563,8 @@ class PILLAR_OT_projects(async_loop.AsyncModalOperatorMixin,
'category': {'$ne': 'home'}},
'sort': '-_created',
'projection': {'_id': True,
'name': True},
'name': True,
'extension_props': True},
})
projects_shared = await pillar_call(
@ -506,20 +573,34 @@ class PILLAR_OT_projects(async_loop.AsyncModalOperatorMixin,
'permissions.groups.group': {'$in': self.db_user.groups}},
'sort': '-_created',
'projection': {'_id': True,
'name': True},
'name': True,
'extension_props': True},
})
# We need to convert to regular dicts before storing in ID properties.
# Also don't store more properties than we need.
projects = [{'_id': p['_id'], 'name': p['name']} for p in projects_user['_items']] + \
[{'_id': p['_id'], 'name': p['name']} for p in projects_shared['_items']]
def reduce_properties(project_list):
for p in project_list:
p = p.to_dict()
extension_props = p.get('extension_props', {})
enabled_for = list(extension_props.keys())
preferences().attract_project.available_projects = projects
self._log.debug('Project %r is enabled for %s', p['name'], enabled_for)
yield {
'_id': p['_id'],
'name': p['name'],
'enabled_for': enabled_for,
}
projects = list(reduce_properties(projects_user['_items'])) + \
list(reduce_properties(projects_shared['_items']))
preferences().project.available_projects = projects
self.quit()
def quit(self):
preferences().attract_project.status = 'IDLE'
preferences().project.status = 'IDLE'
super().quit()

View File

@ -34,6 +34,9 @@ from ..utils import pyside_cache, redraw
log = logging.getLogger(__name__)
# Global flag used to determine whether panels etc. can be drawn.
flamenco_is_active = False
@pyside_cache('manager')
def available_managers(self, context):
@ -73,8 +76,15 @@ class FlamencoManagerGroup(PropertyGroup):
self['available_managers'] = new_managers
class FlamencoPollMixin:
@classmethod
def poll(cls, context):
return flamenco_is_active
class FLAMENCO_OT_fmanagers(async_loop.AsyncModalOperatorMixin,
pillar.AuthenticatedPillarOperatorMixin,
FlamencoPollMixin,
Operator):
"""Fetches the Flamenco Managers available to the user"""
bl_idname = 'flamenco.managers'
@ -115,6 +125,7 @@ class FLAMENCO_OT_fmanagers(async_loop.AsyncModalOperatorMixin,
class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
pillar.AuthenticatedPillarOperatorMixin,
FlamencoPollMixin,
Operator):
"""Performs a Blender render on Flamenco."""
bl_idname = 'flamenco.render'
@ -176,7 +187,7 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
try:
job_info = await create_job(self.user_id,
prefs.attract_project.project,
prefs.project.project,
prefs.flamenco_manager.manager,
scene.flamenco_render_job_type,
settings,
@ -308,7 +319,7 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
return outfile, missing_sources
class FLAMENCO_OT_scene_to_frame_range(Operator):
class FLAMENCO_OT_scene_to_frame_range(FlamencoPollMixin, Operator):
"""Sets the scene frame range as the Flamenco render frame range."""
bl_idname = 'flamenco.scene_to_frame_range'
bl_label = 'Sets the scene frame range as the Flamenco render frame range'
@ -321,6 +332,7 @@ class FLAMENCO_OT_scene_to_frame_range(Operator):
class FLAMENCO_OT_copy_files(Operator,
FlamencoPollMixin,
async_loop.AsyncModalOperatorMixin):
"""Uses BAM to copy the current blendfile + dependencies to the target directory."""
bl_idname = 'flamenco.copy_files'
@ -491,7 +503,7 @@ def render_output_path(context, filepath: Path = None) -> typing.Optional[PurePa
)
class FLAMENCO_PT_render(bpy.types.Panel):
class FLAMENCO_PT_render(bpy.types.Panel, FlamencoPollMixin):
bl_label = "Flamenco Render"
bl_space_type = 'PROPERTIES'
bl_region_type = 'WINDOW'
@ -556,6 +568,22 @@ class FLAMENCO_PT_render(bpy.types.Panel):
layout.label('Unknown Flamenco status %s' % flamenco_status)
def activate():
"""Activates draw callbacks, menu items etc. for Flamenco."""
global flamenco_is_active
log.info('Activating Flamenco')
flamenco_is_active = True
def deactivate():
"""Deactivates draw callbacks, menu items etc. for Flamenco."""
global flamenco_is_active
log.info('Deactivating Flamenco')
flamenco_is_active = False
def register():
from ..utils import redraw
@ -615,6 +643,7 @@ def register():
def unregister():
deactivate()
bpy.utils.unregister_module(__name__)
try: