Bumped version to 1.15 and marked as released in CHANGELOG

No functional changes.

.gitignore

@@ -7,3 +7,4 @@ blender_cloud/wheels/*.whl
 /dist/
 /build/
 /addon-bundle/*.zip
+__pycache__

CHANGELOG.md

@@ -0,0 +1,198 @@
+# Blender Cloud changelog
+
+## Version 1.15 (2019-12-12)
+
+- Avoid creating BAT pack when the to-be-rendered file is already inside the job storage
+  directory. This assumes that the paths are already correct for the Flamenco Workers.
+
+
+## Version 1.14 (2019-10-10)
+
+- Upgraded BAT to 1.2 for missing smoke caches, compatibility with Blender 2.81, and some
+  Windows-specific fixes.
+- Removed warnings on the terminal when running Blender 2.80+
+
+
+## Version 1.13 (2019-04-18)
+
+- Upgraded BAT to 1.1.1 for a compatibility fix with Blender 2.79
+- Flamenco: Support for Flamenco Manager settings versioning + for settings version 2.
+  When using Blender Cloud Add-on 1.12 or older, Flamenco Server will automatically convert the
+  Manager settings to version 1.
+- More Blender 2.80 compatibility fixes
+
+
+## Version 1.12 (2019-03-25)
+
+- Flamenco: Change how progressive render tasks are created. Instead of the artist setting a fixed
+  number of sample chunks, they can now set a maximum number of samples for each render task.
+  Initial render tasks are created with a low number of samples, and subsequent tasks have an
+  increasing number of samples, up to the set maximum. The total number of samples of the final
+  render is still equal to the number of samples configured in the blend file.
+  Requires Flamenco Server 2.2 or newer.
+- Flamenco: Added a hidden "Submit & Quit" button. This button can be enabled in the add-on
+  preferences and and then be available on the Flamenco Render panel. Pressing the button will
+  silently close Blender after the job has been submitted to Flamenco (for example to click,
+  walk away, and free up memory for when the same machine is part of the render farm).
+- Flamenco: Name render jobs just 'thefile' instead of 'Render thefile.flamenco.blend'.
+  This makes the job overview on Flamenco Server cleaner.
+- Flamenco: support Shaman servers. See https://www.flamenco.io/docs/user_manual/shaman/
+  for more info.
+- Flamenco: The 'blender-video-chunks' job type now also allows MP4 and MOV video containers.
+
+
+## Version 1.11.1 (2019-01-04)
+
+- Bundled missing Texture Browser icons.
+
+
+## Version 1.11.0 (2019-01-04)
+
+- Texture Browser now works on Blender 2.8.
+- Blender Sync: Fixed compatibility issue with Blender 2.8.
+
+
+## Version 1.10.0 (2019-01-02)
+
+- Bundles Blender-Asset-Tracer 0.8.
+- Fix crashing Blender when running in background mode (e.g. without GUI).
+- Flamenco: Include extra job parameters to allow for encoding a video at the end of a render
+  job that produced an image sequence.
+- Flamenco: Compress all blend files, and not just the one we save from Blender.
+- Flamenco: Store more info in the `jobinfo.json` file. This is mostly useful for debugging issues
+  on the render farm, as now things like the exclusion filter and Manager settings are logged too.
+- Flamenco: Allow BAT-packing of only those assets that are referred to by relative path (e.g.
+  a path starting with `//`). Assets with an absolute path are ignored, and assumed to be reachable
+  at the same path by the Workers.
+- Flamenco: Added 'blender-video-chunks' job type, meant for rendering the edit of a film from the
+  VSE. This job type requires that the file is configured for rendering to Matroska video
+  files.
+
+  Audio is only extracted when there is an audio codec configured. This is a bit arbitrary, but it's
+  at least a way to tell whether the artist is considering that there is audio of any relevance in
+  the current blend file.
+
+
+## Version 1.9.4 (2018-11-01)
+
+- Fixed Python 3.6 and Blender 2.79b incompatibilities accidentally introduced in 1.9.3.
+
+
+## Version 1.9.3 (2018-10-30)
+
+- Fix drawing of Attract strips in the VSE on Blender 2.8.
+
+
+## Version 1.9.2 (2018-09-17)
+
+- No changes, just a different filename to force a refresh on our
+  hosting platform.
+
+
+## Version 1.9.1 (2018-09-17)
+
+- Fix issue with Python 3.7, which is used by current daily builds of Blender.
+
+
+## Version 1.9 (2018-09-05)
+
+- Last version to support Blender versions before 2.80!
+- Replace BAM with BAT🦇.
+- Don't crash the texture browser when an invalid texture is seen.
+- Support colour strips as Attract shots.
+- Flamenco: allow jobs to be created in 'paused' state.
+- Flamenco: only show Flamenco Managers that are linked to the currently selected project.
+
+
+## Version 1.8 (2018-01-03)
+
+- Distinguish between 'please subscribe' (to get a new subscription) and 'please renew' (to renew an
+  existing subscription).
+- When re-opening the Texture Browser it now opens in the same folder as where it was when closed.
+- In the texture browser, draw the components of the texture (i.e. which map types are available),
+  such as 'bump, normal, specular'.
+- Use Interface Scale setting from user preferences to draw the Texture Browser text.
+- Store project-specific settings in the preferences, such as filesystem paths, for each project,
+  and restore those settings when the project is selected again. Does not touch settings that
+  haven't been set for the newly selected project. These settings are only saved when a setting
+  is updated, so to save your current settings need to update a single setting; this saves all
+  settings for the project.
+- Added button in the User Preferences to open a Cloud project in your webbrowser.
+
+
+## Version 1.7.5 (2017-10-06)
+
+- Sorting the project list alphabetically.
+- Renamed 'Job File Path' to 'Job Storage Path' so it's more explicit.
+- Allow overriding the render output path on a per-scene basis.
+
+
+## Version 1.7.4 (2017-09-05)
+
+- Fix [T52621](https://developer.blender.org/T52621): Fixed class name collision upon add-on
+  registration. This is checked since Blender 2.79.
+- Fix [T48852](https://developer.blender.org/T48852): Screenshot no longer shows "Communicating with
+  Blender Cloud".
+
+
+## Version 1.7.3 (2017-08-08)
+
+- Default to scene frame range when no frame range is given.
+- Refuse to render on Flamenco before blend file is saved at least once.
+- Fixed some Windows-specific issues.
+
+
+## Version 1.7.2 (2017-06-22)
+
+- Fixed compatibility with Blender 2.78c.
+
+
+## Version 1.7.1 (2017-06-13)
+
+- Fixed asyncio issues on Windows
+
+
+## Version 1.7.0 (2017-06-09)
+
+- Fixed reloading after upgrading from 1.4.4 (our last public release).
+- Fixed bug handling a symlinked project path.
+- Added support for Manager-defined path replacement variables.
+
+
+## Version 1.6.4 (2017-04-21)
+
+- Added file exclusion filter for Flamenco. A filter like `*.abc;*.mkv;*.mov` can be
+  used to prevent certain files from being copied to the job storage directory.
+  Requires a Blender that is bundled with BAM 1.1.7 or newer.
+
+
+## Version 1.6.3 (2017-03-21)
+
+- Fixed bug where local project path wasn't shown for projects only set up for Flamenco
+  (and not Attract).
+- Added this CHANGELOG.md file, which will contain user-relevant changes.
+
+
+## Version 1.6.2 (2017-03-17)
+
+- Flamenco: when opening non-existing file path, open parent instead
+- Fix T50954: Improve Blender Cloud add-on project selector
+
+
+## Version 1.6.1 (2017-03-07)
+
+- Show error in GUI when Blender Cloud is unreachable
+- Fixed sample count when using branched path tracing
+
+
+## Version 1.6.0 (2017-02-14)
+
+- Default to frame chunk size of 1 (instead of 10).
+- Turn off "use overwrite" and "use placeholder" for Flamenco blend files.
+- Fixed bugs when blendfile is outside the project directory
+
+
+## Older versions
+
+For the history of older versions, please refer to the
+[Git history](https://developer.blender.org/diffusion/BCA/)

README-flamenco.md

@@ -0,0 +1,57 @@
+# Flamenco
+
+The Blender Cloud add-on has preliminary support for [Flamenco](https://flamenco.io/).
+It requires a project on the [Blender Cloud](https://cloud.blender.org/) that is set up for
+Flamenco, and it requires you to be logged in as a user with rights to use Flamenco.
+
+
+## Quirks
+
+Flamenco support is unpolished, so it has some quirks.
+
+- Project selection happens through the Attract project selector. As a result, you can only
+  select Attract-enabled projects (even when they are not set up for Flamenco). Be careful
+  which project you select.
+- The top level directory of the project is also set through the Attract properties.
+- Defaults are heavily biased for our use in the Blender Institute.
+- Settings that should be project-specific are not, i.e. are regular add-on preferences.
+- Sending a project to Flamenco will check the "File Extensions" setting in the Output panel,
+  and save the blend file to the current filename.
+
+## Render job file locations
+
+Rendering via Flamenco roughly comprises of two steps:
+
+1. Packing the file to render with its dependencies, and placing them in the "job file path".
+2. Rendering, and placing the output files in the "job output path".
+
+### Job file path
+
+The "job file path" consists of the following path components:
+
+1. The add-on preference "job file path", e.g. `/render/_flamenco/storage`
+2. The current date and time, your Blender Cloud username, and the name of the current blend file.
+3. The name of the current blend file.
+
+For example:
+
+`/render/_flamenco/storage/2017-01-18-104841.931387-sybren-03_02_A.layout/03_02_A.layout.blend`
+
+### Job output path
+
+The file path of output files consists of the following path components:
+
+1. The add-on preference "job file path", e.g. `/render/agent327/frames`
+2. The path of the current blend file, relative to the project directory. The first N components
+   of this path can be stripped; when N=1 it turns `scenes/03-searching/03_02_A-snooping/` into
+   `03-searching/03_02_A-snooping/`.
+3. The name of the current blend file, without `.blend`.
+4. The file name depends on the type of output:
+   - When rendering to image files: A 5-digit frame number with the required file extension.
+   - When rendering to a video file: The frame range with the required file extension.
+
+For example:
+
+`/render/agent327/frames/03-searching/03_02_A-snooping/03_02_A.layout/00441.exr`
+
+`/render/agent327/frames/03-searching/03_02_A-snooping/03_02_A.layout/14-51,60-133.mkv`

blender_cloud/__init__.py

@@ -20,13 +20,13 @@
 
 bl_info = {
     'name': 'Blender Cloud',
-    'author': 'Sybren A. Stüvel and Francesco Siddi',
-    'version': (1, 4, 3),
-    'blender': (2, 77, 0),
+    "author": "Sybren A. Stüvel, Francesco Siddi, Inês Almeida, Antony Riakiotakis",
+    'version': (1, 15),
+    'blender': (2, 80, 0),
     'location': 'Addon Preferences panel, and Ctrl+Shift+Alt+A anywhere for texture browser',
     'description': 'Texture library browser and Blender Sync. Requires the Blender ID addon '
                    'and Blender 2.77a or newer.',
-    'wiki_url': 'http://wiki.blender.org/index.php/Extensions:2.6/Py/'
+    'wiki_url': 'https://wiki.blender.org/index.php/Extensions:2.6/Py/'
                 'Scripts/System/BlenderCloud',
     'category': 'System',
 }
@@ -65,30 +65,45 @@ def register():
 
         def reload_mod(name):
             modname = '%s.%s' % (__name__, name)
-            module = importlib.reload(sys.modules[modname])
-            sys.modules[modname] = module
-            return module
+            try:
+                old_module = sys.modules[modname]
+            except KeyError:
+                # Wasn't loaded before -- can happen after an upgrade.
+                new_module = importlib.import_module(modname)
+            else:
+                new_module = importlib.reload(old_module)
+
+            sys.modules[modname] = new_module
+            return new_module
 
         reload_mod('blendfile')
         reload_mod('home_project')
         reload_mod('utils')
+        reload_mod('pillar')
 
-        blender = reload_mod('blender')
         async_loop = reload_mod('async_loop')
+        flamenco = reload_mod('flamenco')
+        attract = reload_mod('attract')
         texture_browser = reload_mod('texture_browser')
         settings_sync = reload_mod('settings_sync')
         image_sharing = reload_mod('image_sharing')
+        blender = reload_mod('blender')
+        project_specific = reload_mod('project_specific')
     else:
         from . import (blender, texture_browser, async_loop, settings_sync, blendfile, home_project,
-                       image_sharing)
+                       image_sharing, attract, flamenco, project_specific)
 
     async_loop.setup_asyncio_executor()
     async_loop.register()
 
+    flamenco.register()
+    attract.register()
     texture_browser.register()
-    blender.register()
     settings_sync.register()
     image_sharing.register()
+    blender.register()
+
+    project_specific.handle_project_update()
 
 
 def _monkey_patch_requests():
@@ -109,10 +124,13 @@ def _monkey_patch_requests():
 
 
 def unregister():
-    from . import blender, texture_browser, async_loop, settings_sync, image_sharing
+    from . import (blender, texture_browser, async_loop, settings_sync, image_sharing, attract,
+                   flamenco)
 
     image_sharing.unregister()
+    attract.unregister()
     settings_sync.unregister()
     blender.unregister()
     texture_browser.unregister()
     async_loop.unregister()
+    flamenco.unregister()

blender_cloud/appdirs.py

@@ -511,7 +511,7 @@ if system == "win32":
         _get_win_folder = _get_win_folder_with_pywin32
     except ImportError:
         try:
-            from ctypes import windll
+            from ctypes import windll  # type: ignore
             _get_win_folder = _get_win_folder_with_ctypes
         except ImportError:
             try:

blender_cloud/async_loop.py

@@ -23,6 +23,7 @@ import traceback
 import concurrent.futures
 import logging
 import gc
+import typing
 
 import bpy
 
@@ -33,18 +34,28 @@ _loop_kicking_operator_running = False
 
 
 def setup_asyncio_executor():
-    """Sets up AsyncIO to run on a single thread.
+    """Sets up AsyncIO to run properly on each platform."""
 
-    This ensures that only one Pillar HTTP call is performed at the same time. Other
-    calls that could be performed in parallel are queued, and thus we can
-    reliably cancel them.
-    """
+    import sys
 
-    executor = concurrent.futures.ThreadPoolExecutor()
-    loop = asyncio.get_event_loop()
+    if sys.platform == 'win32':
+        asyncio.get_event_loop().close()
+        # On Windows, the default event loop is SelectorEventLoop, which does
+        # not support subprocesses. ProactorEventLoop should be used instead.
+        # Source: https://docs.python.org/3/library/asyncio-subprocess.html
+        loop = asyncio.ProactorEventLoop()
+        asyncio.set_event_loop(loop)
+    else:
+        loop = asyncio.get_event_loop()
+
+    executor = concurrent.futures.ThreadPoolExecutor(max_workers=10)
     loop.set_default_executor(executor)
     # loop.set_debug(True)
 
+    from . import pillar
+    # No more than this many Pillar calls should be made simultaneously
+    pillar.pillar_semaphore = asyncio.Semaphore(3, loop=loop)
+
 
 def kick_async_loop(*args) -> bool:
     """Performs a single iteration of the asyncio event loop.
@@ -143,7 +154,7 @@ class AsyncLoopModalOperator(bpy.types.Operator):
         _loop_kicking_operator_running = True
 
         wm = context.window_manager
-        self.timer = wm.event_timer_add(0.00001, context.window)
+        self.timer = wm.event_timer_add(0.00001, window=context.window)
 
         return {'RUNNING_MODAL'}
 
@@ -178,12 +189,28 @@ class AsyncModalOperatorMixin:
     log = logging.getLogger('%s.AsyncModalOperatorMixin' % __name__)
 
     _state = 'INITIALIZING'
+    stop_upon_exception = False
 
     def invoke(self, context, event):
         context.window_manager.modal_handler_add(self)
-        self.timer = context.window_manager.event_timer_add(1 / 15, context.window)
+        self.timer = context.window_manager.event_timer_add(1 / 15, window=context.window)
+
+        self.log.info('Starting')
+        self._new_async_task(self.async_execute(context))
+
         return {'RUNNING_MODAL'}
 
+    async def async_execute(self, context):
+        """Entry point of the asynchronous operator.
+
+        Implement in a subclass.
+        """
+        return
+
+    def quit(self):
+        """Signals the state machine to stop this operator from running."""
+        self._state = 'QUIT'
+
     def execute(self, context):
         return self.invoke(context, None)
 
@@ -195,6 +222,11 @@ class AsyncModalOperatorMixin:
             if ex is not None:
                 self._state = 'EXCEPTION'
                 self.log.error('Exception while running task: %s', ex)
+                if self.stop_upon_exception:
+                    self.quit()
+                    self._finish(context)
+                    return {'FINISHED'}
+
                 return {'RUNNING_MODAL'}
 
         if self._state == 'QUIT':
@@ -207,7 +239,7 @@ class AsyncModalOperatorMixin:
         self._stop_async_task()
         context.window_manager.event_timer_remove(self.timer)
 
-    def _new_async_task(self, async_task: asyncio.coroutine, future: asyncio.Future = None):
+    def _new_async_task(self, async_task: typing.Coroutine, future: asyncio.Future = None):
         """Stops the currently running async task, and starts another one."""
 
         self.log.debug('Setting up a new task %r, so any existing task must be stopped', async_task)

blender_cloud/attract/draw.py

@@ -0,0 +1,257 @@
+# ##### 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 2
+#  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, write to the Free Software Foundation,
+#  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# ##### END GPL LICENSE BLOCK #####
+
+# <pep8 compliant>
+
+import logging
+import typing
+
+import bpy
+import bgl
+import gpu
+
+log = logging.getLogger(__name__)
+
+strip_status_colour = {
+    None: (0.7, 0.7, 0.7),
+    'approved': (0.6392156862745098, 0.8784313725490196, 0.30196078431372547),
+    'final': (0.9058823529411765, 0.9607843137254902, 0.8274509803921568),
+    'in_progress': (1.0, 0.7450980392156863, 0.0),
+    'on_hold': (0.796078431372549, 0.6196078431372549, 0.08235294117647059),
+    'review': (0.8941176470588236, 0.9607843137254902, 0.9764705882352941),
+    'todo': (1.0, 0.5019607843137255, 0.5019607843137255)
+}
+
+CONFLICT_COLOUR = (0.576, 0.118, 0.035, 1.0)  # RGBA tuple
+
+gpu_vertex_shader = '''
+uniform mat4 ModelViewProjectionMatrix;
+
+layout (location = 0) in vec2 pos;
+layout (location = 1) in vec4 color;
+
+out vec4 lineColor; // output to the fragment shader
+
+void main()
+{
+    gl_Position = ModelViewProjectionMatrix * vec4(pos.x, pos.y, 0.0, 1.0);
+    lineColor = color;
+}
+'''
+
+gpu_fragment_shader = '''
+out vec4 fragColor;
+in vec4 lineColor;
+
+void main()
+{
+    fragColor = lineColor;
+}
+'''
+
+Float2 = typing.Tuple[float, float]
+Float3 = typing.Tuple[float, float, float]
+Float4 = typing.Tuple[float, float, float, float]
+
+
+class AttractLineDrawer:
+
+    def __init__(self):
+        self._format = gpu.types.GPUVertFormat()
+        self._pos_id = self._format.attr_add(
+            id="pos",
+            comp_type="F32",
+            len=2,
+            fetch_mode="FLOAT")
+        self._color_id = self._format.attr_add(
+            id="color",
+            comp_type="F32",
+            len=4,
+            fetch_mode="FLOAT")
+
+        self.shader = gpu.types.GPUShader(gpu_vertex_shader, gpu_fragment_shader)
+
+    def draw(self,
+             coords: typing.List[Float2],
+             colors: typing.List[Float4]):
+        if not coords:
+            return
+
+        bgl.glEnable(bgl.GL_BLEND)
+        bgl.glLineWidth(2.0)
+
+        vbo = gpu.types.GPUVertBuf(len=len(coords), format=self._format)
+        vbo.attr_fill(id=self._pos_id, data=coords)
+        vbo.attr_fill(id=self._color_id, data=colors)
+
+        batch = gpu.types.GPUBatch(type="LINES", buf=vbo)
+        batch.program_set(self.shader)
+        batch.draw()
+
+
+def get_strip_rectf(strip) -> Float4:
+    # Get x and y in terms of the grid's frames and channels
+    x1 = strip.frame_final_start
+    x2 = strip.frame_final_end
+    y1 = strip.channel + 0.2
+    y2 = strip.channel - 0.2 + 1
+
+    return x1, y1, x2, y2
+
+
+def underline_in_strip(strip_coords: Float4,
+                       pixel_size_x: float,
+                       color: Float4,
+                       out_coords: typing.List[Float2],
+                       out_colors: typing.List[Float4]):
+    # Strip coords
+    s_x1, s_y1, s_x2, s_y2 = strip_coords
+
+    # be careful not to draw over the current frame line
+    cf_x = bpy.context.scene.frame_current_final
+
+    # TODO(Sybren): figure out how to pass one colour per line,
+    # instead of one colour per vertex.
+    out_coords.append((s_x1, s_y1))
+    out_colors.append(color)
+
+    if s_x1 < cf_x < s_x2:
+        # Bad luck, the line passes our strip, so draw two lines.
+        out_coords.append((cf_x - pixel_size_x, s_y1))
+        out_colors.append(color)
+
+        out_coords.append((cf_x + pixel_size_x, s_y1))
+        out_colors.append(color)
+
+    out_coords.append((s_x2, s_y1))
+    out_colors.append(color)
+
+
+def strip_conflict(strip_coords: Float4,
+                   out_coords: typing.List[Float2],
+                   out_colors: typing.List[Float4]):
+    """Draws conflicting states between strips."""
+
+    s_x1, s_y1, s_x2, s_y2 = strip_coords
+
+    # TODO(Sybren): draw a rectangle instead of a line.
+    out_coords.append((s_x1, s_y2))
+    out_colors.append(CONFLICT_COLOUR)
+
+    out_coords.append((s_x2, s_y1))
+    out_colors.append(CONFLICT_COLOUR)
+
+    out_coords.append((s_x2, s_y2))
+    out_colors.append(CONFLICT_COLOUR)
+
+    out_coords.append((s_x1, s_y1))
+    out_colors.append(CONFLICT_COLOUR)
+
+
+def draw_callback_px(line_drawer: AttractLineDrawer):
+    context = bpy.context
+
+    if not context.scene.sequence_editor:
+        return
+
+    from . import shown_strips
+
+    region = context.region
+    xwin1, ywin1 = region.view2d.region_to_view(0, 0)
+    xwin2, ywin2 = region.view2d.region_to_view(region.width, region.height)
+    one_pixel_further_x, one_pixel_further_y = region.view2d.region_to_view(1, 1)
+    pixel_size_x = one_pixel_further_x - xwin1
+
+    strips = shown_strips(context)
+
+    coords = []  # type: typing.List[Float2]
+    colors = []  # type: typing.List[Float4]
+
+    # Collect all the lines (vertex coords + vertex colours) to draw.
+    for strip in strips:
+        if not strip.atc_object_id:
+            continue
+
+        # Get corners (x1, y1), (x2, y2) of the strip rectangle in px region coords
+        strip_coords = get_strip_rectf(strip)
+
+        # check if any of the coordinates are out of bounds
+        if strip_coords[0] > xwin2 or strip_coords[2] < xwin1 or strip_coords[1] > ywin2 or \
+                strip_coords[3] < ywin1:
+            continue
+
+        # Draw
+        status = strip.atc_status
+        if status in strip_status_colour:
+            color = strip_status_colour[status]
+        else:
+            color = strip_status_colour[None]
+
+        alpha = 1.0 if strip.atc_is_synced else 0.5
+
+        underline_in_strip(strip_coords, pixel_size_x, color + (alpha,), coords, colors)
+        if strip.atc_is_synced and strip.atc_object_id_conflict:
+            strip_conflict(strip_coords, coords, colors)
+
+    line_drawer.draw(coords, colors)
+
+
+def tag_redraw_all_sequencer_editors():
+    context = bpy.context
+
+    # Py cant access notifiers
+    for window in context.window_manager.windows:
+        for area in window.screen.areas:
+            if area.type == 'SEQUENCE_EDITOR':
+                for region in area.regions:
+                    if region.type == 'WINDOW':
+                        region.tag_redraw()
+
+
+# This is a list so it can be changed instead of set
+# if it is only changed, it does not have to be declared as a global everywhere
+cb_handle = []
+
+
+def callback_enable():
+    if cb_handle:
+        return
+
+    # Doing GPU stuff in the background crashes Blender, so let's not.
+    if bpy.app.background:
+        return
+
+    line_drawer = AttractLineDrawer()
+    cb_handle[:] = bpy.types.SpaceSequenceEditor.draw_handler_add(
+        draw_callback_px, (line_drawer,), 'WINDOW', 'POST_VIEW'),
+
+    tag_redraw_all_sequencer_editors()
+
+
+def callback_disable():
+    if not cb_handle:
+        return
+
+    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()

blender_cloud/attract/draw_27.py

@@ -0,0 +1,182 @@
+# ##### 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 2
+#  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, write to the Free Software Foundation,
+#  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# ##### END GPL LICENSE BLOCK #####
+
+# <pep8 compliant>
+
+import bpy
+import logging
+import collections
+
+log = logging.getLogger(__name__)
+
+strip_status_colour = {
+    None: (0.7, 0.7, 0.7),
+    'approved': (0.6392156862745098, 0.8784313725490196, 0.30196078431372547),
+    'final': (0.9058823529411765, 0.9607843137254902, 0.8274509803921568),
+    'in_progress': (1.0, 0.7450980392156863, 0.0),
+    'on_hold': (0.796078431372549, 0.6196078431372549, 0.08235294117647059),
+    'review': (0.8941176470588236, 0.9607843137254902, 0.9764705882352941),
+    'todo': (1.0, 0.5019607843137255, 0.5019607843137255)
+}
+
+CONFLICT_COLOUR = (0.576, 0.118, 0.035)  # RGB tuple
+
+
+def get_strip_rectf(strip):
+    # Get x and y in terms of the grid's frames and channels
+    x1 = strip.frame_final_start
+    x2 = strip.frame_final_end
+    y1 = strip.channel + 0.2
+    y2 = strip.channel - 0.2 + 1
+
+    return x1, y1, x2, y2
+
+
+def draw_underline_in_strip(strip_coords, pixel_size_x, color):
+    from bgl import glColor4f, glRectf, glEnable, glDisable, GL_BLEND
+    import bgl
+
+    context = bpy.context
+
+    # Strip coords
+    s_x1, s_y1, s_x2, s_y2 = strip_coords
+
+    # be careful not to draw over the current frame line
+    cf_x = context.scene.frame_current_final
+
+    bgl.glPushAttrib(bgl.GL_COLOR_BUFFER_BIT | bgl.GL_LINE_BIT)
+
+    glColor4f(*color)
+    glEnable(GL_BLEND)
+    bgl.glLineWidth(2)
+    bgl.glBegin(bgl.GL_LINES)
+
+    bgl.glVertex2f(s_x1, s_y1)
+    if s_x1 < cf_x < s_x2:
+        # Bad luck, the line passes our strip
+        bgl.glVertex2f(cf_x - pixel_size_x, s_y1)
+        bgl.glVertex2f(cf_x + pixel_size_x, s_y1)
+    bgl.glVertex2f(s_x2, s_y1)
+
+    bgl.glEnd()
+    bgl.glPopAttrib()
+
+
+def draw_strip_conflict(strip_coords, pixel_size_x):
+    """Draws conflicting states between strips."""
+
+    import bgl
+
+    s_x1, s_y1, s_x2, s_y2 = strip_coords
+    bgl.glPushAttrib(bgl.GL_COLOR_BUFFER_BIT | bgl.GL_LINE_BIT)
+
+    # Always draw the full rectangle, the conflict should be resolved and thus stand out.
+    bgl.glColor3f(*CONFLICT_COLOUR)
+    bgl.glLineWidth(2)
+
+    bgl.glBegin(bgl.GL_LINE_LOOP)
+    bgl.glVertex2f(s_x1, s_y1)
+    bgl.glVertex2f(s_x2, s_y1)
+    bgl.glVertex2f(s_x2, s_y2)
+    bgl.glVertex2f(s_x1, s_y2)
+    bgl.glEnd()
+
+    bgl.glPopAttrib()
+
+
+def draw_callback_px():
+    context = bpy.context
+
+    if not context.scene.sequence_editor:
+        return
+
+    from . import shown_strips
+
+    region = context.region
+    xwin1, ywin1 = region.view2d.region_to_view(0, 0)
+    xwin2, ywin2 = region.view2d.region_to_view(region.width, region.height)
+    one_pixel_further_x, one_pixel_further_y = region.view2d.region_to_view(1, 1)
+    pixel_size_x = one_pixel_further_x - xwin1
+
+    strips = shown_strips(context)
+
+    for strip in strips:
+        if not strip.atc_object_id:
+            continue
+
+        # Get corners (x1, y1), (x2, y2) of the strip rectangle in px region coords
+        strip_coords = get_strip_rectf(strip)
+
+        # check if any of the coordinates are out of bounds
+        if strip_coords[0] > xwin2 or strip_coords[2] < xwin1 or strip_coords[1] > ywin2 or \
+                        strip_coords[3] < ywin1:
+            continue
+
+        # Draw
+        status = strip.atc_status
+        if status in strip_status_colour:
+            color = strip_status_colour[status]
+        else:
+            color = strip_status_colour[None]
+
+        alpha = 1.0 if strip.atc_is_synced else 0.5
+
+        draw_underline_in_strip(strip_coords, pixel_size_x, color + (alpha,))
+        if strip.atc_is_synced and strip.atc_object_id_conflict:
+            draw_strip_conflict(strip_coords, pixel_size_x)
+
+
+def tag_redraw_all_sequencer_editors():
+    context = bpy.context
+
+    # Py cant access notifiers
+    for window in context.window_manager.windows:
+        for area in window.screen.areas:
+            if area.type == 'SEQUENCE_EDITOR':
+                for region in area.regions:
+                    if region.type == 'WINDOW':
+                        region.tag_redraw()
+
+
+# This is a list so it can be changed instead of set
+# if it is only changed, it does not have to be declared as a global everywhere
+cb_handle = []
+
+
+def callback_enable():
+    if cb_handle:
+        return
+
+    cb_handle[:] = bpy.types.SpaceSequenceEditor.draw_handler_add(
+        draw_callback_px, (), 'WINDOW', 'POST_VIEW'),
+
+    tag_redraw_all_sequencer_editors()
+
+
+def callback_disable():
+    if not cb_handle:
+        return
+
+    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()

blender_cloud/blender.py

@@ -20,31 +20,31 @@
 
 Separated from __init__.py so that we can import & run from non-Blender environments.
 """
-
+import functools
 import logging
 import os.path
+import tempfile
 
 import bpy
 from bpy.types import AddonPreferences, Operator, WindowManager, Scene, PropertyGroup
-from bpy.props import StringProperty, EnumProperty, PointerProperty, BoolProperty
+from bpy.props import StringProperty, EnumProperty, PointerProperty, BoolProperty, IntProperty
 import rna_prop_ui
 
-from . import pillar
+from . import compatibility, pillar, async_loop, flamenco, project_specific
+from .utils import pyside_cache, redraw
 
-PILLAR_SERVER_URL = 'https://cloudapi.blender.org/'
-# PILLAR_SERVER_URL = 'http://localhost:5000/'
+PILLAR_WEB_SERVER_URL = os.environ.get('BCLOUD_SERVER', 'https://cloud.blender.org/')
+PILLAR_SERVER_URL = '%sapi/' % PILLAR_WEB_SERVER_URL
 
 ADDON_NAME = 'blender_cloud'
 log = logging.getLogger(__name__)
-
 icons = None
 
 
-def redraw(self, context):
-    context.area.tag_redraw()
-
-
+@pyside_cache('version')
 def blender_syncable_versions(self, context):
+    """Returns the list of items used by SyncStatusProperties.version EnumProperty."""
+
     bss = context.window_manager.blender_sync_status
     versions = bss.available_blender_versions
     if not versions:
@@ -52,6 +52,7 @@ def blender_syncable_versions(self, context):
     return [(v, v, '') for v in versions]
 
 
+@compatibility.convert_properties
 class SyncStatusProperties(PropertyGroup):
     status = EnumProperty(
         items=[
@@ -104,10 +105,76 @@ class SyncStatusProperties(PropertyGroup):
         self['available_blender_versions'] = new_versions
 
 
+@pyside_cache('project')
+def bcloud_available_projects(self, context):
+    """Returns the list of items used by BlenderCloudProjectGroup.project EnumProperty."""
+
+    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', ()))
+
+
+@compatibility.convert_properties
+class BlenderCloudProjectGroup(PropertyGroup):
+    status = EnumProperty(
+        items=[
+            ('NONE', 'NONE', 'We have done nothing at all yet'),
+            ('IDLE', 'IDLE', 'User requested something, which is done, and we are now idle'),
+            ('FETCHING', 'FETCHING', 'Fetching available projects from Blender Cloud'),
+        ],
+        name='status',
+        update=redraw)
+
+    project = EnumProperty(
+        items=bcloud_available_projects,
+        name='Cloud project',
+        description='Which Blender Cloud project to work with',
+        update=project_specific.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.
+    @property
+    def available_projects(self) -> list:
+        return self.get('available_projects', [])
+
+    @available_projects.setter
+    def available_projects(self, new_projects):
+        self['available_projects'] = new_projects
+        project_specific.handle_project_update()
+
+
+@compatibility.convert_properties
 class BlenderCloudPreferences(AddonPreferences):
     bl_idname = ADDON_NAME
 
-    # The following two properties are read-only to limit the scope of the
+    # The following property is read-only to limit the scope of the
     # addon and allow for proper testing within this scope.
     pillar_server = StringProperty(
         name='Blender Cloud Server',
@@ -117,16 +184,83 @@ class BlenderCloudPreferences(AddonPreferences):
     )
 
     local_texture_dir = StringProperty(
-        name='Default Blender Cloud texture storage directory',
+        name='Default Blender Cloud Texture Storage Directory',
         subtype='DIR_PATH',
         default='//textures')
 
     open_browser_after_share = BoolProperty(
-        name='Open browser after sharing file',
+        name='Open Browser after Sharing File',
         description='When enabled, Blender will open a webbrowser',
         default=True
     )
 
+    # 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)
+
+    cloud_project_local_path = StringProperty(
+        name='Local Project Path',
+        description='Local path of your Attract project, used to search for blend files; '
+                    'usually best to set to an absolute path',
+        subtype='DIR_PATH',
+        default='//../',
+        update=project_specific.store,
+    )
+
+    flamenco_manager = PointerProperty(type=flamenco.FlamencoManagerGroup)
+    flamenco_exclude_filter = StringProperty(
+        name='File Exclude Filter',
+        description='Space-separated list of filename filters, like "*.abc *.mkv", to prevent '
+                    'matching files from being packed into the output directory',
+        default='',
+        update=project_specific.store,
+    )
+    flamenco_job_file_path = StringProperty(
+        name='Job Storage Path',
+        description='Path where to store job files, should be accesible for Workers too',
+        subtype='DIR_PATH',
+        default=tempfile.gettempdir(),
+        update=project_specific.store,
+    )
+    flamenco_job_output_path = StringProperty(
+        name='Job Output Path',
+        description='Path where to store output files, should be accessible for Workers',
+        subtype='DIR_PATH',
+        default=tempfile.gettempdir(),
+        update=project_specific.store,
+    )
+    flamenco_job_output_strip_components = IntProperty(
+        name='Job Output Path Strip Components',
+        description='The final output path comprises of the job output path, and the blend file '
+                    'path relative to the project with this many path components stripped off '
+                    'the front',
+        min=0,
+        default=0,
+        soft_max=4,
+        update=project_specific.store,
+    )
+    flamenco_relative_only = BoolProperty(
+        name='Relative Paths Only',
+        description='When enabled, only assets that are referred to with a relative path are '
+                    'packed, and assets referred to by an absolute path are excluded from the '
+                    'BAT pack. When disabled, all assets are packed',
+        default=False,
+        update=project_specific.store,
+    )
+
+    flamenco_open_browser_after_submit = BoolProperty(
+        name='Open Browser after Submitting Job',
+        description='When enabled, Blender will open a webbrowser',
+        default=True,
+    )
+    flamenco_show_quit_after_submit_button = BoolProperty(
+        name='Show "Submit & Quit" button',
+        description='When enabled, next to the "Render on Flamenco" button there will be a button '
+                    '"Submit & Quit" that silently quits Blender after submitting the render job '
+                    'to Flamenco',
+        default=False,
+    )
+
     def draw(self, context):
         import textwrap
 
@@ -140,8 +274,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'
@@ -183,8 +317,8 @@ class BlenderCloudPreferences(AddonPreferences):
         bss = context.window_manager.blender_sync_status
         bsync_box = layout.box()
         bsync_box.enabled = msg_icon != 'ERROR'
-        row = bsync_box.row().split(percentage=0.33)
-        row.label('Blender Sync with Blender Cloud', icon_value=icon('CLOUD'))
+        row = bsync_box.row().split(**compatibility.factor(0.33))
+        row.label(text='Blender Sync with Blender Cloud', icon_value=icon('CLOUD'))
 
         icon_for_level = {
             'INFO': 'NONE',
@@ -194,7 +328,7 @@ class BlenderCloudPreferences(AddonPreferences):
         }
         msg_icon = icon_for_level[bss.level] if bss.message else 'NONE'
         message_container = row.row()
-        message_container.label(bss.message, icon=msg_icon)
+        message_container.label(text=bss.message, icon=msg_icon)
 
         sub = bsync_box.column()
 
@@ -204,10 +338,21 @@ class BlenderCloudPreferences(AddonPreferences):
 
         # Image Share stuff
         share_box = layout.box()
-        share_box.label('Image Sharing on Blender Cloud', icon_value=icon('CLOUD'))
-        texture_box.enabled = msg_icon != 'ERROR'
+        share_box.label(text='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)
+
+        # Flamenco stuff
+        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')
 
@@ -215,7 +360,7 @@ class BlenderCloudPreferences(AddonPreferences):
         layout.enabled = bss.status in {'NONE', 'IDLE'}
 
         buttons = layout.column()
-        row_buttons = buttons.row().split(percentage=0.5)
+        row_buttons = buttons.row().split(**compatibility.factor(0.5))
         row_push = row_buttons.row()
         row_pull = row_buttons.row(align=True)
 
@@ -224,23 +369,119 @@ class BlenderCloudPreferences(AddonPreferences):
                           icon='TRIA_UP').action = 'PUSH'
 
         versions = bss.available_blender_versions
-        version = bss.version
         if bss.status in {'NONE', 'IDLE'}:
-            if not versions or not version:
+            if not versions:
                 row_pull.operator('pillar.sync',
                                   text='Find version to load',
                                   icon='TRIA_DOWN').action = 'REFRESH'
             else:
                 props = row_pull.operator('pillar.sync',
-                                          text='Load %s settings' % version,
+                                          text='Load %s settings' % bss.version,
                                           icon='TRIA_DOWN')
                 props.action = 'PULL'
-                props.blender_version = version
+                props.blender_version = bss.version
                 row_pull.operator('pillar.sync',
                                   text='',
-                                  icon='DOTSDOWN').action = 'SELECT'
+                                  icon=compatibility.SYNC_SELECT_VERSION_ICON).action = 'SELECT'
         else:
-            row_pull.label('Cloud Sync is running.')
+            row_pull.label(text='Cloud Sync is running.')
+
+    def draw_project_selector(self, project_box, bcp: BlenderCloudProjectGroup):
+        project_row = project_box.row(align=True)
+        project_row.label(text='Project settings', icon_value=icon('CLOUD'))
+
+        row_buttons = project_row.row(align=True)
+
+        projects = bcp.available_projects
+        project = bcp.project
+        if bcp.status in {'NONE', 'IDLE'}:
+            if not projects:
+                row_buttons.operator('pillar.projects',
+                                     text='Find project to load',
+                                     icon='FILE_REFRESH')
+            else:
+                row_buttons.prop(bcp, 'project')
+                row_buttons.operator('pillar.projects',
+                                     text='',
+                                     icon='FILE_REFRESH')
+                props = row_buttons.operator('pillar.project_open_in_browser',
+                                             text='',
+                                             icon='WORLD')
+                props.project_id = project
+        else:
+            row_buttons.label(text='Fetching available projects.')
+
+        enabled_for = project_extensions(project)
+        if not project:
+            return
+
+        if not enabled_for:
+            project_box.label(text='This project is not set up for Attract or Flamenco')
+            return
+
+        project_box.label(text='This project is set up for: %s' %
+                               ', '.join(sorted(enabled_for)))
+
+        # This is only needed when the project is set up for either Attract or Flamenco.
+        project_box.prop(self, 'cloud_project_local_path',
+                         text='Local Project Path')
+
+    def draw_flamenco_buttons(self, flamenco_box, bcp: flamenco.FlamencoManagerGroup, context):
+        header_row = flamenco_box.row(align=True)
+        header_row.label(text='Flamenco:', icon_value=icon('CLOUD'))
+
+        manager_split = flamenco_box.split(**compatibility.factor(0.32), align=True)
+        manager_split.label(text='Manager:')
+        manager_box = manager_split.row(align=True)
+
+        if bcp.status in {'NONE', 'IDLE'}:
+            if not bcp.available_managers:
+                manager_box.operator('flamenco.managers',
+                                     text='Find Flamenco Managers',
+                                     icon='FILE_REFRESH')
+            else:
+                manager_box.prop(bcp, 'manager', text='')
+                manager_box.operator('flamenco.managers',
+                                     text='',
+                                     icon='FILE_REFRESH')
+        else:
+            manager_box.label(text='Fetching available managers.')
+
+        path_split = flamenco_box.split(**compatibility.factor(0.32), align=True)
+        path_split.label(text='Job File Path:')
+        path_box = path_split.row(align=True)
+        path_box.prop(self, 'flamenco_job_file_path', text='')
+        props = path_box.operator('flamenco.explore_file_path', text='', icon='DISK_DRIVE')
+        props.path = self.flamenco_job_file_path
+
+        job_output_box = flamenco_box.column(align=True)
+        path_split = job_output_box.split(**compatibility.factor(0.32), align=True)
+        path_split.label(text='Job Output Path:')
+        path_box = path_split.row(align=True)
+        path_box.prop(self, 'flamenco_job_output_path', text='')
+        props = path_box.operator('flamenco.explore_file_path', text='', icon='DISK_DRIVE')
+        props.path = self.flamenco_job_output_path
+        job_output_box.prop(self, 'flamenco_exclude_filter')
+
+        prop_split = job_output_box.split(**compatibility.factor(0.32), align=True)
+        prop_split.label(text='Strip Components:')
+        prop_split.prop(self, 'flamenco_job_output_strip_components', text='')
+
+        from .flamenco import render_output_path
+
+        path_box = job_output_box.row(align=True)
+        output_path = render_output_path(context)
+        if output_path:
+            path_box.label(text=str(output_path))
+            props = path_box.operator('flamenco.explore_file_path', text='', icon='DISK_DRIVE')
+            props.path = str(output_path.parent)
+        else:
+            path_box.label(text='Blend file is not in your project path, '
+                                'unable to give output path example.')
+
+        flamenco_box.prop(self, 'flamenco_relative_only')
+        flamenco_box.prop(self, 'flamenco_open_browser_after_submit')
+        flamenco_box.prop(self, 'flamenco_show_quit_after_submit_button')
 
 
 class PillarCredentialsUpdate(pillar.PillarOperatorMixin,
@@ -248,6 +489,7 @@ class PillarCredentialsUpdate(pillar.PillarOperatorMixin,
     """Updates the Pillar URL and tests the new URL."""
     bl_idname = 'pillar.credentials_update'
     bl_label = 'Update credentials'
+    bl_description = 'Resynchronises your Blender ID login with Blender Cloud'
 
     log = logging.getLogger('bpy.ops.%s' % bl_idname)
 
@@ -294,6 +536,7 @@ class PILLAR_OT_subscribe(Operator):
     """Opens a browser to subscribe the user to the Cloud."""
     bl_idname = 'pillar.subscribe'
     bl_label = 'Subscribe to the Cloud'
+    bl_description = "Opens a page in a web browser to subscribe to the Blender Cloud"
 
     def execute(self, context):
         import webbrowser
@@ -304,6 +547,109 @@ class PILLAR_OT_subscribe(Operator):
         return {'FINISHED'}
 
 
+@compatibility.convert_properties
+class PILLAR_OT_project_open_in_browser(Operator):
+    bl_idname = 'pillar.project_open_in_browser'
+    bl_label = 'Open in Browser'
+    bl_description = 'Opens a webbrowser to show the project'
+
+    project_id = StringProperty(name='Project ID')
+
+    def execute(self, context):
+        if not self.project_id:
+            return {'CANCELLED'}
+
+        import webbrowser
+        import urllib.parse
+
+        import pillarsdk
+        from .pillar import sync_call
+
+        project = sync_call(pillarsdk.Project.find, self.project_id, {'projection': {'url': True}})
+
+        if log.isEnabledFor(logging.DEBUG):
+            import pprint
+            log.debug('found project: %s', pprint.pformat(project.to_dict()))
+
+        url = urllib.parse.urljoin(PILLAR_WEB_SERVER_URL, 'p/' + project.url)
+        webbrowser.open_new_tab(url)
+        self.report({'INFO'}, 'Opened a browser at %s' % url)
+
+        return {'FINISHED'}
+
+
+class PILLAR_OT_projects(async_loop.AsyncModalOperatorMixin,
+                         pillar.AuthenticatedPillarOperatorMixin,
+                         Operator):
+    """Fetches the projects available to the user"""
+    bl_idname = 'pillar.projects'
+    bl_label = 'Fetch available projects'
+
+    stop_upon_exception = True
+    _log = logging.getLogger('bpy.ops.%s' % bl_idname)
+
+    async def async_execute(self, context):
+        if not await self.authenticate(context):
+            return
+
+        import pillarsdk
+        from .pillar import pillar_call
+
+        self.log.info('Going to fetch projects for user %s', self.user_id)
+
+        preferences().project.status = 'FETCHING'
+
+        # Get all projects, except the home project.
+        projects_user = await pillar_call(
+            pillarsdk.Project.all,
+            {'where': {'user': self.user_id,
+                       'category': {'$ne': 'home'}},
+             'sort': '-name',
+             'projection': {'_id': True,
+                            'name': True,
+                            'extension_props': True},
+             })
+
+        projects_shared = await pillar_call(
+            pillarsdk.Project.all,
+            {'where': {'user': {'$ne': self.user_id},
+                       'permissions.groups.group': {'$in': self.db_user.groups}},
+             'sort': '-name',
+             'projection': {'_id': 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.
+        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())
+
+                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']))
+
+        def proj_sort_key(project):
+            return project.get('name')
+
+        preferences().project.available_projects = sorted(projects, key=proj_sort_key)
+
+        self.quit()
+
+    def quit(self):
+        preferences().project.status = 'IDLE'
+        super().quit()
+
+
 class PILLAR_PT_image_custom_properties(rna_prop_ui.PropertyPanel, bpy.types.Panel):
     """Shows custom properties in the image editor."""
 
@@ -315,8 +661,16 @@ class PILLAR_PT_image_custom_properties(rna_prop_ui.PropertyPanel, bpy.types.Pan
     _property_type = bpy.types.Image
 
 
+def ctx_preferences():
+    """Returns bpy.context.preferences in a 2.79-compatible way."""
+    try:
+        return bpy.context.preferences
+    except AttributeError:
+        return bpy.context.user_preferences
+
+
 def preferences() -> BlenderCloudPreferences:
-    return bpy.context.user_preferences.addons[ADDON_NAME].preferences
+    return ctx_preferences().addons[ADDON_NAME].preferences
 
 
 def load_custom_icons():
@@ -353,10 +707,13 @@ def icon(icon_name: str) -> int:
 
 
 def register():
+    bpy.utils.register_class(BlenderCloudProjectGroup)
     bpy.utils.register_class(BlenderCloudPreferences)
     bpy.utils.register_class(PillarCredentialsUpdate)
     bpy.utils.register_class(SyncStatusProperties)
     bpy.utils.register_class(PILLAR_OT_subscribe)
+    bpy.utils.register_class(PILLAR_OT_projects)
+    bpy.utils.register_class(PILLAR_OT_project_open_in_browser)
     bpy.utils.register_class(PILLAR_PT_image_custom_properties)
 
     addon_prefs = preferences()
@@ -385,10 +742,13 @@ def register():
 def unregister():
     unload_custom_icons()
 
+    bpy.utils.unregister_class(BlenderCloudProjectGroup)
     bpy.utils.unregister_class(PillarCredentialsUpdate)
     bpy.utils.unregister_class(BlenderCloudPreferences)
     bpy.utils.unregister_class(SyncStatusProperties)
     bpy.utils.unregister_class(PILLAR_OT_subscribe)
+    bpy.utils.unregister_class(PILLAR_OT_projects)
+    bpy.utils.unregister_class(PILLAR_OT_project_open_in_browser)
     bpy.utils.unregister_class(PILLAR_PT_image_custom_properties)
 
     del WindowManager.last_blender_cloud_location

blender_cloud/compatibility.py

@@ -0,0 +1,70 @@
+"""Compatibility functions to support Blender 2.79 and 2.80+ in one code base."""
+import functools
+
+import bpy
+
+
+if bpy.app.version < (2, 80):
+    SYNC_SELECT_VERSION_ICON = 'DOTSDOWN'
+else:
+    SYNC_SELECT_VERSION_ICON = 'DOWNARROW_HLT'
+
+
+# Get references to all property definition functions in bpy.props,
+# so that they can be used to replace 'x = IntProperty()' to 'x: IntProperty()'
+# dynamically when working on Blender 2.80+
+__all_prop_funcs = {
+    getattr(bpy.props, propname)
+    for propname in dir(bpy.props)
+    if propname.endswith('Property')
+}
+
+def convert_properties(class_):
+    """Class decorator to avoid warnings in Blender 2.80+
+
+    This decorator replaces property definitions like this:
+
+        someprop = bpy.props.IntProperty()
+
+    to annotations, as introduced in Blender 2.80:
+
+        someprop: bpy.props.IntProperty()
+
+    No-op if running on Blender 2.79 or older.
+    """
+
+    if bpy.app.version < (2, 80):
+        return class_
+
+    if not hasattr(class_, '__annotations__'):
+        class_.__annotations__ = {}
+
+    attrs_to_delete = []
+    for name, value in class_.__dict__.items():
+        if not isinstance(value, tuple) or len(value) != 2:
+            continue
+
+        prop_func, kwargs = value
+        if prop_func not in __all_prop_funcs:
+            continue
+
+        # This is a property definition, replace it with annotation.
+        attrs_to_delete.append(name)
+        class_.__annotations__[name] = value
+
+    for attr_name in attrs_to_delete:
+        delattr(class_, attr_name)
+
+    return class_
+
+
+@functools.lru_cache()
+def factor(factor: float) -> dict:
+    """Construct keyword argument for UILayout.split().
+
+    On Blender 2.8 this returns {'factor': factor}, and on earlier Blenders it returns
+    {'percentage': factor}.
+    """
+    if bpy.app.version < (2, 80, 0):
+        return {'percentage': factor}
+    return {'factor': factor}

blender_cloud/flamenco/bat_interface.py

@@ -0,0 +1,190 @@
+"""BAT🦇 packing interface for Flamenco."""
+
+import asyncio
+import logging
+import pathlib
+import re
+import threading
+import typing
+import urllib.parse
+
+import bpy
+from blender_asset_tracer import pack
+from blender_asset_tracer.pack import progress, transfer, shaman
+
+log = logging.getLogger(__name__)
+
+_running_packer = None  # type: pack.Packer
+_packer_lock = threading.RLock()
+
+# For using in other parts of the add-on, so only this file imports BAT.
+Aborted = pack.Aborted
+FileTransferError = transfer.FileTransferError
+parse_shaman_endpoint = shaman.parse_endpoint
+
+
+class BatProgress(progress.Callback):
+    """Report progress of BAT Packing to the UI.
+
+    Uses asyncio.run_coroutine_threadsafe() to ensure the UI is only updated
+    from the main thread. This is required since we run the BAT Pack in a
+    background thread.
+    """
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.loop = asyncio.get_event_loop()
+
+    def _set_attr(self, attr: str, value):
+
+        async def do_it():
+            setattr(bpy.context.window_manager, attr, value)
+
+        asyncio.run_coroutine_threadsafe(do_it(), loop=self.loop)
+
+    def _txt(self, msg: str):
+        """Set a text in a thread-safe way."""
+        self._set_attr('flamenco_status_txt', msg)
+
+    def _status(self, status: str):
+        """Set the flamenco_status property in a thread-safe way."""
+        self._set_attr('flamenco_status', status)
+
+    def _progress(self, progress: int):
+        """Set the flamenco_progress property in a thread-safe way."""
+        self._set_attr('flamenco_progress', progress)
+
+    def pack_start(self) -> None:
+        self._txt('Starting BAT Pack operation')
+
+    def pack_done(self,
+                  output_blendfile: pathlib.Path,
+                  missing_files: typing.Set[pathlib.Path]) -> None:
+        if missing_files:
+            self._txt('There were %d missing files' % len(missing_files))
+        else:
+            self._txt('Pack of %s done' % output_blendfile.name)
+
+    def pack_aborted(self, reason: str):
+        self._txt('Aborted: %s' % reason)
+        self._status('ABORTED')
+
+    def trace_blendfile(self, filename: pathlib.Path) -> None:
+        """Called for every blendfile opened when tracing dependencies."""
+        self._txt('Inspecting %s' % filename.name)
+
+    def trace_asset(self, filename: pathlib.Path) -> None:
+        if filename.stem == '.blend':
+            return
+        self._txt('Found asset %s' % filename.name)
+
+    def rewrite_blendfile(self, orig_filename: pathlib.Path) -> None:
+        self._txt('Rewriting %s' % orig_filename.name)
+
+    def transfer_file(self, src: pathlib.Path, dst: pathlib.Path) -> None:
+        self._txt('Transferring %s' % src.name)
+
+    def transfer_file_skipped(self, src: pathlib.Path, dst: pathlib.Path) -> None:
+        self._txt('Skipped %s' % src.name)
+
+    def transfer_progress(self, total_bytes: int, transferred_bytes: int) -> None:
+        self._progress(round(100 * transferred_bytes / total_bytes))
+
+    def missing_file(self, filename: pathlib.Path) -> None:
+        # TODO(Sybren): report missing files in a nice way
+        pass
+
+
+class ShamanPacker(shaman.ShamanPacker):
+    """Packer with support for getting an auth token from Flamenco Server."""
+
+    def __init__(self,
+                 bfile: pathlib.Path,
+                 project: pathlib.Path,
+                 target: str,
+                 endpoint: str,
+                 checkout_id: str,
+                 *,
+                 manager_id: str,
+                 **kwargs) -> None:
+        self.manager_id = manager_id
+        super().__init__(bfile, project, target, endpoint, checkout_id, **kwargs)
+
+    def _get_auth_token(self) -> str:
+        """get a token from Flamenco Server"""
+
+        from ..blender import PILLAR_SERVER_URL
+        from ..pillar import blender_id_subclient, uncached_session, SUBCLIENT_ID
+
+        url = urllib.parse.urljoin(PILLAR_SERVER_URL,
+                                   'flamenco/jwt/generate-token/%s' % self.manager_id)
+        auth_token = blender_id_subclient()['token']
+
+        resp = uncached_session.get(url, auth=(auth_token, SUBCLIENT_ID))
+        resp.raise_for_status()
+        return resp.text
+
+
+async def copy(context,
+               base_blendfile: pathlib.Path,
+               project: pathlib.Path,
+               target: str,
+               exclusion_filter: str,
+               *,
+               relative_only: bool,
+               packer_class=pack.Packer,
+               **packer_args) \
+        -> typing.Tuple[pathlib.Path, typing.Set[pathlib.Path]]:
+    """Use BAT🦇 to copy the given file and dependencies to the target location.
+
+    :raises: FileTransferError if a file couldn't be transferred.
+    :returns: the path of the packed blend file, and a set of missing sources.
+    """
+    global _running_packer
+
+    loop = asyncio.get_event_loop()
+    wm = bpy.context.window_manager
+
+    packer = packer_class(base_blendfile, project, target,
+                          compress=True, relative_only=relative_only, **packer_args)
+    with packer:
+        with _packer_lock:
+            if exclusion_filter:
+                # There was a mistake in an older version of the property tooltip,
+                # showing semicolon-separated instead of space-separated. We now
+                # just handle both.
+                filter_parts = re.split('[ ;]+', exclusion_filter.strip(' ;'))
+                packer.exclude(*filter_parts)
+
+            packer.progress_cb = BatProgress()
+            _running_packer = packer
+
+        log.debug('awaiting strategise')
+        wm.flamenco_status = 'INVESTIGATING'
+        await loop.run_in_executor(None, packer.strategise)
+
+        log.debug('awaiting execute')
+        wm.flamenco_status = 'TRANSFERRING'
+        await loop.run_in_executor(None, packer.execute)
+
+        log.debug('done')
+        wm.flamenco_status = 'DONE'
+
+    with _packer_lock:
+        _running_packer = None
+
+    return packer.output_path, packer.missing_files
+
+
+def abort() -> None:
+    """Abort a running copy() call.
+
+    No-op when there is no running copy(). Can be called from any thread.
+    """
+
+    with _packer_lock:
+        if _running_packer is None:
+            log.debug('No running packer, ignoring call to bat_abort()')
+            return
+        log.info('Aborting running packer')
+        _running_packer.abort()

blender_cloud/flamenco/sdk.py

@@ -0,0 +1,109 @@
+import functools
+import pathlib
+import typing
+
+from pillarsdk.resource import List, Find, Create
+
+
+class Manager(List, Find):
+    """Manager class wrapping the REST nodes endpoint"""
+    path = 'flamenco/managers'
+    PurePlatformPath = pathlib.PurePath
+
+    @functools.lru_cache(maxsize=1)
+    def _path_replacements(self) -> list:
+        """Defer to _path_replacements_vN() to get path replacement vars.
+
+        Returns a list of tuples (variable name, variable value).
+        """
+        settings_version = self.settings_version or 1
+        try:
+            settings_func = getattr(self, '_path_replacements_v%d' % settings_version)
+        except AttributeError:
+            raise RuntimeError('This manager has unsupported settings version %d; '
+                               'upgrade Blender Cloud add-on')
+
+        def longest_value_first(item):
+            var_name, var_value = item
+            return -len(var_value), var_value, var_name
+
+        replacements = settings_func()
+        replacements.sort(key=longest_value_first)
+        return replacements
+
+    def _path_replacements_v1(self) -> typing.List[typing.Tuple[str, str]]:
+        import platform
+
+        if self.path_replacement is None:
+            return []
+
+        items = self.path_replacement.to_dict().items()
+
+        this_platform = platform.system().lower()
+        return [(varname, platform_replacements[this_platform])
+                for varname, platform_replacements in items
+                if this_platform in platform_replacements]
+
+    def _path_replacements_v2(self) -> typing.List[typing.Tuple[str, str]]:
+        import platform
+
+        if not self.variables:
+            return []
+
+        this_platform = platform.system().lower()
+        audiences = {'users', 'all'}
+
+        replacements = []
+        for var_name, variable in self.variables.to_dict().items():
+            # Path replacement requires bidirectional variables.
+            if variable.get('direction') != 'twoway':
+                continue
+
+            for var_value in variable.get('values', []):
+                if var_value.get('audience') not in audiences:
+                    continue
+                if var_value.get('platform', '').lower() != this_platform:
+                    continue
+
+                replacements.append((var_name, var_value.get('value')))
+        return replacements
+
+    def replace_path(self, some_path: pathlib.PurePath) -> str:
+        """Performs path variable replacement.
+
+        Tries to find platform-specific path prefixes, and replaces them with
+        variables.
+        """
+        assert isinstance(some_path, pathlib.PurePath), \
+            'some_path should be a PurePath, not %r' % some_path
+
+        for varname, path in self._path_replacements():
+            replacement = self.PurePlatformPath(path)
+            try:
+                relpath = some_path.relative_to(replacement)
+            except ValueError:
+                # Not relative to each other, so no replacement possible
+                continue
+
+            replacement_root = self.PurePlatformPath('{%s}' % varname)
+            return (replacement_root / relpath).as_posix()
+
+        return some_path.as_posix()
+
+
+class Job(List, Find, Create):
+    """Job class wrapping the REST nodes endpoint
+    """
+    path = 'flamenco/jobs'
+    ensure_query_projections = {'project': 1}
+
+    def patch(self, payload: dict, api=None):
+        import pillarsdk.utils
+
+        api = api or self.api
+
+        url = pillarsdk.utils.join_url(self.path, str(self['_id']))
+        headers = pillarsdk.utils.merge_dict(self.http_headers(),
+                                             {'Content-Type': 'application/json'})
+        response = api.patch(url, payload, headers=headers)
+        return response

blender_cloud/image_sharing.py

@@ -25,7 +25,7 @@ import bpy
 import pillarsdk
 from pillarsdk import exceptions as sdk_exceptions
 from .pillar import pillar_call
-from . import async_loop, pillar, home_project, blender
+from . import async_loop, compatibility, pillar, home_project, blender
 
 REQUIRES_ROLES_FOR_IMAGE_SHARING = {'subscriber', 'demo'}
 IMAGE_SHARING_GROUP_NODE_NAME = 'Image sharing'
@@ -53,6 +53,7 @@ async def find_image_sharing_group_id(home_project_id, user_id):
     return share_group['_id']
 
 
+@compatibility.convert_properties
 class PILLAR_OT_image_share(pillar.PillarOperatorMixin,
                             async_loop.AsyncModalOperatorMixin,
                             bpy.types.Operator):
@@ -107,29 +108,28 @@ class PILLAR_OT_image_share(pillar.PillarOperatorMixin,
                 self.report({'ERROR'}, 'Datablock is dirty, save it first.')
                 return {'CANCELLED'}
 
-        async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
-
-        self.log.info('Starting sharing')
-        self._new_async_task(self.async_execute(context))
-        return {'RUNNING_MODAL'}
+        return async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
 
     async def async_execute(self, context):
         """Entry point of the asynchronous operator."""
 
-        self.report({'INFO'}, 'Communicating with Blender Cloud')
+        # We don't want to influence what is included in the screen shot.
+        if self.target == 'SCREENSHOT':
+            print('Blender Cloud add-on is communicating with Blender Cloud')
+        else:
+            self.report({'INFO'}, 'Communicating with Blender Cloud')
 
         try:
             # Refresh credentials
             try:
-                self.user_id = await self.check_credentials(context,
-                                                            REQUIRES_ROLES_FOR_IMAGE_SHARING)
+                db_user = await self.check_credentials(context, REQUIRES_ROLES_FOR_IMAGE_SHARING)
+                self.user_id = db_user['_id']
                 self.log.debug('Found user ID: %s', self.user_id)
-            except pillar.NotSubscribedToCloudError:
-                self.log.exception('User not subscribed to cloud.')
-                self.report({'ERROR'}, 'Please subscribe to the Blender Cloud.')
+            except pillar.NotSubscribedToCloudError as ex:
+                self._log_subscription_needed(can_renew=ex.can_renew)
                 self._state = 'QUIT'
                 return
-            except pillar.CredentialsNotSyncedError:
+            except pillar.UserNotLoggedInError:
                 self.log.exception('Error checking/refreshing credentials.')
                 self.report({'ERROR'}, 'Please log in on Blender ID first.')
                 self._state = 'QUIT'
@@ -324,15 +324,25 @@ def window_menu(self, context):
     props.screenshot_full = True
 
 
+def get_topbar_menu():
+    """Return the topbar menu in a Blender 2.79 and 2.80 compatible way."""
+    try:
+        menu = bpy.types.TOPBAR_MT_window
+    except AttributeError:
+        # Blender < 2.80
+        menu = bpy.types.INFO_MT_window
+    return menu
+
+
 def register():
     bpy.utils.register_class(PILLAR_OT_image_share)
 
     bpy.types.IMAGE_MT_image.append(image_editor_menu)
-    bpy.types.INFO_MT_window.append(window_menu)
+    get_topbar_menu().append(window_menu)
 
 
 def unregister():
     bpy.utils.unregister_class(PILLAR_OT_image_share)
 
     bpy.types.IMAGE_MT_image.remove(image_editor_menu)
-    bpy.types.INFO_MT_window.remove(window_menu)
+    get_topbar_menu().remove(window_menu)

blender_cloud/pillar.py

@@ -26,7 +26,8 @@ from contextlib import closing, contextmanager
 import urllib.parse
 import pathlib
 
-import requests
+import requests.adapters
+import requests.packages.urllib3.util.retry
 import requests.structures
 import pillarsdk
 import pillarsdk.exceptions
@@ -42,7 +43,16 @@ RFC1123_DATE_FORMAT = '%a, %d %b %Y %H:%M:%S GMT'
 
 _pillar_api = {}  # will become a mapping from bool (cached/non-cached) to pillarsdk.Api objects.
 log = logging.getLogger(__name__)
+
+_retries = requests.packages.urllib3.util.retry.Retry(
+    total=10,
+    backoff_factor=0.05,
+)
+_http_adapter = requests.adapters.HTTPAdapter(max_retries=_retries)
 uncached_session = requests.session()
+uncached_session.mount('https://', _http_adapter)
+uncached_session.mount('http://', _http_adapter)
+
 _testing_blender_id_profile = None  # Just for testing, overrides what is returned by blender_id_profile.
 _downloaded_urls = set()  # URLs we've downloaded this Blender session.
 
@@ -62,7 +72,16 @@ class CredentialsNotSyncedError(UserNotLoggedInError):
 
 
 class NotSubscribedToCloudError(UserNotLoggedInError):
-    """Raised when the user may be logged in on Blender ID, but has no Blender Cloud token."""
+    """Raised when the user does not have an active Cloud subscription.
+
+    :ivar can_renew: True when the user has an inactive subscription that can be renewed,
+        or False when the user has no subscription at all.
+    """
+
+    def __init__(self, can_renew: bool):
+        super().__init__()
+        self.can_renew = can_renew
+        log.warning('Not subscribed to cloud, can_renew=%s', can_renew)
 
 
 class PillarError(RuntimeError):
@@ -87,18 +106,18 @@ class CloudPath(pathlib.PurePosixPath):
     def project_uuid(self) -> str:
         assert self.parts[0] == '/'
         if len(self.parts) <= 1:
-            return None
+            return ''
         return self.parts[1]
 
     @property
-    def node_uuids(self) -> list:
+    def node_uuids(self) -> tuple:
         assert self.parts[0] == '/'
         return self.parts[2:]
 
     @property
     def node_uuid(self) -> str:
         if len(self.parts) <= 2:
-            return None
+            return ''
 
         return self.parts[-1]
 
@@ -115,6 +134,12 @@ def with_existing_dir(filename: str, open_mode: str, encoding=None):
         yield file_object
 
 
+def _shorten(somestr: str, maxlen=40) -> str:
+    """Shortens strings for logging"""
+
+    return (somestr[:maxlen - 3] + '...') if len(somestr) > maxlen else somestr
+
+
 def save_as_json(pillar_resource, json_filename):
     with with_existing_dir(json_filename, 'w') as outfile:
         log.debug('Saving metadata to %r' % json_filename)
@@ -146,6 +171,13 @@ def blender_id_subclient() -> dict:
     return subclient
 
 
+def pillar_user_uuid() -> str:
+    """Returns the UUID of the Pillar user."""
+
+    import blender_id
+    return blender_id.get_subclient_user_id(SUBCLIENT_ID)
+
+
 def pillar_api(pillar_endpoint: str = None, caching=True) -> pillarsdk.Api:
     """Returns the Pillar SDK API object for the current user.
 
@@ -193,16 +225,44 @@ def pillar_api(pillar_endpoint: str = None, caching=True) -> pillarsdk.Api:
     return _pillar_api[caching]
 
 
-# No more than this many Pillar calls should be made simultaneously
-pillar_semaphore = asyncio.Semaphore(3)
+# This is an asyncio.Semaphore object, which is late-instantiated to be sure
+# the asyncio loop has been created properly. On Windows we create a new one,
+# which can cause this semaphore to still be linked against the old default
+# loop.
+pillar_semaphore = None
 
 
 async def pillar_call(pillar_func, *args, caching=True, **kwargs):
+    """Calls a Pillar function.
+
+    A semaphore is used to ensure that there won't be too many
+    calls to Pillar simultaneously.
+    """
+
     partial = functools.partial(pillar_func, *args, api=pillar_api(caching=caching), **kwargs)
     loop = asyncio.get_event_loop()
 
-    async with pillar_semaphore:
+    # Use explicit calls to acquire() and release() so that we have more control over
+    # how long we wait and how we handle timeouts.
+    try:
+        await asyncio.wait_for(pillar_semaphore.acquire(), timeout=10, loop=loop)
+    except asyncio.TimeoutError:
+        log.info('Waiting for semaphore to call %s', pillar_func.__name__)
+        try:
+            await asyncio.wait_for(pillar_semaphore.acquire(), timeout=50, loop=loop)
+        except asyncio.TimeoutError:
+            raise RuntimeError('Timeout waiting for Pillar Semaphore!')
+
+    try:
         return await loop.run_in_executor(None, partial)
+    finally:
+        pillar_semaphore.release()
+
+
+def sync_call(pillar_func, *args, caching=True, **kwargs):
+    """Synchronous call to Pillar, ensures the correct Api object is used."""
+
+    return pillar_func(*args, api=pillar_api(caching=caching), **kwargs)
 
 
 async def check_pillar_credentials(required_roles: set):
@@ -232,16 +292,17 @@ async def check_pillar_credentials(required_roles: set):
     except (pillarsdk.UnauthorizedAccess, pillarsdk.ResourceNotFound, pillarsdk.ForbiddenAccess):
         raise CredentialsNotSyncedError()
 
-    roles = db_user.roles or set()
-    log.debug('User has roles %r', roles)
-    if required_roles and not required_roles.intersection(set(roles)):
+    roles = set(db_user.roles or set())
+    log.getChild('check_pillar_credentials').debug('user has roles %r', roles)
+    if required_roles and not required_roles.intersection(roles):
         # Delete the subclient info. This forces a re-check later, which can
         # then pick up on the user's new status.
         del profile.subclients[SUBCLIENT_ID]
         profile.save_json()
-        raise NotSubscribedToCloudError()
 
-    return pillar_user_id
+        raise NotSubscribedToCloudError(can_renew='has_subscription' in roles)
+
+    return db_user
 
 
 async def refresh_pillar_credentials(required_roles: set):
@@ -422,9 +483,9 @@ async def download_to_file(url, filename, *,
         log.debug('Downloading was cancelled before doing the GET')
         raise asyncio.CancelledError('Downloading was cancelled')
 
-    log.debug('Performing GET %s', url)
+    log.debug('Performing GET %s', _shorten(url))
     response = await loop.run_in_executor(None, perform_get_request)
-    log.debug('Status %i from GET %s', response.status_code, url)
+    log.debug('Status %i from GET %s', response.status_code, _shorten(url))
     response.raise_for_status()
 
     if response.status_code == 304:
@@ -438,9 +499,9 @@ async def download_to_file(url, filename, *,
         log.debug('Downloading was cancelled before downloading the GET response')
         raise asyncio.CancelledError('Downloading was cancelled')
 
-    log.debug('Downloading response of GET %s', url)
+    log.debug('Downloading response of GET %s', _shorten(url))
     await loop.run_in_executor(None, download_loop)
-    log.debug('Done downloading response of GET %s', url)
+    log.debug('Done downloading response of GET %s', _shorten(url))
 
     # We're done downloading, now we have something cached we can use.
     log.debug('Saving header cache to %s', header_store)
@@ -515,7 +576,8 @@ async def fetch_texture_thumbs(parent_node_uuid: str, desired_size: str,
              for texture_node in texture_nodes)
 
     # raises any exception from failed handle_texture_node() calls.
-    await asyncio.gather(*coros)
+    loop = asyncio.get_event_loop()
+    await asyncio.gather(*coros, loop=loop)
 
     log.info('fetch_texture_thumbs: Done downloading texture thumbnails')
 
@@ -580,7 +642,11 @@ async def download_texture_thumbnail(texture_node, desired_size: str,
         # Cached headers are stored next to thumbnails in sidecar files.
         header_store = '%s.headers' % thumb_path
 
-        await download_to_file(thumb_url, thumb_path, header_store=header_store, future=future)
+        try:
+            await download_to_file(thumb_url, thumb_path, header_store=header_store, future=future)
+        except requests.exceptions.HTTPError as ex:
+            log.error('Unable to download %s: %s', thumb_url, ex)
+            thumb_path = 'ERROR'
 
     loop.call_soon_threadsafe(thumbnail_loaded, texture_node, file_desc, thumb_path)
 
@@ -728,7 +794,8 @@ async def download_texture(texture_node,
                                     future=future)
         downloaders.append(dlr)
 
-    return await asyncio.gather(*downloaders, return_exceptions=True)
+    loop = asyncio.get_event_loop()
+    return await asyncio.gather(*downloaders, return_exceptions=True, loop=loop)
 
 
 async def upload_file(project_id: str, file_path: pathlib.Path, *,
@@ -754,9 +821,9 @@ async def upload_file(project_id: str, file_path: pathlib.Path, *,
         log.debug('Uploading was cancelled before doing the POST')
         raise asyncio.CancelledError('Uploading was cancelled')
 
-    log.debug('Performing POST %s', url)
+    log.debug('Performing POST %s', _shorten(url))
     response = await loop.run_in_executor(None, upload)
-    log.debug('Status %i from POST %s', response.status_code, url)
+    log.debug('Status %i from POST %s', response.status_code, _shorten(url))
     response.raise_for_status()
 
     resp = response.json()
@@ -780,42 +847,78 @@ def is_cancelled(future: asyncio.Future) -> bool:
 
 class PillarOperatorMixin:
     async def check_credentials(self, context, required_roles) -> bool:
-        """Checks credentials with Pillar, and if ok returns the user ID.
+        """Checks credentials with Pillar, and if ok returns the user document from Pillar/MongoDB.
 
-        Returns None if the user cannot be found, or if the user is not a Cloud subscriber.
+        :raises UserNotLoggedInError: if the user is not logged in
+        :raises NotSubscribedToCloudError: if the user does not have any of the required roles
         """
 
         # self.report({'INFO'}, 'Checking Blender Cloud credentials')
 
         try:
-            user_id = await check_pillar_credentials(required_roles)
+            db_user = await check_pillar_credentials(required_roles)
         except NotSubscribedToCloudError:
-            self._log_subscription_needed()
             raise
         except CredentialsNotSyncedError:
             self.log.info('Credentials not synced, re-syncing automatically.')
         else:
             self.log.info('Credentials okay.')
-            return user_id
+            return db_user
 
         try:
-            user_id = await refresh_pillar_credentials(required_roles)
+            db_user = await refresh_pillar_credentials(required_roles)
         except NotSubscribedToCloudError:
-            self._log_subscription_needed()
             raise
+        except CredentialsNotSyncedError:
+            self.log.info('Credentials not synced after refreshing, handling as not logged in.')
+            raise UserNotLoggedInError('Not logged in.')
         except UserNotLoggedInError:
             self.log.error('User not logged in on Blender ID.')
+            raise
         else:
             self.log.info('Credentials refreshed and ok.')
-            return user_id
+            return db_user
 
-        return None
+    def _log_subscription_needed(self, *, can_renew: bool, level='ERROR'):
+        if can_renew:
+            msg = 'Please renew your Blender Cloud subscription at https://cloud.blender.org/renew'
+        else:
+            msg = 'Please subscribe to the blender cloud at https://cloud.blender.org/join'
+        self.log.warning(msg)
+        self.report({level}, msg)
+
+
+class AuthenticatedPillarOperatorMixin(PillarOperatorMixin):
+    """Checks credentials, to be used at the start of async_execute().
+
+    Sets self.user_id to the current user's ID, and self.db_user to the user info dict,
+    if authentication was succesful; sets both to None if not.
+    """
+
+    async def authenticate(self, context) -> bool:
+        from . import pillar
+
+        self.log.info('Checking credentials')
+        self.user_id = None
+        self.db_user = None
+        try:
+            self.db_user = await self.check_credentials(context, ())
+        except pillar.UserNotLoggedInError as ex:
+            self.log.info('Not logged in error raised: %s', ex)
+            self.report({'ERROR'}, 'Please log in on Blender ID first.')
+            self.quit()
+            return False
+        except requests.exceptions.ConnectionError:
+            self.log.exception('Error checking pillar credentials.')
+            self.report({'ERROR'}, 'Unable to connect to Blender Cloud, '
+                                   'check your internet connection.')
+            self.quit()
+            return False
+
+
+        self.user_id = self.db_user['_id']
+        return True
 
-    def _log_subscription_needed(self):
-        self.log.warning(
-            'Please subscribe to the blender cloud at https://cloud.blender.org/join')
-        self.report({'INFO'},
-                    'Please subscribe to the blender cloud at https://cloud.blender.org/join')
 
 
 async def find_or_create_node(where: dict,

blender_cloud/project_specific.py

@@ -0,0 +1,163 @@
+"""Handle saving and loading project-specific settings."""
+
+import contextlib
+import logging
+import typing
+
+# Names of BlenderCloudPreferences properties that are both project-specific
+# and simple enough to store directly in a dict.
+PROJECT_SPECIFIC_SIMPLE_PROPS = (
+    'cloud_project_local_path',
+)
+
+# Names of BlenderCloudPreferences properties that are project-specific and
+# Flamenco Manager-specific, and simple enough to store in a dict.
+FLAMENCO_PER_PROJECT_PER_MANAGER = (
+    'flamenco_exclude_filter',
+    'flamenco_job_file_path',
+    'flamenco_job_output_path',
+    'flamenco_job_output_strip_components',
+    'flamenco_relative_only',
+)
+
+log = logging.getLogger(__name__)
+project_settings_loading = 0  # counter, if > 0 then we're loading stuff.
+
+
+@contextlib.contextmanager
+def mark_as_loading():
+    """Sets project_settings_loading > 0 while the context is active.
+
+    A counter is used to allow for nested mark_as_loading() contexts.
+    """
+    global project_settings_loading
+    project_settings_loading += 1
+    try:
+        yield
+    finally:
+        project_settings_loading -= 1
+
+
+def update_preferences(prefs, names_to_update: typing.Iterable[str],
+                       new_values: typing.Mapping[str, typing.Any]):
+    for name in names_to_update:
+        if not hasattr(prefs, name):
+            log.debug('not setting %r, property cannot be found', name)
+            continue
+
+        if name in new_values:
+            log.debug('setting %r = %r', name, new_values[name])
+            setattr(prefs, name, new_values[name])
+        else:
+            # The property wasn't stored, so set the default value instead.
+            bl_type, args = getattr(prefs.bl_rna, name)
+            log.debug('finding default value for %r', name)
+            if 'default' not in args:
+                log.debug('no default value for %r, not touching', name)
+                continue
+            log.debug('found default value for %r = %r', name, args['default'])
+            setattr(prefs, name, args['default'])
+
+
+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.
+    """
+
+    from .blender import preferences, project_extensions
+
+    with mark_as_loading():
+        prefs = preferences()
+        project_id = prefs.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()
+
+        # Load project-specific settings from the last time we visited this project.
+        ps = prefs.get('project_settings', {}).get(project_id, {})
+        if not ps:
+            log.debug('no project-specific settings are available, '
+                      'only resetting available Flamenco Managers')
+            # The Flamenco Manager should really be chosen explicitly out of the available
+            # Managers.
+            prefs.flamenco_manager.available_managers = []
+            return
+
+        if log.isEnabledFor(logging.DEBUG):
+            from pprint import pformat
+            log.debug('loading project-specific settings:\n%s', pformat(ps.to_dict()))
+
+        # Restore simple properties.
+        update_preferences(prefs, PROJECT_SPECIFIC_SIMPLE_PROPS, ps)
+
+        # Restore Flamenco settings.
+        prefs.flamenco_manager.available_managers = ps.get('flamenco_available_managers', [])
+        flamenco_manager_id = ps.get('flamenco_manager_id')
+        if flamenco_manager_id:
+            log.debug('setting flamenco manager to %s', flamenco_manager_id)
+            try:
+                # This will trigger a load of Project+Manager-specfic settings.
+                prefs.flamenco_manager.manager = flamenco_manager_id
+            except TypeError:
+                log.warning('manager %s for this project could not be found', flamenco_manager_id)
+        elif prefs.flamenco_manager.available_managers:
+            prefs.flamenco_manager.manager = prefs.flamenco_manager.available_managers[0]['_id']
+
+
+def store(_=None, _2=None):
+    """Remember project-specific settings as soon as one of them changes.
+
+    Ignores arguments so that it can be used as property update callback.
+
+    No-op when project_settings_loading=True, to prevent saving project-
+    specific settings while they are actually being loaded.
+    """
+    from .blender import preferences
+
+    global project_settings_loading
+    if project_settings_loading:
+        return
+
+    prefs = preferences()
+    project_id = prefs.project.project
+    all_settings = prefs.get('project_settings', {})
+    ps = all_settings.get(project_id, {})  # either a dict or bpy.types.IDPropertyGroup
+
+    for name in PROJECT_SPECIFIC_SIMPLE_PROPS:
+        ps[name] = getattr(prefs, name)
+
+    # Store project-specific Flamenco settings
+    ps['flamenco_manager_id'] = prefs.flamenco_manager.manager
+    ps['flamenco_available_managers'] = prefs.flamenco_manager.available_managers
+
+    # Store per-project, per-manager settings for the current Manager.
+    pppm = ps.get('flamenco_managers_settings', {})
+    pppm[prefs.flamenco_manager.manager] = {
+        name: getattr(prefs, name) for name in FLAMENCO_PER_PROJECT_PER_MANAGER
+    }
+    ps['flamenco_managers_settings'] = pppm  # IDPropertyGroup has no setdefault() method.
+
+    # Store this project's settings in the preferences.
+    all_settings[project_id] = ps
+    prefs['project_settings'] = all_settings
+
+    if log.isEnabledFor(logging.DEBUG):
+        from pprint import pformat
+        if hasattr(all_settings, 'to_dict'):
+            to_log = all_settings.to_dict()
+        else:
+            to_log = all_settings
+        log.debug('Saving project-specific settings:\n%s', pformat(to_log))

blender_cloud/settings_sync.py

@@ -25,6 +25,7 @@ import functools
 import logging
 import pathlib
 import tempfile
+import typing
 import shutil
 
 import bpy
@@ -34,7 +35,7 @@ import asyncio
 import pillarsdk
 from pillarsdk import exceptions as sdk_exceptions
 from .pillar import pillar_call
-from . import async_loop, pillar, cache, blendfile, home_project
+from . import async_loop, blender, compatibility, pillar, cache, blendfile, home_project
 
 SETTINGS_FILES_TO_UPLOAD = ['userpref.blend', 'startup.blend']
 
@@ -100,7 +101,7 @@ async def find_sync_group_id(home_project_id: str,
                              user_id: str,
                              blender_version: str,
                              *,
-                             may_create=True) -> str:
+                             may_create=True) -> typing.Tuple[str, str]:
     """Finds the group node in which to store sync assets.
 
     If the group node doesn't exist and may_create=True, it creates it.
@@ -122,7 +123,7 @@ async def find_sync_group_id(home_project_id: str,
 
     if not may_create and sync_group is None:
         log.info("Sync folder doesn't exist, and not creating it either.")
-        return None, None
+        return '', ''
 
     # Find/create the sub-group for the requested Blender version
     try:
@@ -144,7 +145,7 @@ async def find_sync_group_id(home_project_id: str,
     if not may_create and sub_sync_group is None:
         log.info("Sync folder for Blender version %s doesn't exist, "
                  "and not creating it either.", blender_version)
-        return sync_group['_id'], None
+        return sync_group['_id'], ''
 
     return sync_group['_id'], sub_sync_group['_id']
 
@@ -195,6 +196,7 @@ async def available_blender_versions(home_project_id: str, user_id: str) -> list
 
 
 # noinspection PyAttributeOutsideInit
+@compatibility.convert_properties
 class PILLAR_OT_sync(pillar.PillarOperatorMixin,
                      async_loop.AsyncModalOperatorMixin,
                      bpy.types.Operator):
@@ -203,9 +205,9 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
     bl_description = 'Synchronises Blender settings with Blender Cloud'
 
     log = logging.getLogger('bpy.ops.%s' % bl_idname)
-    home_project_id = None
-    sync_group_id = None  # top-level sync group node ID
-    sync_group_versioned_id = None  # sync group node ID for the given Blender version.
+    home_project_id = ''
+    sync_group_id = ''  # top-level sync group node ID
+    sync_group_versioned_id = ''  # sync group node ID for the given Blender version.
 
     action = bpy.props.EnumProperty(
         items=[
@@ -234,11 +236,7 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
             self.bss_report({'ERROR'}, 'No Blender version to sync for was given.')
             return {'CANCELLED'}
 
-        async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
-
-        self.log.info('Starting synchronisation')
-        self._new_async_task(self.async_execute(context))
-        return {'RUNNING_MODAL'}
+        return async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
 
     def action_select(self, context):
         """Allows selection of the Blender version to use.
@@ -285,14 +283,14 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
         try:
             # Refresh credentials
             try:
-                self.user_id = await self.check_credentials(context, REQUIRES_ROLES_FOR_SYNC)
+                db_user = await self.check_credentials(context, REQUIRES_ROLES_FOR_SYNC)
+                self.user_id = db_user['_id']
                 log.debug('Found user ID: %s', self.user_id)
-            except pillar.NotSubscribedToCloudError:
-                self.log.exception('User not subscribed to cloud.')
-                self.bss_report({'SUBSCRIBE'}, 'Please subscribe to the Blender Cloud.')
+            except pillar.NotSubscribedToCloudError as ex:
+                self._log_subscription_needed(can_renew=ex.can_renew)
                 self._state = 'QUIT'
                 return
-            except pillar.CredentialsNotSyncedError:
+            except pillar.UserNotLoggedInError:
                 self.log.exception('Error checking/refreshing credentials.')
                 self.bss_report({'ERROR'}, 'Please log in on Blender ID first.')
                 self._state = 'QUIT'
@@ -391,12 +389,12 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
         """Loads files from the Pillar server."""
 
         # If the sync group node doesn't exist, offer a list of groups that do.
-        if self.sync_group_id is None:
+        if not self.sync_group_id:
             self.bss_report({'ERROR'},
                             'There are no synced Blender settings in your Blender Cloud.')
             return
 
-        if self.sync_group_versioned_id is None:
+        if not self.sync_group_versioned_id:
             self.bss_report({'ERROR'}, 'Therre are no synced Blender settings for version %s' %
                             self.blender_version)
             return
@@ -419,11 +417,20 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
         bss = bpy.context.window_manager.blender_sync_status
         bss.available_blender_versions = versions
 
-        if versions:
+        if not versions:
             # There are versions to sync, so we can remove the status message.
             # However, if there aren't any, the status message shows why, and
             # shouldn't be erased.
-            self.bss_report({'INFO'}, '')
+            return
+
+        # Prevent warnings that the current value of the EnumProperty isn't valid.
+        current_version = '%d.%d' % bpy.app.version[:2]
+        if current_version in versions:
+            bss.version = current_version
+        else:
+            bss.version = versions[0]
+
+        self.bss_report({'INFO'}, '')
 
     async def download_settings_file(self, fname: str, temp_dir: str):
         config_dir = pathlib.Path(bpy.utils.user_resource('CONFIG'))
@@ -480,13 +487,13 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
         self.log.info('Overriding machine-local settings in %s', file_path)
 
         # Remember some settings that should not be overwritten from the Cloud.
-        up = bpy.context.user_preferences
+        prefs = blender.ctx_preferences()
         remembered = {}
         for rna_key, python_key in LOCAL_SETTINGS_RNA:
             assert '.' in python_key, 'Sorry, this code assumes there is a dot in the Python key'
 
             try:
-                value = up.path_resolve(python_key)
+                value = prefs.path_resolve(python_key)
             except ValueError:
                 # Setting doesn't exist. This can happen, for example Cycles
                 # settings on a build that doesn't have Cycles enabled.
@@ -495,7 +502,7 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
             # Map enums from strings (in Python) to ints (in DNA).
             dot_index = python_key.rindex('.')
             parent_key, prop_key = python_key[:dot_index], python_key[dot_index + 1:]
-            parent = up.path_resolve(parent_key)
+            parent = prefs.path_resolve(parent_key)
             prop = parent.bl_rna.properties[prop_key]
             if prop.type == 'ENUM':
                 log.debug('Rewriting %s from %r to %r',

blender_cloud/texture_browser/__init__.py

@@ -18,212 +18,35 @@
 
 import asyncio
 import logging
-import threading
 import os
+import threading
+import typing
 
 import bpy
 import bgl
-import blf
 
 import pillarsdk
-from . import async_loop, pillar, cache, blender, utils
+from .. import async_loop, compatibility, pillar, cache, blender, utils
+from . import menu_item as menu_item_mod  # so that we can have menu items called 'menu_item'
+from . import nodes
+
+if bpy.app.version < (2, 80):
+    from . import draw_27 as draw
+else:
+    from . import draw
 
 REQUIRED_ROLES_FOR_TEXTURE_BROWSER = {'subscriber', 'demo'}
 MOUSE_SCROLL_PIXELS_PER_TICK = 50
 
-ICON_WIDTH = 128
-ICON_HEIGHT = 128
 TARGET_ITEM_WIDTH = 400
 TARGET_ITEM_HEIGHT = 128
 ITEM_MARGIN_X = 5
 ITEM_MARGIN_Y = 5
 ITEM_PADDING_X = 5
 
-library_path = '/tmp'
-library_icons_path = os.path.join(os.path.dirname(__file__), "icons")
 log = logging.getLogger(__name__)
 
 
-class SpecialFolderNode(pillarsdk.Node):
-    NODE_TYPE = 'SPECIAL'
-
-
-class UpNode(SpecialFolderNode):
-    NODE_TYPE = 'UP'
-
-    def __init__(self):
-        super().__init__()
-        self['_id'] = 'UP'
-        self['node_type'] = self.NODE_TYPE
-
-
-class ProjectNode(SpecialFolderNode):
-    NODE_TYPE = 'PROJECT'
-
-    def __init__(self, project):
-        super().__init__()
-
-        assert isinstance(project, pillarsdk.Project), 'wrong type for project: %r' % type(project)
-
-        self.merge(project.to_dict())
-        self['node_type'] = self.NODE_TYPE
-
-
-class MenuItem:
-    """GUI menu item for the 3D View GUI."""
-
-    icon_margin_x = 4
-    icon_margin_y = 4
-    text_margin_x = 6
-
-    text_height = 16
-    text_width = 72
-
-    DEFAULT_ICONS = {
-        'FOLDER': os.path.join(library_icons_path, 'folder.png'),
-        'SPINNER': os.path.join(library_icons_path, 'spinner.png'),
-    }
-
-    FOLDER_NODE_TYPES = {'group_texture', 'group_hdri', UpNode.NODE_TYPE, ProjectNode.NODE_TYPE}
-    SUPPORTED_NODE_TYPES = {'texture', 'hdri'}.union(FOLDER_NODE_TYPES)
-
-    def __init__(self, node, file_desc, thumb_path: str, label_text):
-        self.log = logging.getLogger('%s.MenuItem' % __name__)
-        if node['node_type'] not in self.SUPPORTED_NODE_TYPES:
-            self.log.info('Invalid node type in node: %s', node)
-            raise TypeError('Node of type %r not supported; supported are %r.' % (
-                node['node_type'], self.SUPPORTED_NODE_TYPES))
-
-        assert isinstance(node, pillarsdk.Node), 'wrong type for node: %r' % type(node)
-        assert isinstance(node['_id'], str), 'wrong type for node["_id"]: %r' % type(node['_id'])
-        self.node = node  # pillarsdk.Node, contains 'node_type' key to indicate type
-        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
-        self.label_text = label_text
-        self._thumb_path = ''
-        self.icon = None
-        self._is_folder = node['node_type'] in self.FOLDER_NODE_TYPES
-        self._is_spinning = False
-
-        # Determine sorting order.
-        # by default, sort all the way at the end and folders first.
-        self._order = 0 if self._is_folder else 10000
-        if node and node.properties and node.properties.order is not None:
-            self._order = node.properties.order
-
-        self.thumb_path = thumb_path
-
-        # Updated when drawing the image
-        self.x = 0
-        self.y = 0
-        self.width = 0
-        self.height = 0
-
-    def sort_key(self):
-        """Key for sorting lists of MenuItems."""
-        return self._order, self.label_text
-
-    @property
-    def thumb_path(self) -> str:
-        return self._thumb_path
-
-    @thumb_path.setter
-    def thumb_path(self, new_thumb_path: str):
-        self._is_spinning = new_thumb_path == 'SPINNER'
-
-        self._thumb_path = self.DEFAULT_ICONS.get(new_thumb_path, new_thumb_path)
-        if self._thumb_path:
-            self.icon = bpy.data.images.load(filepath=self._thumb_path)
-        else:
-            self.icon = None
-
-    @property
-    def node_uuid(self) -> str:
-        return self.node['_id']
-
-    def represents(self, node) -> bool:
-        """Returns True iff this MenuItem represents the given node."""
-
-        node_uuid = node['_id']
-        return self.node_uuid == node_uuid
-
-    def update(self, node, file_desc, thumb_path: str, label_text=None):
-        # We can get updated information about our Node, but a MenuItem should
-        # always represent one node, and it shouldn't be shared between nodes.
-        if self.node_uuid != node['_id']:
-            raise ValueError("Don't change the node ID this MenuItem reflects, "
-                             "just create a new one.")
-        self.node = node
-        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
-        self.thumb_path = thumb_path
-
-        if label_text is not None:
-            self.label_text = label_text
-
-    @property
-    def is_folder(self) -> bool:
-        return self._is_folder
-
-    @property
-    def is_spinning(self) -> bool:
-        return self._is_spinning
-
-    def update_placement(self, x, y, width, height):
-        """Use OpenGL to draw this one menu item."""
-
-        self.x = x
-        self.y = y
-        self.width = width
-        self.height = height
-
-    def draw(self, highlighted: bool):
-        bgl.glEnable(bgl.GL_BLEND)
-        if highlighted:
-            bgl.glColor4f(0.555, 0.555, 0.555, 0.8)
-        else:
-            bgl.glColor4f(0.447, 0.447, 0.447, 0.8)
-
-        bgl.glRectf(self.x, self.y, self.x + self.width, self.y + self.height)
-
-        texture = self.icon
-        err = texture.gl_load(filter=bgl.GL_NEAREST, mag=bgl.GL_NEAREST)
-        assert not err, 'OpenGL error: %i' % err
-
-        bgl.glColor4f(0.0, 0.0, 1.0, 0.5)
-        # bgl.glLineWidth(1.5)
-
-        # ------ TEXTURE ---------#
-        bgl.glBindTexture(bgl.GL_TEXTURE_2D, texture.bindcode[0])
-        bgl.glEnable(bgl.GL_TEXTURE_2D)
-        bgl.glBlendFunc(bgl.GL_SRC_ALPHA, bgl.GL_ONE_MINUS_SRC_ALPHA)
-
-        bgl.glColor4f(1, 1, 1, 1)
-        bgl.glBegin(bgl.GL_QUADS)
-        bgl.glTexCoord2d(0, 0)
-        bgl.glVertex2d(self.x + self.icon_margin_x, self.y)
-        bgl.glTexCoord2d(0, 1)
-        bgl.glVertex2d(self.x + self.icon_margin_x, self.y + ICON_HEIGHT)
-        bgl.glTexCoord2d(1, 1)
-        bgl.glVertex2d(self.x + self.icon_margin_x + ICON_WIDTH, self.y + ICON_HEIGHT)
-        bgl.glTexCoord2d(1, 0)
-        bgl.glVertex2d(self.x + self.icon_margin_x + ICON_WIDTH, self.y)
-        bgl.glEnd()
-        bgl.glDisable(bgl.GL_TEXTURE_2D)
-        bgl.glDisable(bgl.GL_BLEND)
-
-        texture.gl_free()
-
-        # draw some text
-        font_id = 0
-        blf.position(font_id,
-                     self.x + self.icon_margin_x + ICON_WIDTH + self.text_margin_x,
-                     self.y + ICON_HEIGHT * 0.5 - 0.25 * self.text_height, 0)
-        blf.size(font_id, self.text_height, self.text_width)
-        blf.draw(font_id, self.label_text)
-
-    def hits(self, mouse_x: int, mouse_y: int) -> bool:
-        return self.x < mouse_x < self.x + self.width and self.y < mouse_y < self.y + self.height
-
-
 class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                           async_loop.AsyncModalOperatorMixin,
                           bpy.types.Operator):
@@ -236,17 +59,17 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
     project_name = ''
 
     # This contains a stack of Node objects that lead up to the currently browsed node.
-    path_stack = []
+    path_stack = []  # type: typing.List[pillarsdk.Node]
 
     # This contains a stack of MenuItem objects that lead up to the currently browsed node.
-    menu_item_stack = []
+    menu_item_stack = []  # type: typing.List[menu_item_mod.MenuItem]
 
     timer = None
     log = logging.getLogger('%s.BlenderCloudBrowser' % __name__)
 
     _menu_item_lock = threading.Lock()
-    current_display_content = []  # list of MenuItems currently displayed
-    loaded_images = set()
+    current_display_content = []  # type: typing.List[menu_item_mod.MenuItem]
+    loaded_images = set()  # type: typing.Set[str]
     thumbnails_cache = ''
     maximized_area = False
 
@@ -258,8 +81,9 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
     scroll_offset_space_left = 0
 
     def invoke(self, context, event):
-        # Refuse to start if the file hasn't been saved.
-        if context.blend_data.is_dirty:
+        # Refuse to start if the file hasn't been saved. It's okay if
+        # it's dirty, we just need to know where '//' points to.
+        if not os.path.exists(context.blend_data.filepath):
             self.report({'ERROR'}, 'Please save your Blend file before using '
                                    'the Blender Cloud addon.')
             return {'CANCELLED'}
@@ -288,10 +112,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         self._scroll_reset()
 
         context.window.cursor_modal_set('DEFAULT')
-        async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
-        self._new_async_task(self.async_execute(context))
-
-        return {'RUNNING_MODAL'}
+        return async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
 
     def modal(self, context, event):
         result = async_loop.AsyncModalOperatorMixin.modal(self, context, event)
@@ -313,8 +134,8 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             self.mouse_y = event.mouse_y
 
         left_mouse_release = event.type == 'LEFTMOUSE' and event.value == 'RELEASE'
-        if self._state == 'PLEASE_SUBSCRIBE' and left_mouse_release:
-            self.open_browser_subscribe()
+        if left_mouse_release and self._state in {'PLEASE_SUBSCRIBE', 'PLEASE_RENEW'}:
+            self.open_browser_subscribe(renew=self._state == 'PLEASE_RENEW')
             self._finish(context)
             return {'FINISHED'}
 
@@ -366,24 +187,28 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         self.log.debug('Checking credentials')
 
         try:
-            user_id = await self.check_credentials(context, REQUIRED_ROLES_FOR_TEXTURE_BROWSER)
-        except pillar.NotSubscribedToCloudError:
-            self.log.info('User not subscribed to Blender Cloud.')
-            self._show_subscribe_screen()
+            db_user = await self.check_credentials(context, REQUIRED_ROLES_FOR_TEXTURE_BROWSER)
+        except pillar.NotSubscribedToCloudError as ex:
+            self._log_subscription_needed(can_renew=ex.can_renew, level='INFO')
+            self._show_subscribe_screen(can_renew=ex.can_renew)
             return None
 
-        if user_id is None:
+        if db_user is None:
             raise pillar.UserNotLoggedInError()
 
         await self.async_download_previews()
 
-    def _show_subscribe_screen(self):
+    def _show_subscribe_screen(self, *, can_renew: bool):
         """Shows the "You need to subscribe" screen."""
 
-        self._state = 'PLEASE_SUBSCRIBE'
+        if can_renew:
+            self._state = 'PLEASE_RENEW'
+        else:
+            self._state = 'PLEASE_SUBSCRIBE'
+
         bpy.context.window.cursor_set('HAND')
 
-    def descend_node(self, menu_item: MenuItem):
+    def descend_node(self, menu_item: menu_item_mod.MenuItem):
         """Descends the node hierarchy by visiting this menu item's node.
 
         Also keeps track of the current node, so that we know where the "up" button should go.
@@ -392,7 +217,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         node = menu_item.node
         assert isinstance(node, pillarsdk.Node), 'Wrong type %s' % node
 
-        if isinstance(node, UpNode):
+        if isinstance(node, nodes.UpNode):
             # Going up.
             self.log.debug('Going up to %r', self.current_path)
             self.current_path = self.current_path.parent
@@ -404,7 +229,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                 self.project_name = ''
         else:
             # Going down, keep track of where we were
-            if isinstance(node, ProjectNode):
+            if isinstance(node, nodes.ProjectNode):
                 self.project_name = node['name']
 
             self.current_path /= node['_id']
@@ -447,19 +272,20 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         self.loaded_images.clear()
         self.current_display_content.clear()
 
-    def add_menu_item(self, *args) -> MenuItem:
-        menu_item = MenuItem(*args)
+    def add_menu_item(self, *args) -> menu_item_mod.MenuItem:
+        menu_item = menu_item_mod.MenuItem(*args)
 
         # Just make this thread-safe to be on the safe side.
         with self._menu_item_lock:
             self.current_display_content.append(menu_item)
-            self.loaded_images.add(menu_item.icon.filepath_raw)
+            if menu_item.icon is not None:
+                self.loaded_images.add(menu_item.icon.filepath_raw)
 
         self.sort_menu()
 
         return menu_item
 
-    def update_menu_item(self, node, *args) -> MenuItem:
+    def update_menu_item(self, node, *args):
         node_uuid = node['_id']
 
         # Just make this thread-safe to be on the safe side.
@@ -481,7 +307,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             return
 
         with self._menu_item_lock:
-            self.current_display_content.sort(key=MenuItem.sort_key)
+            self.current_display_content.sort(key=menu_item_mod.MenuItem.sort_key)
 
     async def async_download_previews(self):
         self._state = 'BROWSING'
@@ -511,17 +337,17 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             self.log.debug('No node UUID and no project UUID, listing available projects')
             children = await pillar.get_texture_projects()
             for proj_dict in children:
-                self.add_menu_item(ProjectNode(proj_dict), None, 'FOLDER', proj_dict['name'])
+                self.add_menu_item(nodes.ProjectNode(proj_dict), None, 'FOLDER', proj_dict['name'])
             return
 
         # Make sure we can go up again.
-        self.add_menu_item(UpNode(), None, 'FOLDER', '.. up ..')
+        self.add_menu_item(nodes.UpNode(), None, 'FOLDER', '.. up ..')
 
         # Download all child nodes
         self.log.debug('Iterating over child nodes of %r', self.current_path)
         for child in children:
             # print('  - %(_id)s = %(name)s' % child)
-            if child['node_type'] not in MenuItem.SUPPORTED_NODE_TYPES:
+            if child['node_type'] not in menu_item_mod.MenuItem.SUPPORTED_NODE_TYPES:
                 self.log.debug('Skipping node of type %r', child['node_type'])
                 continue
             self.add_menu_item(child, None, 'FOLDER', child['name'])
@@ -540,6 +366,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             self.add_menu_item(node, None, 'SPINNER', texture_node['name'])
 
         def thumbnail_loaded(node, file_desc, thumb_path):
+            self.log.debug('Node %s thumbnail loaded', node['_id'])
             self.update_menu_item(node, file_desc, thumb_path)
 
         await pillar.fetch_texture_thumbs(node_uuid, 's', directory,
@@ -549,17 +376,20 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
 
     def browse_assets(self):
         self.log.debug('Browsing assets at %r', self.current_path)
+        bpy.context.window_manager.last_blender_cloud_location = str(self.current_path)
         self._new_async_task(self.async_download_previews())
 
     def draw_menu(self, context):
         """Draws the GUI with OpenGL."""
 
         drawers = {
+            'INITIALIZING': self._draw_initializing,
             'CHECKING_CREDENTIALS': self._draw_checking_credentials,
             'BROWSING': self._draw_browser,
             'DOWNLOADING_TEXTURE': self._draw_downloading,
             'EXCEPTION': self._draw_exception,
             'PLEASE_SUBSCRIBE': self._draw_subscribe,
+            'PLEASE_RENEW': self._draw_renew,
         }
 
         if self._state in drawers:
@@ -567,12 +397,9 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             drawer(context)
 
         # For debugging: draw the state
-        font_id = 0
-        bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-        blf.size(font_id, 20, 72)
-        blf.position(font_id, 5, 5, 0)
-        blf.draw(font_id, '%s %s' % (self._state, self.project_name))
-        bgl.glDisable(bgl.GL_BLEND)
+        draw.text((5, 5),
+                  '%s %s' % (self._state, self.project_name),
+                  rgba=(1.0, 1.0, 1.0, 1.0), fsize=12)
 
     @staticmethod
     def _window_region(context):
@@ -583,6 +410,12 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
 
     def _draw_browser(self, context):
         """OpenGL drawing code for the BROWSING state."""
+        from . import draw
+
+        if not self.current_display_content:
+            self._draw_text_on_colour(context, "Communicating with Blender Cloud",
+                                      (0.0, 0.0, 0.0, 0.6))
+            return
 
         window_region = self._window_region(context)
         content_width = window_region.width - ITEM_MARGIN_X * 2
@@ -600,46 +433,33 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         block_height = item_height + ITEM_MARGIN_Y
 
         bgl.glEnable(bgl.GL_BLEND)
-        bgl.glColor4f(0.0, 0.0, 0.0, 0.6)
-        bgl.glRectf(0, 0, window_region.width, window_region.height)
+        draw.aabox((0, 0), (window_region.width, window_region.height),
+                   (0.0, 0.0, 0.0, 0.6))
 
-        if self.current_display_content:
-            bottom_y = float('inf')
+        bottom_y = float('inf')
 
-            # The -1 / +2 are for extra rows that are drawn only half at the top/bottom.
-            first_item_idx = max(0, int(-self.scroll_offset // block_height - 1) * col_count)
-            items_per_page = int(content_height // item_height + 2) * col_count
-            last_item_idx = first_item_idx + items_per_page
+        # The -1 / +2 are for extra rows that are drawn only half at the top/bottom.
+        first_item_idx = max(0, int(-self.scroll_offset // block_height - 1) * col_count)
+        items_per_page = int(content_height // item_height + 2) * col_count
+        last_item_idx = first_item_idx + items_per_page
 
-            for item_idx, item in enumerate(self.current_display_content):
-                x = content_x + (item_idx % col_count) * block_width
-                y = content_y - (item_idx // col_count) * block_height - self.scroll_offset
+        for item_idx, item in enumerate(self.current_display_content):
+            x = content_x + (item_idx % col_count) * block_width
+            y = content_y - (item_idx // col_count) * block_height - self.scroll_offset
 
-                item.update_placement(x, y, item_width, item_height)
+            item.update_placement(x, y, item_width, item_height)
 
-                if first_item_idx <= item_idx < last_item_idx:
-                    # Only draw if the item is actually on screen.
-                    item.draw(highlighted=item.hits(self.mouse_x, self.mouse_y))
+            if first_item_idx <= item_idx < last_item_idx:
+                # Only draw if the item is actually on screen.
+                item.draw(highlighted=item.hits(self.mouse_x, self.mouse_y))
 
-                bottom_y = min(y, bottom_y)
-            self.scroll_offset_space_left = window_region.height - bottom_y
-            self.scroll_offset_max = (self.scroll_offset -
-                                      self.scroll_offset_space_left +
-                                      0.25 * block_height)
-
-        else:
-            font_id = 0
-            text = "Communicating with Blender Cloud"
-            bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-            blf.size(font_id, 20, 72)
-            text_width, text_height = blf.dimensions(font_id, text)
-            blf.position(font_id,
-                         content_x + content_width * 0.5 - text_width * 0.5,
-                         content_y - content_height * 0.3 + text_height * 0.5, 0)
-            blf.draw(font_id, text)
+            bottom_y = min(y, bottom_y)
+        self.scroll_offset_space_left = window_region.height - bottom_y
+        self.scroll_offset_max = (self.scroll_offset -
+                                  self.scroll_offset_space_left +
+                                  0.25 * block_height)
 
         bgl.glDisable(bgl.GL_BLEND)
-        # bgl.glColor4f(0.0, 0.0, 0.0, 1.0)
 
     def _draw_downloading(self, context):
         """OpenGL drawing code for the DOWNLOADING_TEXTURE state."""
@@ -655,21 +475,22 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                                   'Checking login credentials',
                                   (0.0, 0.0, 0.2, 0.6))
 
-    def _draw_text_on_colour(self, context, text, bgcolour):
+    def _draw_initializing(self, context):
+        """OpenGL drawing code for the INITIALIZING state."""
+
+        self._draw_text_on_colour(context,
+                                  'Initializing',
+                                  (0.0, 0.0, 0.2, 0.6))
+
+    def _draw_text_on_colour(self, context, text: str, bgcolour):
         content_height, content_width = self._window_size(context)
+
         bgl.glEnable(bgl.GL_BLEND)
-        bgl.glColor4f(*bgcolour)
-        bgl.glRectf(0, 0, content_width, content_height)
 
-        font_id = 0
-        bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-        blf.size(font_id, 20, 72)
-        text_width, text_height = blf.dimensions(font_id, text)
+        draw.aabox((0, 0), (content_width, content_height), bgcolour)
+        draw.text((content_width * 0.5, content_height * 0.7),
+                  text, fsize=20, align='C')
 
-        blf.position(font_id,
-                     content_width * 0.5 - text_width * 0.5,
-                     content_height * 0.7 + text_height * 0.5, 0)
-        blf.draw(font_id, text)
         bgl.glDisable(bgl.GL_BLEND)
 
     def _window_size(self, context):
@@ -686,33 +507,21 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         content_height, content_width = self._window_size(context)
 
         bgl.glEnable(bgl.GL_BLEND)
-        bgl.glColor4f(0.2, 0.0, 0.0, 0.6)
-        bgl.glRectf(0, 0, content_width, content_height)
+        draw.aabox((0, 0), (content_width, content_height), (0.2, 0.0, 0.0, 0.6))
 
-        font_id = 0
         ex = self.async_task.exception()
         if isinstance(ex, pillar.UserNotLoggedInError):
             ex_msg = 'You are not logged in on Blender ID. Please log in at User Preferences, ' \
-                     'System, Blender ID.'
+                     'Add-ons, Blender ID Authentication.'
         else:
             ex_msg = str(ex)
             if not ex_msg:
                 ex_msg = str(type(ex))
         text = "An error occurred:\n%s" % ex_msg
-        lines = textwrap.wrap(text)
+        lines = textwrap.wrap(text, width=100)
 
-        bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-        blf.size(font_id, 20, 72)
-        _, text_height = blf.dimensions(font_id, 'yhBp')
+        draw.text((content_width * 0.1, content_height * 0.9), lines, fsize=16)
 
-        def position(line_nr):
-            blf.position(font_id,
-                         content_width * 0.1,
-                         content_height * 0.8 - line_nr * text_height, 0)
-
-        for line_idx, line in enumerate(lines):
-            position(line_idx)
-            blf.draw(font_id, line)
         bgl.glDisable(bgl.GL_BLEND)
 
     def _draw_subscribe(self, context):
@@ -720,7 +529,12 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                                   'Click to subscribe to the Blender Cloud',
                                   (0.0, 0.0, 0.2, 0.6))
 
-    def get_clicked(self) -> MenuItem:
+    def _draw_renew(self, context):
+        self._draw_text_on_colour(context,
+                                  'Click to renew your Blender Cloud subscription',
+                                  (0.0, 0.0, 0.2, 0.6))
+
+    def get_clicked(self) -> typing.Optional[menu_item_mod.MenuItem]:
 
         for item in self.current_display_content:
             if item.hits(self.mouse_x, self.mouse_y):
@@ -728,7 +542,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
 
         return None
 
-    def handle_item_selection(self, context, item: MenuItem):
+    def handle_item_selection(self, context, item: menu_item_mod.MenuItem):
         """Called when the user clicks on a menu item that doesn't represent a folder."""
 
         from pillarsdk.utils import sanitize_filename
@@ -800,11 +614,11 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                                                      future=signalling_future))
         self.async_task.add_done_callback(texture_download_completed)
 
-    def open_browser_subscribe(self):
+    def open_browser_subscribe(self, *, renew: bool):
         import webbrowser
 
-        webbrowser.open_new_tab('https://cloud.blender.org/join')
-
+        url = 'renew' if renew else 'join'
+        webbrowser.open_new_tab('https://cloud.blender.org/%s' % url)
         self.report({'INFO'}, 'We just started a browser for you.')
 
     def _scroll_smooth(self):
@@ -834,6 +648,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         self.scroll_offset_target = self.scroll_offset = 0
 
 
+@compatibility.convert_properties
 class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
                             async_loop.AsyncModalOperatorMixin,
                             bpy.types.Operator):
@@ -850,13 +665,6 @@ class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
     file_uuid = bpy.props.StringProperty(name='file_uuid',
                                          description='File ID to download')
 
-    def invoke(self, context, event):
-        async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
-
-        self.log.info('Starting')
-        self._new_async_task(self.async_execute(context))
-        return {'RUNNING_MODAL'}
-
     async def async_execute(self, context):
         """Entry point of the asynchronous operator."""
 
@@ -864,19 +672,19 @@ class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
 
         try:
             try:
-                user_id = await self.check_credentials(context, REQUIRED_ROLES_FOR_TEXTURE_BROWSER)
-            except pillar.NotSubscribedToCloudError:
-                self.log.exception('User not subscribed to cloud.')
-                self.report({'ERROR'}, 'Please subscribe to the Blender Cloud.')
+                db_user = await self.check_credentials(context, REQUIRED_ROLES_FOR_TEXTURE_BROWSER)
+                user_id = db_user['_id']
+            except pillar.NotSubscribedToCloudError as ex:
+                self._log_subscription_needed(can_renew=ex.can_renew)
                 self._state = 'QUIT'
                 return
-            except pillar.CredentialsNotSyncedError:
+            except pillar.UserNotLoggedInError:
                 self.log.exception('Error checking/refreshing credentials.')
                 self.report({'ERROR'}, 'Please log in on Blender ID first.')
                 self._state = 'QUIT'
                 return
 
-            if user_id is None:
+            if not user_id:
                 raise pillar.UserNotLoggedInError()
 
             await self.download_and_replace(context)
@@ -887,13 +695,11 @@ class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
         self._state = 'QUIT'
 
     async def download_and_replace(self, context):
-        from .pillar import sanitize_filename
-
         self._state = 'DOWNLOADING_TEXTURE'
 
         current_image = bpy.data.images[self.image_name]
         node = current_image['bcloud_node']
-        filename = '%s.taken_from_file' % sanitize_filename(node['name'])
+        filename = '%s.taken_from_file' % pillar.sanitize_filename(node['name'])
 
         local_path = os.path.dirname(bpy.path.abspath(current_image.filepath))
         top_texture_directory = bpy.path.abspath(context.scene.local_texture_dir)
@@ -903,21 +709,27 @@ class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
         resolution = next(file_ref['resolution'] for file_ref in node['properties']['files']
                           if file_ref['file'] == file_uuid)
 
-        self.log.info('Downloading file %r-%s to %s', file_uuid, resolution, local_path)
-        self.log.debug('Metadata will be stored at %s', meta_path)
+        my_log = self.log
+        my_log.info('Downloading file %r-%s to %s', file_uuid, resolution, local_path)
+        my_log.debug('Metadata will be stored at %s', meta_path)
 
         def file_loading(file_path, file_desc, map_type):
-            self.log.info('Texture downloading to %s (%s)',
-                          file_path, utils.sizeof_fmt(file_desc['length']))
+            my_log.info('Texture downloading to %s (%s)',
+                        file_path, utils.sizeof_fmt(file_desc['length']))
 
         async def file_loaded(file_path, file_desc, map_type):
             if context.scene.local_texture_dir.startswith('//'):
                 file_path = bpy.path.relpath(file_path)
 
-            self.log.info('Texture downloaded to %s', file_path)
+            my_log.info('Texture downloaded to %s', file_path)
             current_image['bcloud_file_uuid'] = file_uuid
             current_image.filepath = file_path  # This automatically reloads the image from disk.
 
+            # This forces users of the image to update.
+            for datablocks in bpy.data.user_map({current_image}).values():
+                for datablock in datablocks:
+                    datablock.update_tag()
+
         await pillar.download_file_by_uuid(file_uuid,
                                            local_path,
                                            meta_path,
@@ -965,8 +777,8 @@ def _hdri_download_panel(self, current_image):
                     current_image.name)
         return
 
-    row = self.layout.row(align=True).split(0.3)
-    row.label('HDRi', icon_value=blender.icon('CLOUD'))
+    row = self.layout.row(align=True).split(**compatibility.factor(0.3))
+    row.label(text='HDRi', icon_value=blender.icon('CLOUD'))
     row.prop(current_image, 'hdri_variation', text='')
 
     if current_image.hdri_variation != current_variation:
@@ -977,6 +789,11 @@ def _hdri_download_panel(self, current_image):
         props.file_uuid = current_image.hdri_variation
 
 
+# Storage for variation labels, as the strings in EnumProperty items
+# MUST be kept in Python memory.
+variation_label_storage = {}
+
+
 def hdri_variation_choices(self, context):
     if context.area.type == 'IMAGE_EDITOR':
         image = context.edit_image
@@ -988,8 +805,11 @@ def hdri_variation_choices(self, context):
     if 'bcloud_node' not in image:
         return []
 
-    choices = [(file_doc['file'], file_doc['resolution'], '')
-               for file_doc in image['bcloud_node']['properties']['files']]
+    choices = []
+    for file_doc in image['bcloud_node']['properties']['files']:
+        label = file_doc['resolution']
+        variation_label_storage[label] = label
+        choices.append((file_doc['file'], label, ''))
 
     return choices
 

blender_cloud/texture_browser/draw.py

@@ -0,0 +1,112 @@
+"""OpenGL drawing code for the texture browser.
+
+Requires Blender 2.80 or newer.
+"""
+
+import typing
+
+import bgl
+import blf
+import bpy
+import gpu
+from gpu_extras.batch import batch_for_shader
+
+if bpy.app.background:
+    shader = None
+    texture_shader = None
+else:
+    shader = gpu.shader.from_builtin('2D_UNIFORM_COLOR')
+    texture_shader = gpu.shader.from_builtin('2D_IMAGE')
+
+Float2 = typing.Tuple[float, float]
+Float3 = typing.Tuple[float, float, float]
+Float4 = typing.Tuple[float, float, float, float]
+
+
+def text(pos2d: Float2, display_text: typing.Union[str, typing.List[str]],
+         rgba: Float4 = (1.0, 1.0, 1.0, 1.0),
+         fsize=12,
+         align='L'):
+    """Draw text with the top-left corner at 'pos2d'."""
+
+    dpi = bpy.context.preferences.system.dpi
+    gap = 12
+    x_pos, y_pos = pos2d
+    font_id = 0
+    blf.size(font_id, fsize, dpi)
+
+    # Compute the height of one line.
+    mwidth, mheight = blf.dimensions(font_id, "Tp")  # Use high and low letters.
+    mheight *= 1.5
+
+    # Split text into lines.
+    if isinstance(display_text, str):
+        mylines = display_text.split("\n")
+    else:
+        mylines = display_text
+    maxwidth = 0
+    maxheight = len(mylines) * mheight
+
+    for idx, line in enumerate(mylines):
+        text_width, text_height = blf.dimensions(font_id, line)
+        if align == 'C':
+            newx = x_pos - text_width / 2
+        elif align == 'R':
+            newx = x_pos - text_width - gap
+        else:
+            newx = x_pos
+
+        # Draw
+        blf.position(font_id, newx, y_pos - mheight * idx, 0)
+        blf.color(font_id, rgba[0], rgba[1], rgba[2], rgba[3])
+        blf.draw(font_id, " " + line)
+
+        # saves max width
+        if maxwidth < text_width:
+            maxwidth = text_width
+
+    return maxwidth, maxheight
+
+
+def aabox(v1: Float2, v2: Float2, rgba: Float4):
+    """Draw an axis-aligned box."""
+    coords = [
+        (v1[0], v1[1]),
+        (v1[0], v2[1]),
+        (v2[0], v2[1]),
+        (v2[0], v1[1]),
+    ]
+    shader.bind()
+    shader.uniform_float("color", rgba)
+
+    batch = batch_for_shader(shader, 'TRI_FAN', {"pos": coords})
+    batch.draw(shader)
+
+
+def aabox_with_texture(v1: Float2, v2: Float2):
+    """Draw an axis-aligned box with a texture."""
+    coords = [
+        (v1[0], v1[1]),
+        (v1[0], v2[1]),
+        (v2[0], v2[1]),
+        (v2[0], v1[1]),
+    ]
+    texture_shader.bind()
+    texture_shader.uniform_int("image", 0)
+
+    batch = batch_for_shader(texture_shader, 'TRI_FAN', {
+        "pos": coords,
+        "texCoord": ((0, 0), (0, 1), (1, 1), (1, 0)),
+    })
+    batch.draw(texture_shader)
+
+
+def bind_texture(texture: bpy.types.Image):
+    """Bind a Blender image to a GL texture slot."""
+    bgl.glActiveTexture(bgl.GL_TEXTURE0)
+    bgl.glBindTexture(bgl.GL_TEXTURE_2D, texture.bindcode)
+
+
+def load_texture(texture: bpy.types.Image) -> int:
+    """Load the texture, return OpenGL error code."""
+    return texture.gl_load()

blender_cloud/texture_browser/draw_27.py

@@ -0,0 +1,95 @@
+"""OpenGL drawing code for the texture browser.
+
+Requires Blender 2.79 or older.
+"""
+
+import typing
+
+import bgl
+import blf
+import bpy
+
+Float2 = typing.Tuple[float, float]
+Float3 = typing.Tuple[float, float, float]
+Float4 = typing.Tuple[float, float, float, float]
+
+
+def text(pos2d: Float2, display_text: typing.Union[str, typing.List[str]],
+         rgba: Float4 = (1.0, 1.0, 1.0, 1.0),
+         fsize=12,
+         align='L'):
+    """Draw text with the top-left corner at 'pos2d'."""
+
+    dpi = bpy.context.user_preferences.system.dpi
+    gap = 12
+    x_pos, y_pos = pos2d
+    font_id = 0
+    blf.size(font_id, fsize, dpi)
+
+    # Compute the height of one line.
+    mwidth, mheight = blf.dimensions(font_id, "Tp")  # Use high and low letters.
+    mheight *= 1.5
+
+    # Split text into lines.
+    if isinstance(display_text, str):
+        mylines = display_text.split("\n")
+    else:
+        mylines = display_text
+    maxwidth = 0
+    maxheight = len(mylines) * mheight
+
+    for idx, line in enumerate(mylines):
+        text_width, text_height = blf.dimensions(font_id, line)
+        if align == 'C':
+            newx = x_pos - text_width / 2
+        elif align == 'R':
+            newx = x_pos - text_width - gap
+        else:
+            newx = x_pos
+
+        # Draw
+        blf.position(font_id, newx, y_pos - mheight * idx, 0)
+        bgl.glColor4f(*rgba)
+        blf.draw(font_id, " " + line)
+
+        # saves max width
+        if maxwidth < text_width:
+            maxwidth = text_width
+
+    return maxwidth, maxheight
+
+
+def aabox(v1: Float2, v2: Float2, rgba: Float4):
+    """Draw an axis-aligned box."""
+
+    bgl.glColor4f(*rgba)
+    bgl.glRectf(*v1, *v2)
+
+
+def aabox_with_texture(v1: Float2, v2: Float2):
+    """Draw an axis-aligned box with a texture."""
+
+    bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
+
+    bgl.glEnable(bgl.GL_TEXTURE_2D)
+    bgl.glBegin(bgl.GL_QUADS)
+    bgl.glTexCoord2d(0, 0)
+    bgl.glVertex2d(v1[0], v1[1])
+    bgl.glTexCoord2d(0, 1)
+    bgl.glVertex2d(v1[0], v2[1])
+    bgl.glTexCoord2d(1, 1)
+    bgl.glVertex2d(v2[0], v2[1])
+    bgl.glTexCoord2d(1, 0)
+    bgl.glVertex2d(v2[0], v1[1])
+    bgl.glEnd()
+    bgl.glDisable(bgl.GL_TEXTURE_2D)
+
+
+def bind_texture(texture: bpy.types.Image):
+    """Bind a Blender image to a GL texture slot."""
+    bgl.glBindTexture(bgl.GL_TEXTURE_2D, texture.bindcode[0])
+
+
+def load_texture(texture: bpy.types.Image) -> int:
+    """Load the texture, return OpenGL error code."""
+    return texture.gl_load(filter=bgl.GL_NEAREST, mag=bgl.GL_NEAREST)

blender_cloud/texture_browser/menu_item.py

@@ -0,0 +1,192 @@
+import logging
+import os.path
+
+import bpy
+import bgl
+
+import pillarsdk
+from . import nodes
+
+if bpy.app.version < (2, 80):
+    from . import draw_27 as draw
+else:
+    from . import draw
+
+
+library_icons_path = os.path.join(os.path.dirname(__file__), "icons")
+
+ICON_WIDTH = 128
+ICON_HEIGHT = 128
+
+
+class MenuItem:
+    """GUI menu item for the 3D View GUI."""
+
+    icon_margin_x = 4
+    icon_margin_y = 4
+    text_margin_x = 6
+
+    text_size = 12
+    text_size_small = 10
+
+    DEFAULT_ICONS = {
+        'FOLDER': os.path.join(library_icons_path, 'folder.png'),
+        'SPINNER': os.path.join(library_icons_path, 'spinner.png'),
+        'ERROR': os.path.join(library_icons_path, 'error.png'),
+    }
+
+    FOLDER_NODE_TYPES = {'group_texture', 'group_hdri',
+                         nodes.UpNode.NODE_TYPE, nodes.ProjectNode.NODE_TYPE}
+    SUPPORTED_NODE_TYPES = {'texture', 'hdri'}.union(FOLDER_NODE_TYPES)
+
+    def __init__(self, node, file_desc, thumb_path: str, label_text):
+        self.log = logging.getLogger('%s.MenuItem' % __name__)
+        if node['node_type'] not in self.SUPPORTED_NODE_TYPES:
+            self.log.info('Invalid node type in node: %s', node)
+            raise TypeError('Node of type %r not supported; supported are %r.' % (
+                node['node_type'], self.SUPPORTED_NODE_TYPES))
+
+        assert isinstance(node, pillarsdk.Node), 'wrong type for node: %r' % type(node)
+        assert isinstance(node['_id'], str), 'wrong type for node["_id"]: %r' % type(node['_id'])
+        self.node = node  # pillarsdk.Node, contains 'node_type' key to indicate type
+        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
+        self.label_text = label_text
+        self.small_text = self._small_text_from_node()
+        self._thumb_path = ''
+        self.icon = None
+        self._is_folder = node['node_type'] in self.FOLDER_NODE_TYPES
+        self._is_spinning = False
+
+        # Determine sorting order.
+        # by default, sort all the way at the end and folders first.
+        self._order = 0 if self._is_folder else 10000
+        if node and node.properties and node.properties.order is not None:
+            self._order = node.properties.order
+
+        self.thumb_path = thumb_path
+
+        # Updated when drawing the image
+        self.x = 0
+        self.y = 0
+        self.width = 0
+        self.height = 0
+
+    def _small_text_from_node(self) -> str:
+        """Return the components of the texture (i.e. which map types are available)."""
+
+        if not self.node:
+            return ''
+
+        try:
+            node_files = self.node.properties.files
+        except AttributeError:
+            # Happens for nodes that don't have .properties.files.
+            return ''
+        if not node_files:
+            return ''
+
+        map_types = {f.map_type for f in node_files if f.map_type}
+        map_types.discard('color')  # all textures have colour
+        if not map_types:
+            return ''
+        return ', '.join(sorted(map_types))
+
+    def sort_key(self):
+        """Key for sorting lists of MenuItems."""
+        return self._order, self.label_text
+
+    @property
+    def thumb_path(self) -> str:
+        return self._thumb_path
+
+    @thumb_path.setter
+    def thumb_path(self, new_thumb_path: str):
+        self._is_spinning = new_thumb_path == 'SPINNER'
+
+        self._thumb_path = self.DEFAULT_ICONS.get(new_thumb_path, new_thumb_path)
+        if self._thumb_path:
+            self.icon = bpy.data.images.load(filepath=self._thumb_path)
+        else:
+            self.icon = None
+
+    @property
+    def node_uuid(self) -> str:
+        return self.node['_id']
+
+    def represents(self, node) -> bool:
+        """Returns True iff this MenuItem represents the given node."""
+
+        node_uuid = node['_id']
+        return self.node_uuid == node_uuid
+
+    def update(self, node, file_desc, thumb_path: str, label_text=None):
+        # We can get updated information about our Node, but a MenuItem should
+        # always represent one node, and it shouldn't be shared between nodes.
+        if self.node_uuid != node['_id']:
+            raise ValueError("Don't change the node ID this MenuItem reflects, "
+                             "just create a new one.")
+        self.node = node
+        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
+        self.thumb_path = thumb_path
+
+        if label_text is not None:
+            self.label_text = label_text
+
+        if thumb_path == 'ERROR':
+            self.small_text = 'This open is broken'
+        else:
+            self.small_text = self._small_text_from_node()
+
+    @property
+    def is_folder(self) -> bool:
+        return self._is_folder
+
+    @property
+    def is_spinning(self) -> bool:
+        return self._is_spinning
+
+    def update_placement(self, x, y, width, height):
+        """Use OpenGL to draw this one menu item."""
+
+        self.x = x
+        self.y = y
+        self.width = width
+        self.height = height
+
+    def draw(self, highlighted: bool):
+        bgl.glEnable(bgl.GL_BLEND)
+        if highlighted:
+            color = (0.555, 0.555, 0.555, 0.8)
+        else:
+            color = (0.447, 0.447, 0.447, 0.8)
+
+        draw.aabox((self.x, self.y), (self.x + self.width, self.y + self.height), color)
+
+        texture = self.icon
+        if texture:
+            err = draw.load_texture(texture)
+            assert not err, 'OpenGL error: %i' % err
+
+        # ------ TEXTURE ---------#
+        if texture:
+            draw.bind_texture(texture)
+        bgl.glBlendFunc(bgl.GL_SRC_ALPHA, bgl.GL_ONE_MINUS_SRC_ALPHA)
+
+        draw.aabox_with_texture(
+            (self.x + self.icon_margin_x, self.y),
+            (self.x + self.icon_margin_x + ICON_WIDTH, self.y + ICON_HEIGHT),
+        )
+        bgl.glDisable(bgl.GL_BLEND)
+
+        if texture:
+            texture.gl_free()
+
+        # draw some text
+        text_x = self.x + self.icon_margin_x + ICON_WIDTH + self.text_margin_x
+        text_y = self.y + ICON_HEIGHT * 0.5 - 0.25 * self.text_size
+        draw.text((text_x, text_y), self.label_text, fsize=self.text_size)
+        draw.text((text_x, self.y + 0.5 * self.text_size_small), self.small_text,
+                  fsize=self.text_size_small, rgba=(1.0, 1.0, 1.0, 0.5))
+
+    def hits(self, mouse_x: int, mouse_y: int) -> bool:
+        return self.x < mouse_x < self.x + self.width and self.y < mouse_y < self.y + self.height

blender_cloud/texture_browser/nodes.py

@@ -0,0 +1,26 @@
+import pillarsdk
+
+
+class SpecialFolderNode(pillarsdk.Node):
+    NODE_TYPE = 'SPECIAL'
+
+
+class UpNode(SpecialFolderNode):
+    NODE_TYPE = 'UP'
+
+    def __init__(self):
+        super().__init__()
+        self['_id'] = 'UP'
+        self['node_type'] = self.NODE_TYPE
+
+
+class ProjectNode(SpecialFolderNode):
+    NODE_TYPE = 'PROJECT'
+
+    def __init__(self, project):
+        super().__init__()
+
+        assert isinstance(project, pillarsdk.Project), 'wrong type for project: %r' % type(project)
+
+        self.merge(project.to_dict())
+        self['node_type'] = self.NODE_TYPE

blender_cloud/utils.py

@@ -16,6 +16,10 @@
 #
 # ##### END GPL LICENSE BLOCK #####
 
+import json
+import pathlib
+import typing
+
 
 def sizeof_fmt(num: int, suffix='B') -> str:
     """Returns a human-readable size.
@@ -26,6 +30,89 @@ def sizeof_fmt(num: int, suffix='B') -> str:
     for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
         if abs(num) < 1024:
             return '%.1f %s%s' % (num, unit, suffix)
-        num /= 1024
+        num //= 1024
 
     return '%.1f Yi%s' % (num, suffix)
+
+
+def find_in_path(path: pathlib.Path, filename: str) -> typing.Optional[pathlib.Path]:
+    """Performs a breadth-first search for the filename.
+
+    Returns the path that contains the file, or None if not found.
+    """
+
+    import collections
+
+    # Be lenient on our input type.
+    if isinstance(path, str):
+        path = pathlib.Path(path)
+
+    if not path.exists():
+        return None
+    assert path.is_dir()
+
+    to_visit = collections.deque([path])
+    while to_visit:
+        this_path = to_visit.popleft()
+
+        for subpath in this_path.iterdir():
+            if subpath.is_dir():
+                to_visit.append(subpath)
+                continue
+
+            if subpath.name == filename:
+                return subpath
+
+    return None
+
+
+def pyside_cache(propname):
+    """Decorator, stores the result of the decorated callable in Python-managed memory.
+
+    This is to work around the warning at
+    https://www.blender.org/api/blender_python_api_master/bpy.props.html#bpy.props.EnumProperty
+    """
+
+    if callable(propname):
+        raise TypeError('Usage: pyside_cache("property_name")')
+
+    def decorator(wrapped):
+        """Stores the result of the callable in Python-managed memory.
+
+        This is to work around the warning at
+        https://www.blender.org/api/blender_python_api_master/bpy.props.html#bpy.props.EnumProperty
+        """
+
+        import functools
+
+        @functools.wraps(wrapped)
+        # We can't use (*args, **kwargs), because EnumProperty explicitly checks
+        # for the number of fixed positional arguments.
+        def wrapper(self, context):
+            result = None
+            try:
+                result = wrapped(self, context)
+                return result
+            finally:
+                try:
+                    rna_type, rna_info = self.bl_rna.__annotations__[propname]
+                except AttributeError:
+                    rna_type, rna_info = getattr(self.bl_rna, propname)
+                rna_info['_cached_result'] = result
+        return wrapper
+    return decorator
+
+
+def redraw(self, context):
+    if context.area is None:
+        return
+    context.area.tag_redraw()
+
+
+class JSONEncoder(json.JSONEncoder):
+    """JSON encoder with support for some Blender types."""
+
+    def default(self, o):
+        if o.__class__.__name__ == 'IDPropertyGroup' and hasattr(o, 'to_dict'):
+            return o.to_dict()
+        return super().default(o)

blender_cloud/wheels/__init__.py

@@ -44,6 +44,12 @@ def load_wheel(module_name, fname_prefix):
                   module_name, module.__file__, fname_prefix)
         return
 
+    sys.path.append(wheel_filename(fname_prefix))
+    module = __import__(module_name)
+    log.debug('Loaded %s from %s', module_name, module.__file__)
+
+
+def wheel_filename(fname_prefix: str) -> str:
     path_pattern = os.path.join(my_dir, '%s*.whl' % fname_prefix)
     wheels = glob.glob(path_pattern)
     if not wheels:
@@ -51,12 +57,11 @@ def load_wheel(module_name, fname_prefix):
 
     # If there are multiple wheels that match, load the latest one.
     wheels.sort()
-    sys.path.append(wheels[-1])
-    module = __import__(module_name)
-    log.debug('Loaded %s from %s', module_name, module.__file__)
+    return wheels[-1]
 
 
 def load_wheels():
+    load_wheel('blender_asset_tracer', 'blender_asset_tracer')
     load_wheel('lockfile', 'lockfile')
     load_wheel('cachecontrol', 'CacheControl')
     load_wheel('pillarsdk', 'pillarsdk')

deploy-to-shared.sh

@@ -0,0 +1,13 @@
+#!/bin/bash -e
+
+FULLNAME="$(python3 setup.py --fullname)"
+echo "Press [ENTER] to deploy $FULLNAME to /shared"
+read dummy
+
+./clear_wheels.sh
+python3 setup.py wheels bdist
+
+DISTDIR=$(pwd)/dist
+cd /shared/software/addons
+rm -vf blender_cloud/wheels/*.whl  # remove obsolete wheel files
+unzip -o $DISTDIR/$FULLNAME.addon.zip

requirements-dev.txt

@@ -0,0 +1,8 @@
+-r requirements.txt
+
+# Primary requirements
+pytest==3.0.3
+
+# Secondary requirements
+py==1.4.31
+

requirements.txt

@@ -1,15 +1,17 @@
 # Primary requirements:
 -e git+https://github.com/sybrenstuvel/cachecontrol.git@sybren-filecache-delete-crash-fix#egg=CacheControl
 lockfile==0.12.2
-pillarsdk==1.5.0
+pillarsdk==1.8.0
 wheel==0.29.0
+blender-asset-tracer==1.2.1
 
 # Secondary requirements:
-cffi==1.6.0
-cryptography==1.3.1
-idna==2.1
+asn1crypto==0.24.0
+cffi==1.11.2
+cryptography==2.1.4
+idna==2.6
 pyasn1==0.1.9
-pycparser==2.14
-pyOpenSSL==16.0.0
+pycparser==2.18
+pyOpenSSL==17.5.0
 requests==2.10.0
-six==1.10.0
+six==1.11.0

setup.py

@@ -23,17 +23,23 @@ import shutil
 import subprocess
 import re
 import pathlib
+import zipfile
 
 from distutils import log
 from distutils.core import Command
 from distutils.command.bdist import bdist
-from distutils.command.install import install
+from distutils.command.install import install, INSTALL_SCHEMES
 from distutils.command.install_egg_info import install_egg_info
 from setuptools import setup, find_packages
 
 requirement_re = re.compile('[><=]+')
 sys.dont_write_bytecode = True
 
+# Download wheels from pypi. The specific versions are taken from requirements.txt
+wheels = [
+    'lockfile', 'pillarsdk', 'blender-asset-tracer',
+]
+
 
 def set_default_path(var, default):
     """convert CLI-arguments (string) to Paths"""
@@ -58,6 +64,7 @@ class BuildWheels(Command):
         self.wheels_path = None  # path that will contain the installed wheels.
         self.deps_path = None  # path in which dependencies are built.
         self.cachecontrol_path = None  # subdir of deps_path containing CacheControl
+        self.bat_path = None  # subdir of deps_path containing Blender-Asset-Tracer
 
     def finalize_options(self):
         self.my_path = pathlib.Path(__file__).resolve().parent
@@ -67,6 +74,7 @@ class BuildWheels(Command):
         self.deps_path = set_default_path(self.deps_path, self.my_path / 'build/deps')
         self.cachecontrol_path = set_default_path(self.cachecontrol_path,
                                                   self.deps_path / 'cachecontrol')
+        self.bat_path = self.deps_path / 'bat'
 
     def run(self):
         log.info('Storing wheels in %s', self.wheels_path)
@@ -88,16 +96,11 @@ class BuildWheels(Command):
                 # log.info('   - %s = %s / %s', package, line, line_req[-1])
 
         self.wheels_path.mkdir(parents=True, exist_ok=True)
-
-        # Download lockfile, as there is a suitable wheel on pypi.
-        if not list(self.wheels_path.glob('lockfile*.whl')):
-            log.info('Downloading lockfile wheel')
-            self.download_wheel(requirements['lockfile'])
-
-        # Download Pillar Python SDK from pypi.
-        if not list(self.wheels_path.glob('pillarsdk*.whl')):
-            log.info('Downloading Pillar Python SDK wheel')
-            self.download_wheel(requirements['pillarsdk'])
+        for package in wheels:
+            pattern = package.replace('-', '_') + '*.whl'
+            if list(self.wheels_path.glob(pattern)):
+                continue
+            self.download_wheel(requirements[package])
 
         # Build CacheControl.
         if not list(self.wheels_path.glob('CacheControl*.whl')):
@@ -120,8 +123,8 @@ class BuildWheels(Command):
         """Downloads a wheel from PyPI and saves it in self.wheels_path."""
 
         subprocess.check_call([
-            'pip', 'download',
-            '--no-deps',
+            sys.executable, '-m', 'pip',
+            'download', '--no-deps',
             '--dest', str(self.wheels_path),
             requirement[0]
         ])
@@ -162,12 +165,48 @@ class BlenderAddonBdist(bdist):
         super().initialize_options()
         self.formats = ['zip']
         self.plat_name = 'addon'  # use this instead of 'linux-x86_64' or similar.
+        self.fix_local_prefix()
+
+    def fix_local_prefix(self):
+        """Place data files in blender_cloud instead of local/blender_cloud."""
+        for key in INSTALL_SCHEMES:
+            if 'data' not in INSTALL_SCHEMES[key]:
+                continue
+            INSTALL_SCHEMES[key]['data'] = '$base'
 
     def run(self):
         self.run_command('wheels')
         super().run()
 
 
+# noinspection PyAttributeOutsideInit
+class BlenderAddonFdist(BlenderAddonBdist):
+    """Ensures that 'python setup.py fdist' creates a plain folder structure."""
+
+    user_options = [
+        ('dest-path=', None, 'addon installation path'),
+    ]
+
+    def initialize_options(self):
+        super().initialize_options()
+        self.dest_path = None  # path that will contain the addon
+
+    def run(self):
+        super().run()
+
+        # dist_files is a list of tuples ('bdist', 'any', 'filepath')
+        filepath = self.distribution.dist_files[0][2]
+
+        # if dest_path is not specified use the filename as the dest_path (minus the .zip)
+        assert filepath.endswith('.zip')
+        target_folder = self.dest_path or filepath[:-4]
+
+        print('Unzipping the package on {}.'.format(target_folder))
+
+        with zipfile.ZipFile(filepath, 'r') as zip_ref:
+            zip_ref.extractall(target_folder)
+
+
 # noinspection PyAttributeOutsideInit
 class BlenderAddonInstall(install):
     """Ensures the module is placed at the root of the zip file."""
@@ -191,17 +230,22 @@ class AvoidEggInfo(install_egg_info):
 
 setup(
     cmdclass={'bdist': BlenderAddonBdist,
+              'fdist': BlenderAddonFdist,
               'install': BlenderAddonInstall,
               'install_egg_info': AvoidEggInfo,
               'wheels': BuildWheels},
     name='blender_cloud',
     description='The Blender Cloud addon allows browsing the Blender Cloud from Blender.',
-    version='1.4.3',
+    version='1.15',
     author='Sybren A. Stüvel',
     author_email='sybren@stuvel.eu',
     packages=find_packages('.'),
-    data_files=[('blender_cloud', ['README.md']),
-                ('blender_cloud/icons', glob.glob('blender_cloud/icons/*'))],
+    data_files=[
+        ('blender_cloud', ['README.md', 'README-flamenco.md', 'CHANGELOG.md']),
+        ('blender_cloud/icons', glob.glob('blender_cloud/icons/*')),
+        ('blender_cloud/texture_browser/icons',
+         glob.glob('blender_cloud/texture_browser/icons/*'))
+    ],
     scripts=[],
     url='https://developer.blender.org/diffusion/BCA/',
     license='GNU General Public License v2 or later (GPLv2+)',

tests/test_path_replacement.py

@@ -0,0 +1,95 @@
+"""Unittests for blender_cloud.utils.
+
+This unittest requires bpy to be importable, so build Blender as a module and install it
+into your virtualenv. See https://stuvel.eu/files/bconf2016/#/10 for notes how.
+"""
+
+import datetime
+import pathlib
+import unittest.mock
+
+import pillarsdk.utils
+
+from blender_cloud.flamenco import sdk
+
+
+class PathReplacementTest(unittest.TestCase):
+    def setUp(self):
+        self.test_manager = sdk.Manager({
+            '_created': datetime.datetime(2017, 5, 31, 15, 12, 32, tzinfo=pillarsdk.utils.utc),
+            '_etag': 'c39942ee4bcc4658adcc21e4bcdfb0ae',
+            '_id': '592edd609837732a2a272c62',
+            '_updated': datetime.datetime(2017, 6, 8, 14, 51, 3, tzinfo=pillarsdk.utils.utc),
+            'description': 'Manager formerly known as "testman"',
+            'job_types': {'sleep': {'vars': {}}},
+            'name': '<script>alert("this is a manager")</script>',
+            'owner': '592edd609837732a2a272c63',
+            'path_replacement': {'job_storage': {'darwin': '/Volume/shared',
+                                                 'linux': '/shared',
+                                                 'windows': 's:/'},
+                                 'render': {'darwin': '/Volume/render/',
+                                            'linux': '/render/',
+                                            'windows': 'r:/'},
+                                 'longrender': {'darwin': '/Volume/render/long',
+                                                'linux': '/render/long',
+                                                'windows': 'r:/long'},
+                                 },
+            'projects': ['58cbdd5698377322d95eb55e'],
+            'service_account': '592edd609837732a2a272c60',
+            'stats': {'nr_of_workers': 3},
+            'url': 'http://192.168.3.101:8083/',
+            'user_groups': ['58cbdd5698377322d95eb55f'],
+            'variables': {'blender': {'darwin': '/opt/myblenderbuild/blender',
+                                      'linux': '/home/sybren/workspace/build_linux/bin/blender '
+                                               '--enable-new-depsgraph --factory-startup',
+                                      'windows': 'c:/temp/blender.exe'}}}
+        )
+
+    def test_linux(self):
+        # (expected result, input)
+        test_paths = [
+            ('/doesnotexistreally', '/doesnotexistreally'),
+            ('{render}/agent327/scenes/A_01_03_B', '/render/agent327/scenes/A_01_03_B'),
+            ('{job_storage}/render/agent327/scenes', '/shared/render/agent327/scenes'),
+            ('{longrender}/agent327/scenes', '/render/long/agent327/scenes'),
+        ]
+
+        self._do_test(test_paths, 'linux', pathlib.PurePosixPath)
+
+    def test_windows(self):
+        # (expected result, input)
+        test_paths = [
+            ('c:/doesnotexistreally', 'c:/doesnotexistreally'),
+            ('c:/some/path', r'c:\some\path'),
+            ('{render}/agent327/scenes/A_01_03_B', r'R:\agent327\scenes\A_01_03_B'),
+            ('{render}/agent327/scenes/A_01_03_B', r'r:\agent327\scenes\A_01_03_B'),
+            ('{render}/agent327/scenes/A_01_03_B', r'r:/agent327/scenes/A_01_03_B'),
+            ('{job_storage}/render/agent327/scenes', 's:/render/agent327/scenes'),
+            ('{longrender}/agent327/scenes', 'r:/long/agent327/scenes'),
+        ]
+
+        self._do_test(test_paths, 'windows', pathlib.PureWindowsPath)
+
+    def test_darwin(self):
+        # (expected result, input)
+        test_paths = [
+            ('/Volume/doesnotexistreally', '/Volume/doesnotexistreally'),
+            ('{render}/agent327/scenes/A_01_03_B', r'/Volume/render/agent327/scenes/A_01_03_B'),
+            ('{job_storage}/render/agent327/scenes', '/Volume/shared/render/agent327/scenes'),
+            ('{longrender}/agent327/scenes', '/Volume/render/long/agent327/scenes'),
+        ]
+
+        self._do_test(test_paths, 'darwin', pathlib.PurePosixPath)
+
+    def _do_test(self, test_paths, platform, pathclass):
+        self.test_manager.PurePlatformPath = pathclass
+
+        def mocked_system():
+            return platform
+
+        with unittest.mock.patch('platform.system', mocked_system):
+            for expected_result, input_path in test_paths:
+                as_path_instance = pathclass(input_path)
+                self.assertEqual(expected_result,
+                                 self.test_manager.replace_path(as_path_instance),
+                                 'for input %r on platform %s' % (as_path_instance, platform))

tests/test_utils.py

@@ -0,0 +1,25 @@
+"""Unittests for blender_cloud.utils."""
+
+import pathlib
+import unittest
+
+from blender_cloud import utils
+
+
+class FindInPathTest(unittest.TestCase):
+    def test_nonexistant_path(self):
+        path = pathlib.Path('/doesnotexistreally')
+        self.assertFalse(path.exists())
+        self.assertIsNone(utils.find_in_path(path, 'jemoeder.blend'))
+
+    def test_really_breadth_first(self):
+        """A depth-first test might find dir_a1/dir_a2/dir_a3/find_me.txt first."""
+
+        path = pathlib.Path(__file__).parent / 'test_really_breadth_first'
+        found = utils.find_in_path(path, 'find_me.txt')
+        self.assertEqual(path / 'dir_b1' / 'dir_b2' / 'find_me.txt', found)
+
+    def test_nonexistant_file(self):
+        path = pathlib.Path(__file__).parent / 'test_really_breadth_first'
+        found = utils.find_in_path(path, 'do_not_find_me.txt')
+        self.assertEqual(None, found)

update_version.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+VERSION="${1/version-}"
+
+if [ -z "$VERSION" ]; then
+    echo "Usage: $0 new-version" >&2
+    exit 1
+fi
+
+BL_INFO_VER=$(echo "$VERSION" | sed 's/\./, /g')
+
+sed "s/version='[^']*'/version='$VERSION'/" -i setup.py
+sed "s/'version': ([^)]*)/'version': ($BL_INFO_VER)/" -i blender_cloud/__init__.py
+
+git diff
+echo
+echo "Don't forget to commit and tag:"
+echo git commit -m \'Bumped version to $VERSION\' setup.py blender_cloud/__init__.py
+echo git tag -a version-$VERSION -m \'Tagged version $VERSION\'
+echo
+echo "To build a distribution ZIP:"
+echo python3 setup.py bdist