Bumped version to 1.6.3

This allows you to copy-paste a tag and edit it for the new version.

.gitignore

@@ -1,9 +1,10 @@
 *.pyc
 *.swp
-*.blend
-*.blend[1-9]
+/*.blend*
 blender_cloud/wheels/*.whl
 /textures*/
 /test_*.py
 /dist/
 /build/
+/addon-bundle/*.zip
+__pycache__

CHANGELOG.md

@@ -0,0 +1,32 @@
+# Blender Cloud changelog
+
+## 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 - Sybren A. Stüvel
+- 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`

README.md

@@ -24,6 +24,8 @@ Installing the addon
 
 * If you don't have one already, sign up for an account at
   the [Blender ID site](https://www.blender.org/id/).
+* If you had a previous version of the addon installed, deactivate it
+  and restart Blender.
 * Install and log in with the
   [Blender ID addon](https://developer.blender.org/diffusion/BIA/).
 * Install the Blender Cloud addon in Blender (User Preferences →

addon-bundle/README.txt

@@ -0,0 +1,52 @@
+Blender Cloud Addon
+===================
+
+Congratulations on downloading the Blender Cloud addon. For your
+convenience, we have bundled it with the Blender ID addon.
+
+To use the Blender Cloud addon, perform the following steps:
+
+- Use Blender (File, User Preferences, Addons, Install from file)
+  to install blender_id-x.x.x.addon.zip
+
+- If you had a previous version of the Blender Cloud addon installed,
+  restart Blender now.
+
+- Log in with your Blender ID.
+
+- Use Blender to install blender_cloud-x.x.x.addon.zip
+
+    If you don't see the addon in the list, enable the Testing
+    category.
+
+- Press Ctrl+Alt+Shift+A to start the texture browser.
+
+- Visit the User Preferences, Addons panel, to use the Blender Sync
+  feature.
+
+
+Support for Blenders not from blender.org
+-----------------------------------------
+
+Maybe you use Blender from another source than blender.org, such as an
+Ubuntu package. If that is the case, you have to make sure that the
+Python package "requests" is installed. On Ubuntu Linux this can be
+done with the command
+
+    sudo apt-get install python3-requests
+
+On other platforms & distributions this might be different.
+
+Blender uses Python 3.5, so make sure you install the package for the
+correct version of Python.
+
+
+Subscribing to the Blender Cloud
+--------------------------------
+
+The Blender Sync feature is free to use for everybody with a Blender
+ID account. In order to use the Texture Browser you need to have a
+Blender Cloud subscription. If you didn't subscribe yet, go to:
+
+    https://cloud.blender.org/join
+

addon-bundle/bundle.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+# ##### 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 #####
+
+cd $(dirname $(readlink -f $0))
+
+BCLOUD=$(ls ../dist/blender_cloud-*.addon.zip | tail -n 1)
+BID=$(ls ../../../blender-id-addon/dist/blender_id-*.addon.zip | tail -n 1)
+
+[ -z "$BCLOUD" ] && echo "BCloud addon not found" >&2
+[ -z "$BID" ] && echo "B'ID addon not found" >&2
+
+cp -va $BCLOUD $BID .
+
+BUNDLE=$(basename $BCLOUD)
+BUNDLE=${BUNDLE/.addon.zip/-bundle-UNZIP_ME_FIRST.zip}
+
+zip -9 $BUNDLE $(basename $BCLOUD) $(basename $BID) README.txt
+
+dolphin --select $BUNDLE 2>/dev/null >/dev/null & disown
+echo "CREATED: $BUNDLE"

blender_cloud/__init__.py

@@ -19,19 +19,20 @@
 # <pep8 compliant>
 
 bl_info = {
-    'name': 'Blender Cloud Texture Browser',
-    'author': 'Sybren A. Stüvel and Francesco Siddi',
-    'version': (1, 1, 0),
+    'name': 'Blender Cloud',
+    "author": "Sybren A. Stüvel, Francesco Siddi, Inês Almeida, Antony Riakiotakis",
+    'version': (1, 6, 3),
     'blender': (2, 77, 0),
-    'location': 'Ctrl+Shift+Alt+A anywhere',
-    'description': 'Allows downloading of textures from the Blender Cloud. Requires '
-                   'the Blender ID addon and Blender 2.77a or newer.',
-    'wiki_url': 'http://wiki.blender.org/index.php/Extensions:2.6/Py/'
+    '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': 'https://wiki.blender.org/index.php/Extensions:2.6/Py/'
                 'Scripts/System/BlenderCloud',
     'category': 'System',
-    'support': 'TESTING'
 }
 
+import logging
+
 # Support reloading
 if 'pillar' in locals():
     import importlib
@@ -43,16 +44,21 @@ if 'pillar' in locals():
     cache = importlib.reload(cache)
 else:
     from . import wheels
+
     wheels.load_wheels()
 
     from . import pillar, cache
 
+log = logging.getLogger(__name__)
+
 
 def register():
     """Late-loads and registers the Blender-dependent submodules."""
 
     import sys
 
+    _monkey_patch_requests()
+
     # Support reloading
     if '%s.blender' % __name__ in sys.modules:
         import importlib
@@ -63,23 +69,59 @@ def register():
             sys.modules[modname] = module
             return module
 
+        reload_mod('blendfile')
+        reload_mod('home_project')
+        reload_mod('utils')
+
         blender = reload_mod('blender')
-        gui = reload_mod('gui')
         async_loop = reload_mod('async_loop')
+        texture_browser = reload_mod('texture_browser')
+        settings_sync = reload_mod('settings_sync')
+        image_sharing = reload_mod('image_sharing')
+        attract = reload_mod('attract')
+        flamenco = reload_mod('flamenco')
     else:
-        from . import blender, gui, async_loop
+        from . import (blender, texture_browser, async_loop, settings_sync, blendfile, home_project,
+                       image_sharing, attract, flamenco)
 
     async_loop.setup_asyncio_executor()
     async_loop.register()
 
+    flamenco.register()
+    texture_browser.register()
     blender.register()
-    gui.register()
+    settings_sync.register()
+    image_sharing.register()
+    attract.register()
+
+    blender.handle_project_update()
+
+
+def _monkey_patch_requests():
+    """Monkey-patch old versions of Requests.
+
+    This is required for the Mac version of Blender 2.77a.
+    """
+
+    import requests
+
+    if requests.__build__ >= 0x020601:
+        return
+
+    log.info('Monkey-patching requests version %s', requests.__version__)
+    from requests.packages.urllib3.response import HTTPResponse
+    HTTPResponse.chunked = False
+    HTTPResponse.chunk_left = None
 
 
 def unregister():
-    from . import blender, gui, async_loop
+    from . import (blender, texture_browser, async_loop, settings_sync, image_sharing, attract,
+                   flamenco)
 
-    gui.unregister()
+    image_sharing.unregister()
+    attract.unregister()
+    settings_sync.unregister()
     blender.unregister()
+    texture_browser.unregister()
     async_loop.unregister()
-
+    flamenco.unregister()

blender_cloud/async_loop.py

@@ -1,3 +1,21 @@
+# ##### 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 #####
+
 """Manages the asyncio loop."""
 
 import asyncio
@@ -21,9 +39,18 @@ def setup_asyncio_executor():
     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':
+        # 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()
     loop.set_default_executor(executor)
     # loop.set_debug(True)
 
@@ -87,6 +114,15 @@ def ensure_async_loop():
     log.debug('Result of starting modal operator is %r', result)
 
 
+def erase_async_loop():
+    global _loop_kicking_operator_running
+
+    log.debug('Erasing async loop')
+
+    loop = asyncio.get_event_loop()
+    loop.stop()
+
+
 class AsyncLoopModalOperator(bpy.types.Operator):
     bl_idname = 'asyncio.loop'
     bl_label = 'Runs the asyncio main loop'
@@ -94,6 +130,14 @@ class AsyncLoopModalOperator(bpy.types.Operator):
     timer = None
     log = logging.getLogger(__name__ + '.AsyncLoopModalOperator')
 
+    def __del__(self):
+        global _loop_kicking_operator_running
+
+        # This can be required when the operator is running while Blender
+        # (re)loads a file. The operator then doesn't get the chance to
+        # finish the async tasks, hence stop_after_this_kick is never True.
+        _loop_kicking_operator_running = False
+
     def execute(self, context):
         return self.invoke(context, None)
 
@@ -115,6 +159,12 @@ class AsyncLoopModalOperator(bpy.types.Operator):
     def modal(self, context, event):
         global _loop_kicking_operator_running
 
+        # If _loop_kicking_operator_running is set to False, someone called
+        # erase_async_loop(). This is a signal that we really should stop
+        # running.
+        if not _loop_kicking_operator_running:
+            return {'FINISHED'}
+
         if event.type != 'TIMER':
             return {'PASS_THROUGH'}
 
@@ -130,6 +180,108 @@ class AsyncLoopModalOperator(bpy.types.Operator):
         return {'RUNNING_MODAL'}
 
 
+# noinspection PyAttributeOutsideInit
+class AsyncModalOperatorMixin:
+    async_task = None  # asyncio task for fetching thumbnails
+    signalling_future = None  # asyncio future for signalling that we want to cancel everything.
+    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.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)
+
+    def modal(self, context, event):
+        task = self.async_task
+
+        if self._state != 'EXCEPTION' and task and task.done() and not task.cancelled():
+            ex = task.exception()
+            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':
+            self._finish(context)
+            return {'FINISHED'}
+
+        return {'PASS_THROUGH'}
+
+    def _finish(self, context):
+        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):
+        """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)
+        self._stop_async_task()
+
+        # Download the previews asynchronously.
+        self.signalling_future = future or asyncio.Future()
+        self.async_task = asyncio.ensure_future(async_task)
+        self.log.debug('Created new task %r', self.async_task)
+
+        # Start the async manager so everything happens.
+        ensure_async_loop()
+
+    def _stop_async_task(self):
+        self.log.debug('Stopping async task')
+        if self.async_task is None:
+            self.log.debug('No async task, trivially stopped')
+            return
+
+        # Signal that we want to stop.
+        self.async_task.cancel()
+        if not self.signalling_future.done():
+            self.log.info("Signalling that we want to cancel anything that's running.")
+            self.signalling_future.cancel()
+
+        # Wait until the asynchronous task is done.
+        if not self.async_task.done():
+            self.log.info("blocking until async task is done.")
+            loop = asyncio.get_event_loop()
+            try:
+                loop.run_until_complete(self.async_task)
+            except asyncio.CancelledError:
+                self.log.info('Asynchronous task was cancelled')
+                return
+
+        # noinspection PyBroadException
+        try:
+            self.async_task.result()  # This re-raises any exception of the task.
+        except asyncio.CancelledError:
+            self.log.info('Asynchronous task was cancelled')
+        except Exception:
+            self.log.exception("Exception from asynchronous task")
+
+
 def register():
     bpy.utils.register_class(AsyncLoopModalOperator)
 

blender_cloud/attract/draw.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

@@ -1,29 +1,204 @@
+# ##### 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 #####
+
 """Blender-specific code.
 
 Separated from __init__.py so that we can import & run from non-Blender environments.
 """
-
+import functools
 import logging
+import os.path
 
 import bpy
-from bpy.types import AddonPreferences, Operator, WindowManager, Scene
-from bpy.props import StringProperty
+from bpy.types import AddonPreferences, Operator, WindowManager, Scene, PropertyGroup
+from bpy.props import StringProperty, EnumProperty, PointerProperty, BoolProperty, IntProperty
+import rna_prop_ui
 
-from . import pillar, gui
+from . import pillar, async_loop, flamenco
+from .utils import pyside_cache, redraw
 
-PILLAR_SERVER_URL = 'https://cloudapi.blender.org/'
-# PILLAR_SERVER_URL = 'http://localhost:5000/'
+PILLAR_WEB_SERVER_URL = 'https://cloud.blender.org/'
+# PILLAR_WEB_SERVER_URL = 'http://pillar-web:5001/'
+PILLAR_SERVER_URL = '%sapi/' % PILLAR_WEB_SERVER_URL
 
 ADDON_NAME = 'blender_cloud'
 log = logging.getLogger(__name__)
 
+icons = None
+
+
+@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:
+        return [('', 'No settings stored in your Blender Cloud', '')]
+    return [(v, v, '') for v in versions]
+
+
+class SyncStatusProperties(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.'),
+            ('SYNCING', 'SYNCING', 'Synchronising with Blender Cloud.'),
+        ],
+        name='status',
+        description='Current status of Blender Sync',
+        update=redraw)
+
+    version = EnumProperty(
+        items=blender_syncable_versions,
+        name='Version of Blender from which to pull',
+        description='Version of Blender from which to pull')
+
+    message = StringProperty(name='message', update=redraw)
+    level = EnumProperty(
+        items=[
+            ('INFO', 'INFO', ''),
+            ('WARNING', 'WARNING', ''),
+            ('ERROR', 'ERROR', ''),
+            ('SUBSCRIBE', 'SUBSCRIBE', ''),
+        ],
+        name='level',
+        update=redraw)
+
+    def report(self, level: set, message: str):
+        assert len(level) == 1, 'level should be a set of one string, not %r' % level
+        self.level = level.pop()
+        self.message = message
+
+        # Message can also be empty, just to erase it from the GUI.
+        # No need to actually log those.
+        if message:
+            try:
+                loglevel = logging._nameToLevel[self.level]
+            except KeyError:
+                loglevel = logging.WARNING
+            log.log(loglevel, message)
+
+    # List of syncable versions is stored in 'available_blender_versions' ID property,
+    # because I don't know how to store a variable list of strings in a proper RNA property.
+    @property
+    def available_blender_versions(self) -> list:
+        return self.get('available_blender_versions', [])
+
+    @available_blender_versions.setter
+    def available_blender_versions(self, new_versions):
+        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', ()))
+
+
+def handle_project_update(_=None, _2=None):
+    """Handles changing projects, which may cause extensions to be disabled/enabled.
+
+    Ignores arguments so that it can be used as property update callback.
+    """
+
+    project_id = preferences().project.project
+    log.info('Updating internal state to reflect extensions enabled on current project %s.',
+             project_id)
+
+    project_extensions.cache_clear()
+
+    from blender_cloud import attract, flamenco
+    attract.deactivate()
+    flamenco.deactivate()
+
+    enabled_for = project_extensions(project_id)
+    log.info('Project extensions: %s', enabled_for)
+    if 'attract' in enabled_for:
+        attract.activate()
+    if 'flamenco' in enabled_for:
+        flamenco.activate()
+
+
+class BlenderCloudProjectGroup(PropertyGroup):
+    status = EnumProperty(
+        items=[
+            ('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=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
+        handle_project_update()
+
 
 class BlenderCloudPreferences(AddonPreferences):
     bl_idname = ADDON_NAME
 
     # The following two properties are read-only to limit the scope of the
     # addon and allow for proper testing within this scope.
-    pillar_server = bpy.props.StringProperty(
+    pillar_server = StringProperty(
         name='Blender Cloud Server',
         description='URL of the Blender Cloud backend server',
         default=PILLAR_SERVER_URL,
@@ -31,10 +206,58 @@ 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',
+        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='//../')
+
+    flamenco_manager = PointerProperty(type=flamenco.FlamencoManagerGroup)
+    # TODO: before making Flamenco public, change the defaults to something less Institute-specific.
+    # NOTE: The assumption is that the workers can also find the files in the same path.
+    #       This assumption is true for the Blender Institute.
+    flamenco_job_file_path = StringProperty(
+        name='Job File Path',
+        description='Path where to store job files, should be accesible for Workers too',
+        subtype='DIR_PATH',
+        default='/render/_flamenco/storage')
+
+    # TODO: before making Flamenco public, change the defaults to something less Institute-specific.
+    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='/render/_flamenco/output')
+    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,
+    )
+    flamenco_open_browser_after_submit = BoolProperty(
+        name='Open Browser after Submitting Job',
+        description='When enabled, Blender will open a webbrowser',
+        default=True
+    )
+
     def draw(self, context):
         import textwrap
 
@@ -48,54 +271,211 @@ class BlenderCloudPreferences(AddonPreferences):
             blender_id_profile = None
         else:
             blender_id_profile = blender_id.get_active_profile()
-
         if blender_id is None:
-            icon = 'ERROR'
+
+            msg_icon = 'ERROR'
             text = 'This add-on requires Blender ID'
             help_text = 'Make sure that the Blender ID add-on is installed and activated'
         elif not blender_id_profile:
-            icon = 'ERROR'
+            msg_icon = 'ERROR'
             text = 'You are logged out.'
             help_text = 'To login, go to the Blender ID add-on preferences.'
-        elif pillar.SUBCLIENT_ID not in blender_id_profile.subclients:
-            icon = 'QUESTION'
+        elif bpy.app.debug and pillar.SUBCLIENT_ID not in blender_id_profile.subclients:
+            msg_icon = 'QUESTION'
             text = 'No Blender Cloud credentials.'
             help_text = ('You are logged in on Blender ID, but your credentials have not '
                          'been synchronized with Blender Cloud yet. Press the Update '
                          'Credentials button.')
         else:
-            icon = 'WORLD_DATA'
+            msg_icon = 'WORLD_DATA'
             text = 'You are logged in as %s.' % blender_id_profile.username
             help_text = ('To logout or change profile, '
                          'go to the Blender ID add-on preferences.')
 
-        sub = layout.column(align=True)
-        sub.label(text=text, icon=icon)
+        # Authentication stuff
+        auth_box = layout.box()
+        auth_box.label(text=text, icon=msg_icon)
 
         help_lines = textwrap.wrap(help_text, 80)
         for line in help_lines:
-            sub.label(text=line)
+            auth_box.label(text=line)
+        if bpy.app.debug:
+            auth_box.operator("pillar.credentials_update")
 
-        sub = layout.column()
-        sub.label(text='Local directory for downloaded textures')
+        # Texture browser stuff
+        texture_box = layout.box()
+        texture_box.enabled = msg_icon != 'ERROR'
+        sub = texture_box.column()
+        sub.label(text='Local directory for downloaded textures', icon_value=icon('CLOUD'))
         sub.prop(self, "local_texture_dir", text='Default')
         sub.prop(context.scene, "local_texture_dir", text='Current scene')
 
-        # options for Pillar
-        sub = layout.column()
-        sub.enabled = icon != 'ERROR'
+        # Blender Sync stuff
+        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'))
 
-        # TODO: let users easily pick a project. For now, we just use the
-        # hard-coded server URL and UUID of the textures project.
-        # sub.prop(self, "pillar_server")
-        # sub.prop(self, "project_uuid")
-        sub.operator("pillar.credentials_update")
+        icon_for_level = {
+            'INFO': 'NONE',
+            'WARNING': 'INFO',
+            'ERROR': 'ERROR',
+            'SUBSCRIBE': 'ERROR',
+        }
+        msg_icon = icon_for_level[bss.level] if bss.message else 'NONE'
+        message_container = row.row()
+        message_container.label(bss.message, icon=msg_icon)
+
+        sub = bsync_box.column()
+
+        if bss.level == 'SUBSCRIBE':
+            self.draw_subscribe_button(sub)
+        self.draw_sync_buttons(sub, bss)
+
+        # Image Share stuff
+        share_box = layout.box()
+        share_box.label('Image Sharing on Blender Cloud', icon_value=icon('CLOUD'))
+        share_box.prop(self, 'open_browser_after_share')
+
+        # Project selector
+        project_box = layout.box()
+        project_box.enabled = self.project.status in {'NONE', 'IDLE'}
+
+        self.draw_project_selector(project_box, self.project)
+        extensions = project_extensions(self.project.project)
+
+        # 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')
+
+    def draw_sync_buttons(self, layout, bss):
+        layout.enabled = bss.status in {'NONE', 'IDLE'}
+
+        buttons = layout.column()
+        row_buttons = buttons.row().split(percentage=0.5)
+        row_push = row_buttons.row()
+        row_pull = row_buttons.row(align=True)
+
+        row_push.operator('pillar.sync',
+                          text='Save %i.%i settings' % bpy.app.version[:2],
+                          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:
+                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,
+                                          icon='TRIA_DOWN')
+                props.action = 'PULL'
+                props.blender_version = version
+                row_pull.operator('pillar.sync',
+                                  text='',
+                                  icon='DOTSDOWN').action = 'SELECT'
+        else:
+            row_pull.label('Cloud Sync is running.')
+
+    def draw_project_selector(self, project_box, bcp: BlenderCloudProjectGroup):
+        project_row = project_box.row(align=True)
+        project_row.label('Project settings', icon_value=icon('CLOUD'))
+
+        row_buttons = project_row.row(align=True)
+
+        projects = bcp.available_projects
+        project = bcp.project
+        if bcp.status in {'NONE', 'IDLE'}:
+            if not projects or not project:
+                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')
+        else:
+            row_buttons.label('Fetching available projects.')
+
+        enabled_for = project_extensions(project)
+        if not project:
+            return
+
+        if not enabled_for:
+            project_box.label('This project is not set up for Attract or Flamenco')
+            return
+
+        project_box.label('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 Cloud project path')
+
+    def draw_flamenco_buttons(self, flamenco_box, bcp: flamenco.FlamencoManagerGroup, context):
+        header_row = flamenco_box.row(align=True)
+        header_row.label('Flamenco:', icon_value=icon('CLOUD'))
+
+        manager_box = flamenco_box.row(align=True)
+
+        if bcp.status in {'NONE', 'IDLE'}:
+            if not bcp.available_managers or not bcp.manager:
+                manager_box.operator('flamenco.managers',
+                                     text='Find Flamenco Managers',
+                                     icon='FILE_REFRESH')
+            else:
+                manager_box.prop(bcp, 'manager', text='Manager')
+                manager_box.operator('flamenco.managers',
+                                     text='',
+                                     icon='FILE_REFRESH')
+        else:
+            manager_box.label('Fetching available managers.')
+
+        path_box = flamenco_box.row(align=True)
+        path_box.prop(self, 'flamenco_job_file_path')
+        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_box = job_output_box.row(align=True)
+        path_box.prop(self, 'flamenco_job_output_path')
+        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_job_output_strip_components',
+                            text='Strip Components')
+
+        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(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('Blend file is not in your project path, '
+                           'unable to give output path example.')
+
+        flamenco_box.prop(self, 'flamenco_open_browser_after_submit')
 
 
-class PillarCredentialsUpdate(Operator):
+class PillarCredentialsUpdate(pillar.PillarOperatorMixin,
+                              Operator):
     """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)
 
     @classmethod
     def poll(cls, context):
@@ -122,7 +502,7 @@ class PillarCredentialsUpdate(Operator):
 
         try:
             loop = asyncio.get_event_loop()
-            loop.run_until_complete(pillar.refresh_pillar_credentials())
+            loop.run_until_complete(self.check_credentials(context, set()))
         except blender_id.BlenderIdCommError as ex:
             log.exception('Error sending subclient-specific token to Blender ID')
             self.report({'ERROR'}, 'Failed to sync Blender ID to Blender Cloud')
@@ -136,13 +516,146 @@ class PillarCredentialsUpdate(Operator):
         return {'FINISHED'}
 
 
+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
+
+        webbrowser.open_new_tab('https://cloud.blender.org/join')
+        self.report({'INFO'}, 'We just started a browser for you.')
+
+        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': '-_created',
+             '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': '-_created',
+             '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']))
+
+        preferences().project.available_projects = projects
+
+        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."""
+
+    bl_space_type = 'IMAGE_EDITOR'
+    bl_region_type = 'UI'
+    bl_label = 'Custom Properties'
+
+    _context_path = 'edit_image'
+    _property_type = bpy.types.Image
+
+
 def preferences() -> BlenderCloudPreferences:
     return bpy.context.user_preferences.addons[ADDON_NAME].preferences
 
 
+def load_custom_icons():
+    global icons
+
+    if icons is not None:
+        # Already loaded
+        return
+
+    import bpy.utils.previews
+    icons = bpy.utils.previews.new()
+    my_icons_dir = os.path.join(os.path.dirname(__file__), 'icons')
+    icons.load('CLOUD', os.path.join(my_icons_dir, 'icon-cloud.png'), 'IMAGE')
+
+
+def unload_custom_icons():
+    global icons
+
+    if icons is None:
+        # Already unloaded
+        return
+
+    bpy.utils.previews.remove(icons)
+    icons = None
+
+
+def icon(icon_name: str) -> int:
+    """Returns the icon ID for the named icon.
+
+    Use with layout.operator('pillar.image_share', icon_value=icon('CLOUD'))
+    """
+
+    return icons[icon_name].icon_id
+
+
 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_PT_image_custom_properties)
 
     addon_prefs = preferences()
 
@@ -162,13 +675,21 @@ def register():
         default=addon_prefs.local_texture_dir,
         update=default_if_empty)
 
+    WindowManager.blender_sync_status = PointerProperty(type=SyncStatusProperties)
+
+    load_custom_icons()
+
 
 def unregister():
-    gui.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_PT_image_custom_properties)
 
-    del WindowManager.blender_cloud_project
-    del WindowManager.blender_cloud_node
-    del WindowManager.blender_cloud_thumbnails
+    del WindowManager.last_blender_cloud_location
+    del WindowManager.blender_sync_status

blender_cloud/blendfile.py

@@ -0,0 +1,929 @@
+# ***** 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+# ***** END GPL LICENCE BLOCK *****
+#
+# (c) 2009, At Mind B.V. - Jeroen Bakker
+# (c) 2014, Blender Foundation - Campbell Barton
+
+import gzip
+import logging
+import os
+import struct
+import tempfile
+
+log = logging.getLogger("blendfile")
+
+FILE_BUFFER_SIZE = 1024 * 1024
+
+
+# -----------------------------------------------------------------------------
+# module global routines
+#
+# read routines
+# open a filename
+# determine if the file is compressed
+# and returns a handle
+def open_blend(filename, access="rb"):
+    """Opens a blend file for reading or writing pending on the access
+    supports 2 kind of blend files. Uncompressed and compressed.
+    Known issue: does not support packaged blend files
+    """
+    handle = open(filename, access)
+    magic_test = b"BLENDER"
+    magic = handle.read(len(magic_test))
+    if magic == magic_test:
+        log.debug("normal blendfile detected")
+        handle.seek(0, os.SEEK_SET)
+        bfile = BlendFile(handle)
+        bfile.is_compressed = False
+        bfile.filepath_orig = filename
+        return bfile
+    elif magic[:2] == b'\x1f\x8b':
+        log.debug("gzip blendfile detected")
+        handle.close()
+        log.debug("decompressing started")
+        fs = gzip.open(filename, "rb")
+        data = fs.read(FILE_BUFFER_SIZE)
+        magic = data[:len(magic_test)]
+        if magic == magic_test:
+            handle = tempfile.TemporaryFile()
+            while data:
+                handle.write(data)
+                data = fs.read(FILE_BUFFER_SIZE)
+            log.debug("decompressing finished")
+            fs.close()
+            log.debug("resetting decompressed file")
+            handle.seek(os.SEEK_SET, 0)
+            bfile = BlendFile(handle)
+            bfile.is_compressed = True
+            bfile.filepath_orig = filename
+            return bfile
+        else:
+            raise Exception("filetype inside gzip not a blend")
+    else:
+        raise Exception("filetype not a blend or a gzip blend")
+
+
+def pad_up_4(offset):
+    return (offset + 3) & ~3
+
+
+# -----------------------------------------------------------------------------
+# module classes
+
+
+class BlendFile:
+    """
+    Blend file.
+    """
+    __slots__ = (
+        # file (result of open())
+        "handle",
+        # str (original name of the file path)
+        "filepath_orig",
+        # BlendFileHeader
+        "header",
+        # struct.Struct
+        "block_header_struct",
+        # BlendFileBlock
+        "blocks",
+        # [DNAStruct, ...]
+        "structs",
+        # dict {b'StructName': sdna_index}
+        # (where the index is an index into 'structs')
+        "sdna_index_from_id",
+        # dict {addr_old: block}
+        "block_from_offset",
+        # int
+        "code_index",
+        # bool (did we make a change)
+        "is_modified",
+        # bool (is file gzipped)
+        "is_compressed",
+        )
+
+    def __init__(self, handle):
+        log.debug("initializing reading blend-file")
+        self.handle = handle
+        self.header = BlendFileHeader(handle)
+        self.block_header_struct = self.header.create_block_header_struct()
+        self.blocks = []
+        self.code_index = {}
+
+        block = BlendFileBlock(handle, self)
+        while block.code != b'ENDB':
+            if block.code == b'DNA1':
+                (self.structs,
+                 self.sdna_index_from_id,
+                 ) = BlendFile.decode_structs(self.header, block, handle)
+            else:
+                handle.seek(block.size, os.SEEK_CUR)
+
+            self.blocks.append(block)
+            self.code_index.setdefault(block.code, []).append(block)
+
+            block = BlendFileBlock(handle, self)
+        self.is_modified = False
+        self.blocks.append(block)
+
+        # cache (could lazy init, incase we never use?)
+        self.block_from_offset = {block.addr_old: block for block in self.blocks if block.code != b'ENDB'}
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, traceback):
+        self.close()
+
+    def find_blocks_from_code(self, code):
+        assert(type(code) == bytes)
+        if code not in self.code_index:
+            return []
+        return self.code_index[code]
+
+    def find_block_from_offset(self, offset):
+        # same as looking looping over all blocks,
+        # then checking ``block.addr_old == offset``
+        assert(type(offset) is int)
+        return self.block_from_offset.get(offset)
+
+    def close(self):
+        """
+        Close the blend file
+        writes the blend file to disk if changes has happened
+        """
+        handle = self.handle
+
+        if self.is_modified:
+            if self.is_compressed:
+                log.debug("close compressed blend file")
+                handle.seek(os.SEEK_SET, 0)
+                log.debug("compressing started")
+                fs = gzip.open(self.filepath_orig, "wb")
+                data = handle.read(FILE_BUFFER_SIZE)
+                while data:
+                    fs.write(data)
+                    data = handle.read(FILE_BUFFER_SIZE)
+                fs.close()
+                log.debug("compressing finished")
+
+        handle.close()
+
+    def ensure_subtype_smaller(self, sdna_index_curr, sdna_index_next):
+        # never refine to a smaller type
+        if (self.structs[sdna_index_curr].size >
+            self.structs[sdna_index_next].size):
+
+            raise RuntimeError("cant refine to smaller type (%s -> %s)" %
+                               (self.structs[sdna_index_curr].dna_type_id.decode('ascii'),
+                                self.structs[sdna_index_next].dna_type_id.decode('ascii')))
+
+    @staticmethod
+    def decode_structs(header, block, handle):
+        """
+        DNACatalog is a catalog of all information in the DNA1 file-block
+        """
+        log.debug("building DNA catalog")
+        shortstruct = DNA_IO.USHORT[header.endian_index]
+        shortstruct2 = struct.Struct(header.endian_str + b'HH')
+        intstruct = DNA_IO.UINT[header.endian_index]
+
+        data = handle.read(block.size)
+        types = []
+        names = []
+
+        structs = []
+        sdna_index_from_id = {}
+
+        offset = 8
+        names_len = intstruct.unpack_from(data, offset)[0]
+        offset += 4
+
+        log.debug("building #%d names" % names_len)
+        for i in range(names_len):
+            tName = DNA_IO.read_data0_offset(data, offset)
+            offset = offset + len(tName) + 1
+            names.append(DNAName(tName))
+        del names_len
+
+        offset = pad_up_4(offset)
+        offset += 4
+        types_len = intstruct.unpack_from(data, offset)[0]
+        offset += 4
+        log.debug("building #%d types" % types_len)
+        for i in range(types_len):
+            dna_type_id = DNA_IO.read_data0_offset(data, offset)
+            # None will be replaced by the DNAStruct, below
+            types.append(DNAStruct(dna_type_id))
+            offset += len(dna_type_id) + 1
+
+        offset = pad_up_4(offset)
+        offset += 4
+        log.debug("building #%d type-lengths" % types_len)
+        for i in range(types_len):
+            tLen = shortstruct.unpack_from(data, offset)[0]
+            offset = offset + 2
+            types[i].size = tLen
+        del types_len
+
+        offset = pad_up_4(offset)
+        offset += 4
+
+        structs_len = intstruct.unpack_from(data, offset)[0]
+        offset += 4
+        log.debug("building #%d structures" % structs_len)
+        for sdna_index in range(structs_len):
+            d = shortstruct2.unpack_from(data, offset)
+            struct_type_index = d[0]
+            offset += 4
+            dna_struct = types[struct_type_index]
+            sdna_index_from_id[dna_struct.dna_type_id] = sdna_index
+            structs.append(dna_struct)
+
+            fields_len = d[1]
+            dna_offset = 0
+
+            for field_index in range(fields_len):
+                d2 = shortstruct2.unpack_from(data, offset)
+                field_type_index = d2[0]
+                field_name_index = d2[1]
+                offset += 4
+                dna_type = types[field_type_index]
+                dna_name = names[field_name_index]
+                if dna_name.is_pointer or dna_name.is_method_pointer:
+                    dna_size = header.pointer_size * dna_name.array_size
+                else:
+                    dna_size = dna_type.size * dna_name.array_size
+
+                field = DNAField(dna_type, dna_name, dna_size, dna_offset)
+                dna_struct.fields.append(field)
+                dna_struct.field_from_name[dna_name.name_only] = field
+                dna_offset += dna_size
+
+        return structs, sdna_index_from_id
+
+
+class BlendFileBlock:
+    """
+    Instance of a struct.
+    """
+    __slots__ = (
+        # BlendFile
+        "file",
+        "code",
+        "size",
+        "addr_old",
+        "sdna_index",
+        "count",
+        "file_offset",
+        "user_data",
+        )
+
+    def __str__(self):
+        return ("<%s.%s (%s), size=%d at %s>" %
+                # fields=[%s]
+                (self.__class__.__name__,
+                 self.dna_type.dna_type_id.decode('ascii'),
+                 self.code.decode(),
+                 self.size,
+                 # b", ".join(f.dna_name.name_only for f in self.dna_type.fields).decode('ascii'),
+                 hex(self.addr_old),
+                 ))
+
+    def __init__(self, handle, bfile):
+        OLDBLOCK = struct.Struct(b'4sI')
+
+        self.file = bfile
+        self.user_data = None
+
+        data = handle.read(bfile.block_header_struct.size)
+        # header size can be 8, 20, or 24 bytes long
+        # 8: old blend files ENDB block (exception)
+        # 20: normal headers 32 bit platform
+        # 24: normal headers 64 bit platform
+        if len(data) > 15:
+
+            blockheader = bfile.block_header_struct.unpack(data)
+            self.code = blockheader[0].partition(b'\0')[0]
+            if self.code != b'ENDB':
+                self.size = blockheader[1]
+                self.addr_old = blockheader[2]
+                self.sdna_index = blockheader[3]
+                self.count = blockheader[4]
+                self.file_offset = handle.tell()
+            else:
+                self.size = 0
+                self.addr_old = 0
+                self.sdna_index = 0
+                self.count = 0
+                self.file_offset = 0
+        else:
+            blockheader = OLDBLOCK.unpack(data)
+            self.code = blockheader[0].partition(b'\0')[0]
+            self.code = DNA_IO.read_data0(blockheader[0])
+            self.size = 0
+            self.addr_old = 0
+            self.sdna_index = 0
+            self.count = 0
+            self.file_offset = 0
+
+    @property
+    def dna_type(self):
+        return self.file.structs[self.sdna_index]
+
+    def refine_type_from_index(self, sdna_index_next):
+        assert(type(sdna_index_next) is int)
+        sdna_index_curr = self.sdna_index
+        self.file.ensure_subtype_smaller(sdna_index_curr, sdna_index_next)
+        self.sdna_index = sdna_index_next
+
+    def refine_type(self, dna_type_id):
+        assert(type(dna_type_id) is bytes)
+        self.refine_type_from_index(self.file.sdna_index_from_id[dna_type_id])
+
+    def get_file_offset(self, path,
+            default=...,
+            sdna_index_refine=None,
+            base_index=0,
+            ):
+        """
+        Return (offset, length)
+        """
+        assert(type(path) is bytes)
+
+        ofs = self.file_offset
+        if base_index != 0:
+            assert(base_index < self.count)
+            ofs += (self.size // self.count) * base_index
+        self.file.handle.seek(ofs, os.SEEK_SET)
+
+        if sdna_index_refine is None:
+            sdna_index_refine = self.sdna_index
+        else:
+            self.file.ensure_subtype_smaller(self.sdna_index, sdna_index_refine)
+
+        dna_struct = self.file.structs[sdna_index_refine]
+        field = dna_struct.field_from_path(
+                self.file.header, self.file.handle, path)
+
+        return (self.file.handle.tell(), field.dna_name.array_size)
+
+    def get(self, path,
+            default=...,
+            sdna_index_refine=None,
+            use_nil=True, use_str=True,
+            base_index=0,
+            ):
+
+        ofs = self.file_offset
+        if base_index != 0:
+            assert(base_index < self.count)
+            ofs += (self.size // self.count) * base_index
+        self.file.handle.seek(ofs, os.SEEK_SET)
+
+        if sdna_index_refine is None:
+            sdna_index_refine = self.sdna_index
+        else:
+            self.file.ensure_subtype_smaller(self.sdna_index, sdna_index_refine)
+
+        dna_struct = self.file.structs[sdna_index_refine]
+        return dna_struct.field_get(
+                self.file.header, self.file.handle, path,
+                default=default,
+                use_nil=use_nil, use_str=use_str,
+                )
+
+    def get_recursive_iter(self, path, path_root=b"",
+                           default=...,
+                           sdna_index_refine=None,
+                           use_nil=True, use_str=True,
+                           base_index=0,
+                           ):
+        if path_root:
+            path_full = (
+                    (path_root if type(path_root) is tuple else (path_root, )) +
+                    (path if type(path) is tuple else (path, )))
+        else:
+            path_full = path
+
+        try:
+            yield (path_full, self.get(path_full, default, sdna_index_refine, use_nil, use_str, base_index))
+        except NotImplementedError as ex:
+            msg, dna_name, dna_type = ex.args
+            struct_index = self.file.sdna_index_from_id.get(dna_type.dna_type_id, None)
+            if struct_index is None:
+                yield (path_full, "<%s>" % dna_type.dna_type_id.decode('ascii'))
+            else:
+                struct = self.file.structs[struct_index]
+                for f in struct.fields:
+                    yield from self.get_recursive_iter(
+                            f.dna_name.name_only, path_full, default, None, use_nil, use_str, 0)
+
+    def items_recursive_iter(self):
+        for k in self.keys():
+            yield from self.get_recursive_iter(k, use_str=False)
+
+    def get_data_hash(self):
+        """
+        Generates a 'hash' that can be used instead of addr_old as block id, and that should be 'stable' across .blend
+        file load & save (i.e. it does not changes due to pointer addresses variations).
+        """
+        # TODO This implementation is most likely far from optimal... and CRC32 is not renown as the best hashing
+        #      algo either. But for now does the job!
+        import zlib
+        def _is_pointer(self, k):
+            return self.file.structs[self.sdna_index].field_from_path(
+                    self.file.header, self.file.handle, k).dna_name.is_pointer
+
+        hsh = 1
+        for k, v in self.items_recursive_iter():
+            if not _is_pointer(self, k):
+                hsh = zlib.adler32(str(v).encode(), hsh)
+        return hsh
+
+    def set(self, path, value,
+            sdna_index_refine=None,
+            ):
+
+        if sdna_index_refine is None:
+            sdna_index_refine = self.sdna_index
+        else:
+            self.file.ensure_subtype_smaller(self.sdna_index, sdna_index_refine)
+
+        dna_struct = self.file.structs[sdna_index_refine]
+        self.file.handle.seek(self.file_offset, os.SEEK_SET)
+        self.file.is_modified = True
+        return dna_struct.field_set(
+                self.file.header, self.file.handle, path, value)
+
+    # ---------------
+    # Utility get/set
+    #
+    #   avoid inline pointer casting
+    def get_pointer(
+            self, path,
+            default=...,
+            sdna_index_refine=None,
+            base_index=0,
+            ):
+        if sdna_index_refine is None:
+            sdna_index_refine = self.sdna_index
+        result = self.get(path, default, sdna_index_refine=sdna_index_refine, base_index=base_index)
+
+        # default
+        if type(result) is not int:
+            return result
+
+        assert(self.file.structs[sdna_index_refine].field_from_path(
+                self.file.header, self.file.handle, path).dna_name.is_pointer)
+        if result != 0:
+            # possible (but unlikely)
+            # that this fails and returns None
+            # maybe we want to raise some exception in this case
+            return self.file.find_block_from_offset(result)
+        else:
+            return None
+
+    # ----------------------
+    # Python convenience API
+
+    # dict like access
+    def __getitem__(self, item):
+        return self.get(item, use_str=False)
+
+    def __setitem__(self, item, value):
+        self.set(item, value)
+
+    def keys(self):
+        return (f.dna_name.name_only for f in self.dna_type.fields)
+
+    def values(self):
+        for k in self.keys():
+            try:
+                yield self[k]
+            except NotImplementedError as ex:
+                msg, dna_name, dna_type = ex.args
+                yield "<%s>" % dna_type.dna_type_id.decode('ascii')
+
+    def items(self):
+        for k in self.keys():
+            try:
+                yield (k, self[k])
+            except NotImplementedError as ex:
+                msg, dna_name, dna_type = ex.args
+                yield (k, "<%s>" % dna_type.dna_type_id.decode('ascii'))
+
+
+# -----------------------------------------------------------------------------
+# Read Magic
+#
+# magic = str
+# pointer_size = int
+# is_little_endian = bool
+# version = int
+
+
+class BlendFileHeader:
+    """
+    BlendFileHeader allocates the first 12 bytes of a blend file
+    it contains information about the hardware architecture
+    """
+    __slots__ = (
+        # str
+        "magic",
+        # int 4/8
+        "pointer_size",
+        # bool
+        "is_little_endian",
+        # int
+        "version",
+        # str, used to pass to 'struct'
+        "endian_str",
+        # int, used to index common types
+        "endian_index",
+        )
+
+    def __init__(self, handle):
+        FILEHEADER = struct.Struct(b'7s1s1s3s')
+
+        log.debug("reading blend-file-header")
+        values = FILEHEADER.unpack(handle.read(FILEHEADER.size))
+        self.magic = values[0]
+        pointer_size_id = values[1]
+        if pointer_size_id == b'-':
+            self.pointer_size = 8
+        elif pointer_size_id == b'_':
+            self.pointer_size = 4
+        else:
+            assert(0)
+        endian_id = values[2]
+        if endian_id == b'v':
+            self.is_little_endian = True
+            self.endian_str = b'<'
+            self.endian_index = 0
+        elif endian_id == b'V':
+            self.is_little_endian = False
+            self.endian_index = 1
+            self.endian_str = b'>'
+        else:
+            assert(0)
+
+        version_id = values[3]
+        self.version = int(version_id)
+
+    def create_block_header_struct(self):
+        return struct.Struct(b''.join((
+                self.endian_str,
+                b'4sI',
+                b'I' if self.pointer_size == 4 else b'Q',
+                b'II',
+                )))
+
+
+class DNAName:
+    """
+    DNAName is a C-type name stored in the DNA
+    """
+    __slots__ = (
+        "name_full",
+        "name_only",
+        "is_pointer",
+        "is_method_pointer",
+        "array_size",
+        )
+
+    def __init__(self, name_full):
+        self.name_full = name_full
+        self.name_only = self.calc_name_only()
+        self.is_pointer = self.calc_is_pointer()
+        self.is_method_pointer = self.calc_is_method_pointer()
+        self.array_size = self.calc_array_size()
+
+    def __repr__(self):
+        return '%s(%r)' % (type(self).__qualname__, self.name_full)
+
+    def as_reference(self, parent):
+        if parent is None:
+            result = b''
+        else:
+            result = parent + b'.'
+
+        result = result + self.name_only
+        return result
+
+    def calc_name_only(self):
+        result = self.name_full.strip(b'*()')
+        index = result.find(b'[')
+        if index != -1:
+            result = result[:index]
+        return result
+
+    def calc_is_pointer(self):
+        return (b'*' in self.name_full)
+
+    def calc_is_method_pointer(self):
+        return (b'(*' in self.name_full)
+
+    def calc_array_size(self):
+        result = 1
+        temp = self.name_full
+        index = temp.find(b'[')
+
+        while index != -1:
+            index_2 = temp.find(b']')
+            result *= int(temp[index + 1:index_2])
+            temp = temp[index_2 + 1:]
+            index = temp.find(b'[')
+
+        return result
+
+
+class DNAField:
+    """
+    DNAField is a coupled DNAStruct and DNAName
+    and cache offset for reuse
+    """
+    __slots__ = (
+        # DNAName
+        "dna_name",
+        # tuple of 3 items
+        # [bytes (struct name), int (struct size), DNAStruct]
+        "dna_type",
+        # size on-disk
+        "dna_size",
+        # cached info (avoid looping over fields each time)
+        "dna_offset",
+        )
+
+    def __init__(self, dna_type, dna_name, dna_size, dna_offset):
+        self.dna_type = dna_type
+        self.dna_name = dna_name
+        self.dna_size = dna_size
+        self.dna_offset = dna_offset
+
+
+class DNAStruct:
+    """
+    DNAStruct is a C-type structure stored in the DNA
+    """
+    __slots__ = (
+        "dna_type_id",
+        "size",
+        "fields",
+        "field_from_name",
+        "user_data",
+        )
+
+    def __init__(self, dna_type_id):
+        self.dna_type_id = dna_type_id
+        self.fields = []
+        self.field_from_name = {}
+        self.user_data = None
+
+    def __repr__(self):
+        return '%s(%r)' % (type(self).__qualname__, self.dna_type_id)
+
+    def field_from_path(self, header, handle, path):
+        """
+        Support lookups as bytes or a tuple of bytes and optional index.
+
+        C style 'id.name'   -->  (b'id', b'name')
+        C style 'array[4]'  -->  ('array', 4)
+        """
+        if type(path) is tuple:
+            name = path[0]
+            if len(path) >= 2 and type(path[1]) is not bytes:
+                name_tail = path[2:]
+                index = path[1]
+                assert(type(index) is int)
+            else:
+                name_tail = path[1:]
+                index = 0
+        else:
+            name = path
+            name_tail = None
+            index = 0
+
+        assert(type(name) is bytes)
+
+        field = self.field_from_name.get(name)
+
+        if field is not None:
+            handle.seek(field.dna_offset, os.SEEK_CUR)
+            if index != 0:
+                if field.dna_name.is_pointer:
+                    index_offset = header.pointer_size * index
+                else:
+                    index_offset = field.dna_type.size * index
+                assert(index_offset < field.dna_size)
+                handle.seek(index_offset, os.SEEK_CUR)
+            if not name_tail:  # None or ()
+                return field
+            else:
+                return field.dna_type.field_from_path(header, handle, name_tail)
+
+    def field_get(self, header, handle, path,
+                  default=...,
+                  use_nil=True, use_str=True,
+                  ):
+        field = self.field_from_path(header, handle, path)
+        if field is None:
+            if default is not ...:
+                return default
+            else:
+                raise KeyError("%r not found in %r (%r)" %
+                        (path, [f.dna_name.name_only for f in self.fields], self.dna_type_id))
+
+        dna_type = field.dna_type
+        dna_name = field.dna_name
+
+        if dna_name.is_pointer:
+            return DNA_IO.read_pointer(handle, header)
+        elif dna_type.dna_type_id == b'int':
+            if dna_name.array_size > 1:
+                return [DNA_IO.read_int(handle, header) for i in range(dna_name.array_size)]
+            return DNA_IO.read_int(handle, header)
+        elif dna_type.dna_type_id == b'short':
+            if dna_name.array_size > 1:
+                return [DNA_IO.read_short(handle, header) for i in range(dna_name.array_size)]
+            return DNA_IO.read_short(handle, header)
+        elif dna_type.dna_type_id == b'uint64_t':
+            if dna_name.array_size > 1:
+                return [DNA_IO.read_ulong(handle, header) for i in range(dna_name.array_size)]
+            return DNA_IO.read_ulong(handle, header)
+        elif dna_type.dna_type_id == b'float':
+            if dna_name.array_size > 1:
+                return [DNA_IO.read_float(handle, header) for i in range(dna_name.array_size)]
+            return DNA_IO.read_float(handle, header)
+        elif dna_type.dna_type_id == b'char':
+            if use_str:
+                if use_nil:
+                    return DNA_IO.read_string0(handle, dna_name.array_size)
+                else:
+                    return DNA_IO.read_string(handle, dna_name.array_size)
+            else:
+                if use_nil:
+                    return DNA_IO.read_bytes0(handle, dna_name.array_size)
+                else:
+                    return DNA_IO.read_bytes(handle, dna_name.array_size)
+        else:
+            raise NotImplementedError("%r exists but isn't pointer, can't resolve field %r" %
+                    (path, dna_name.name_only), dna_name, dna_type)
+
+    def field_set(self, header, handle, path, value):
+        assert(type(path) == bytes)
+
+        field = self.field_from_path(header, handle, path)
+        if field is None:
+            raise KeyError("%r not found in %r" %
+                    (path, [f.dna_name.name_only for f in self.fields]))
+
+        dna_type = field.dna_type
+        dna_name = field.dna_name
+
+        if dna_type.dna_type_id == b'char':
+            if type(value) is str:
+                return DNA_IO.write_string(handle, value, dna_name.array_size)
+            else:
+                return DNA_IO.write_bytes(handle, value, dna_name.array_size)
+        elif dna_type.dna_type_id == b'int':
+            DNA_IO.write_int(handle, header, value)
+        else:
+            raise NotImplementedError("Setting %r is not yet supported for %r" %
+                                      (dna_type, dna_name), dna_name, dna_type)
+
+
+class DNA_IO:
+    """
+    Module like class, for read-write utility functions.
+
+    Only stores static methods & constants.
+    """
+
+    __slots__ = ()
+
+    def __new__(cls, *args, **kwargs):
+        raise RuntimeError("%s should not be instantiated" % cls)
+
+    @staticmethod
+    def write_string(handle, astring, fieldlen):
+        assert(isinstance(astring, str))
+        if len(astring) >= fieldlen:
+            stringw = astring[0:fieldlen]
+        else:
+            stringw = astring + '\0'
+        handle.write(stringw.encode('utf-8'))
+
+    @staticmethod
+    def write_bytes(handle, astring, fieldlen):
+        assert(isinstance(astring, (bytes, bytearray)))
+        if len(astring) >= fieldlen:
+            stringw = astring[0:fieldlen]
+        else:
+            stringw = astring + b'\0'
+
+        handle.write(stringw)
+
+    @staticmethod
+    def read_bytes(handle, length):
+        data = handle.read(length)
+        return data
+
+    @staticmethod
+    def read_bytes0(handle, length):
+        data = handle.read(length)
+        return DNA_IO.read_data0(data)
+
+    @staticmethod
+    def read_string(handle, length):
+        return DNA_IO.read_bytes(handle, length).decode('utf-8')
+
+    @staticmethod
+    def read_string0(handle, length):
+        return DNA_IO.read_bytes0(handle, length).decode('utf-8')
+
+    @staticmethod
+    def read_data0_offset(data, offset):
+        add = data.find(b'\0', offset) - offset
+        return data[offset:offset + add]
+
+    @staticmethod
+    def read_data0(data):
+        add = data.find(b'\0')
+        return data[:add]
+
+    USHORT = struct.Struct(b'<H'), struct.Struct(b'>H')
+
+    @staticmethod
+    def read_ushort(handle, fileheader):
+        st = DNA_IO.USHORT[fileheader.endian_index]
+        return st.unpack(handle.read(st.size))[0]
+
+    SSHORT = struct.Struct(b'<h'), struct.Struct(b'>h')
+
+    @staticmethod
+    def read_short(handle, fileheader):
+        st = DNA_IO.SSHORT[fileheader.endian_index]
+        return st.unpack(handle.read(st.size))[0]
+
+    UINT = struct.Struct(b'<I'), struct.Struct(b'>I')
+
+    @staticmethod
+    def read_uint(handle, fileheader):
+        st = DNA_IO.UINT[fileheader.endian_index]
+        return st.unpack(handle.read(st.size))[0]
+
+    SINT = struct.Struct(b'<i'), struct.Struct(b'>i')
+
+    @staticmethod
+    def read_int(handle, fileheader):
+        st = DNA_IO.SINT[fileheader.endian_index]
+        return st.unpack(handle.read(st.size))[0]
+
+    @staticmethod
+    def write_int(handle, fileheader, value):
+        assert isinstance(value, int), 'value must be int, but is %r: %r' % (type(value), value)
+        st = DNA_IO.SINT[fileheader.endian_index]
+        to_write = st.pack(value)
+        handle.write(to_write)
+
+    FLOAT = struct.Struct(b'<f'), struct.Struct(b'>f')
+
+    @staticmethod
+    def read_float(handle, fileheader):
+        st = DNA_IO.FLOAT[fileheader.endian_index]
+        return st.unpack(handle.read(st.size))[0]
+
+    ULONG = struct.Struct(b'<Q'), struct.Struct(b'>Q')
+
+    @staticmethod
+    def read_ulong(handle, fileheader):
+        st = DNA_IO.ULONG[fileheader.endian_index]
+        return st.unpack(handle.read(st.size))[0]
+
+    @staticmethod
+    def read_pointer(handle, header):
+        """
+        reads an pointer from a file handle
+        the pointer size is given by the header (BlendFileHeader)
+        """
+        if header.pointer_size == 4:
+            st = DNA_IO.UINT[header.endian_index]
+            return st.unpack(handle.read(st.size))[0]
+        if header.pointer_size == 8:
+            st = DNA_IO.ULONG[header.endian_index]
+            return st.unpack(handle.read(st.size))[0]

blender_cloud/cache.py

@@ -1,3 +1,21 @@
+# ##### 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 #####
+
 """HTTP Cache management.
 
 This module configures a cached session for the Requests package.

blender_cloud/flamenco/__init__.py

@@ -0,0 +1,692 @@
+# ##### 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 #####
+
+"""Flamenco interface.
+
+The preferences are managed blender.py, the rest of the Flamenco-specific stuff is here.
+"""
+import functools
+import logging
+from pathlib import Path, PurePath
+import typing
+
+import bpy
+from bpy.types import AddonPreferences, Operator, WindowManager, Scene, PropertyGroup
+from bpy.props import StringProperty, EnumProperty, PointerProperty, BoolProperty, IntProperty
+
+from .. import async_loop, pillar
+from ..utils import pyside_cache, redraw
+
+log = logging.getLogger(__name__)
+
+# Global flag used to determine whether panels etc. can be drawn.
+flamenco_is_active = False
+
+
+@pyside_cache('manager')
+def available_managers(self, context):
+    """Returns the list of items used by a manager-selector EnumProperty."""
+
+    from ..blender import preferences
+
+    mngrs = preferences().flamenco_manager.available_managers
+    if not mngrs:
+        return [('', 'No managers available in your Blender Cloud', '')]
+    return [(p['_id'], p['name'], '') for p in mngrs]
+
+
+class FlamencoManagerGroup(PropertyGroup):
+    manager = EnumProperty(
+        items=available_managers,
+        name='Flamenco Manager',
+        description='Which Flamenco Manager to use for jobs')
+
+    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 Flamenco managers from Blender Cloud'),
+        ],
+        name='status',
+        update=redraw)
+
+    # List of managers is stored in 'available_managers' ID property,
+    # because I don't know how to store a variable list of strings in a proper RNA property.
+    @property
+    def available_managers(self) -> list:
+        return self.get('available_managers', [])
+
+    @available_managers.setter
+    def available_managers(self, new_managers):
+        self['available_managers'] = new_managers
+
+
+class FlamencoPollMixin:
+    @classmethod
+    def poll(cls, context):
+        return flamenco_is_active
+
+
+class FLAMENCO_OT_fmanagers(async_loop.AsyncModalOperatorMixin,
+                            pillar.AuthenticatedPillarOperatorMixin,
+                            FlamencoPollMixin,
+                            Operator):
+    """Fetches the Flamenco Managers available to the user"""
+    bl_idname = 'flamenco.managers'
+    bl_label = 'Fetch available Flamenco Managers'
+
+    stop_upon_exception = True
+    log = logging.getLogger('%s.FLAMENCO_OT_fmanagers' % __name__)
+
+    @property
+    def mypref(self) -> FlamencoManagerGroup:
+        from ..blender import preferences
+
+        return preferences().flamenco_manager
+
+    async def async_execute(self, context):
+        if not await self.authenticate(context):
+            return
+
+        from .sdk import Manager
+        from ..pillar import pillar_call
+
+        self.log.info('Going to fetch managers for user %s', self.user_id)
+
+        self.mypref.status = 'FETCHING'
+        managers = await pillar_call(Manager.all)
+
+        # We need to convert to regular dicts before storing in ID properties.
+        # Also don't store more properties than we need.
+        as_list = [{'_id': p['_id'], 'name': p['name']} for p in managers['_items']]
+
+        self.mypref.available_managers = as_list
+        self.quit()
+
+    def quit(self):
+        self.mypref.status = 'IDLE'
+        super().quit()
+
+
+class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
+                         pillar.AuthenticatedPillarOperatorMixin,
+                         FlamencoPollMixin,
+                         Operator):
+    """Performs a Blender render on Flamenco."""
+    bl_idname = 'flamenco.render'
+    bl_label = 'Render on Flamenco'
+    bl_description = __doc__.rstrip('.')
+
+    stop_upon_exception = True
+    log = logging.getLogger('%s.FLAMENCO_OT_render' % __name__)
+
+    async def async_execute(self, context):
+        if not await self.authenticate(context):
+            return
+
+        from ..blender import preferences
+
+        scene = context.scene
+
+        # Save to a different file, specifically for Flamenco.
+        context.window_manager.flamenco_status = 'PACKING'
+        filepath = await self._save_blendfile(context)
+
+        # Determine where the render output will be stored.
+        render_output = render_output_path(context, filepath)
+        if render_output is None:
+            self.report({'ERROR'}, 'Current file is outside of project path.')
+            self.quit()
+            return
+        self.log.info('Will output render files to %s', render_output)
+
+        # BAM-pack the files to the destination directory.
+        outfile, missing_sources = await self.bam_pack(filepath)
+        if not outfile:
+            return
+
+        # Create the job at Flamenco Server.
+        prefs = preferences()
+
+        context.window_manager.flamenco_status = 'COMMUNICATING'
+        settings = {'blender_cmd': '{blender}',
+                    'chunk_size': scene.flamenco_render_fchunk_size,
+                    'filepath': str(outfile),
+                    'frames': scene.flamenco_render_frame_range,
+                    'render_output': str(render_output),
+                    }
+
+        # Add extra settings specific to the job type
+        if scene.flamenco_render_job_type == 'blender-render-progressive':
+            if scene.cycles.progressive == 'BRANCHED_PATH':
+                samples = scene.cycles.aa_samples
+            else:
+                samples = scene.cycles.samples
+
+            if scene.cycles.use_square_samples:
+                samples **= 2
+
+            settings['cycles_num_chunks'] = scene.flamenco_render_schunk_count
+            settings['cycles_sample_count'] = samples
+            settings['format'] = 'EXR'
+
+        try:
+            job_info = await create_job(self.user_id,
+                                        prefs.project.project,
+                                        prefs.flamenco_manager.manager,
+                                        scene.flamenco_render_job_type,
+                                        settings,
+                                        'Render %s' % filepath.name,
+                                        priority=scene.flamenco_render_job_priority)
+        except Exception as ex:
+            self.report({'ERROR'}, 'Error creating Flamenco job: %s' % ex)
+            self.quit()
+            return
+
+        # Store the job ID in a file in the output dir.
+        with open(str(outfile.parent / 'jobinfo.json'), 'w', encoding='utf8') as outfile:
+            import json
+
+            job_info['missing_files'] = [str(mf) for mf in missing_sources]
+            json.dump(job_info, outfile, sort_keys=True, indent=4)
+
+        # We can now remove the local copy we made with bpy.ops.wm.save_as_mainfile().
+        # Strictly speaking we can already remove it after the BAM-pack, but it may come in
+        # handy in case of failures.
+        try:
+            self.log.info('Removing temporary file %s', filepath)
+            filepath.unlink()
+        except Exception as ex:
+            self.report({'ERROR'}, 'Unable to remove file: %s' % ex)
+            self.quit()
+            return
+
+        if prefs.flamenco_open_browser_after_submit:
+            import webbrowser
+            from urllib.parse import urljoin
+            from ..blender import PILLAR_WEB_SERVER_URL
+
+            url = urljoin(PILLAR_WEB_SERVER_URL, '/flamenco/jobs/%s/redir' % job_info['_id'])
+            webbrowser.open_new_tab(url)
+
+        # Do a final report.
+        if missing_sources:
+            names = (ms.name for ms in missing_sources)
+            self.report({'WARNING'}, 'Flamenco job created with missing files: %s' %
+                        '; '.join(names))
+        else:
+            self.report({'INFO'}, 'Flamenco job created.')
+
+        self.quit()
+
+    async def _save_blendfile(self, context):
+        """Save to a different file, specifically for Flamenco.
+
+        We shouldn't overwrite the artist's file.
+        We can compress, since this file won't be managed by SVN and doesn't need diffability.
+        """
+
+        render = context.scene.render
+
+        # Remember settings we need to restore after saving.
+        old_use_file_extension = render.use_file_extension
+        old_use_overwrite = render.use_overwrite
+        old_use_placeholder = render.use_placeholder
+
+        try:
+
+            # The file extension should be determined by the render settings, not necessarily
+            # by the setttings in the output panel.
+            render.use_file_extension = True
+
+            # Rescheduling should not overwrite existing frames.
+            render.use_overwrite = False
+            render.use_placeholder = False
+
+            filepath = Path(context.blend_data.filepath).with_suffix('.flamenco.blend')
+            self.log.info('Saving copy to temporary file %s', filepath)
+            bpy.ops.wm.save_as_mainfile(filepath=str(filepath),
+                                        compress=True,
+                                        copy=True)
+        finally:
+            # Restore the settings we changed, even after an exception.
+            render.use_file_extension = old_use_file_extension
+            render.use_overwrite = old_use_overwrite
+            render.use_placeholder = old_use_placeholder
+
+        return filepath
+
+    def quit(self):
+        super().quit()
+        bpy.context.window_manager.flamenco_status = 'IDLE'
+
+    async def bam_pack(self, filepath: Path) -> (typing.Optional[Path], typing.List[Path]):
+        """BAM-packs the blendfile to the destination directory.
+
+        Returns the path of the destination blend file.
+
+        :param filepath: the blend file to pack (i.e. the current blend file)
+        :returns: the destination blend file, or None if there were errors BAM-packing,
+            and a list of missing paths.
+        """
+
+        from datetime import datetime
+        from ..blender import preferences
+        from . import bam_interface
+
+        prefs = preferences()
+
+        # Create a unique directory that is still more or less identifyable.
+        # This should work better than a random ID.
+        # BAM doesn't like output directories that end in '.blend'.
+        unique_dir = '%s-%s-%s' % (datetime.now().isoformat('-').replace(':', ''),
+                                   self.db_user['username'],
+                                   filepath.stem)
+        outdir = Path(prefs.flamenco_job_file_path) / unique_dir
+        outfile = outdir / filepath.name
+
+        try:
+            outdir.mkdir(parents=True)
+        except Exception as ex:
+            self.log.exception('Unable to create output path %s', outdir)
+            self.report({'ERROR'}, 'Unable to create output path: %s' % ex)
+            self.quit()
+            return None, []
+
+        try:
+            missing_sources = await bam_interface.bam_copy(filepath, outfile)
+        except bam_interface.CommandExecutionError as ex:
+            self.log.exception('Unable to execute BAM pack')
+            self.report({'ERROR'}, 'Unable to execute BAM pack: %s' % ex)
+            self.quit()
+            return None, []
+
+        return outfile, missing_sources
+
+
+class FLAMENCO_OT_scene_to_frame_range(FlamencoPollMixin, Operator):
+    """Sets the scene frame range as the Flamenco render frame range."""
+    bl_idname = 'flamenco.scene_to_frame_range'
+    bl_label = 'Sets the scene frame range as the Flamenco render frame range'
+    bl_description = __doc__.rstrip('.')
+
+    def execute(self, context):
+        s = context.scene
+        s.flamenco_render_frame_range = '%i-%i' % (s.frame_start, s.frame_end)
+        return {'FINISHED'}
+
+
+class FLAMENCO_OT_copy_files(Operator,
+                             FlamencoPollMixin,
+                             async_loop.AsyncModalOperatorMixin):
+    """Uses BAM to copy the current blendfile + dependencies to the target directory."""
+    bl_idname = 'flamenco.copy_files'
+    bl_label = 'Copy files to target'
+    bl_description = __doc__.rstrip('.')
+
+    stop_upon_exception = True
+
+    async def async_execute(self, context):
+        from pathlib import Path
+        from . import bam_interface
+        from ..blender import preferences
+
+        context.window_manager.flamenco_status = 'PACKING'
+
+        missing_sources = await bam_interface.bam_copy(
+            Path(context.blend_data.filepath),
+            Path(preferences().flamenco_job_file_path),
+        )
+
+        if missing_sources:
+            names = (ms.name for ms in missing_sources)
+            self.report({'ERROR'}, 'Missing source files: %s' % '; '.join(names))
+
+        self.quit()
+
+    def quit(self):
+        super().quit()
+        bpy.context.window_manager.flamenco_status = 'IDLE'
+
+
+class FLAMENCO_OT_explore_file_path(FlamencoPollMixin,
+                                    Operator):
+    """Opens the Flamenco job storage path in a file explorer.
+
+    If the path cannot be found, this operator tries to open its parent.
+    """
+
+    bl_idname = 'flamenco.explore_file_path'
+    bl_label = 'Open in file explorer'
+    bl_description = __doc__.rstrip('.')
+
+    path = StringProperty(name='Path', description='Path to explore', subtype='DIR_PATH')
+
+    def execute(self, context):
+        import platform
+        import pathlib
+
+        # Possibly open a parent of the path
+        to_open = pathlib.Path(self.path)
+        while to_open.parent != to_open:  # while we're not at the root
+            if to_open.exists():
+                break
+            to_open = to_open.parent
+        else:
+            self.report({'ERROR'}, 'Unable to open %s or any of its parents.' % self.path)
+            return {'CANCELLED'}
+        to_open = str(to_open)
+
+        if platform.system() == "Windows":
+            import os
+            os.startfile(to_open)
+
+        elif platform.system() == "Darwin":
+            import subprocess
+            subprocess.Popen(["open", to_open])
+
+        else:
+            import subprocess
+            subprocess.Popen(["xdg-open", to_open])
+
+        return {'FINISHED'}
+
+
+async def create_job(user_id: str,
+                     project_id: str,
+                     manager_id: str,
+                     job_type: str,
+                     job_settings: dict,
+                     job_name: str = None,
+                     *,
+                     priority: int = 50,
+                     job_description: str = None) -> dict:
+    """Creates a render job at Flamenco Server, returning the job object as dictionary."""
+
+    import json
+    from .sdk import Job
+    from ..pillar import pillar_call
+
+    job_attrs = {
+        'status': 'queued',
+        'priority': priority,
+        'name': job_name,
+        'settings': job_settings,
+        'job_type': job_type,
+        'user': user_id,
+        'manager': manager_id,
+        'project': project_id,
+    }
+    if job_description:
+        job_attrs['description'] = job_description
+
+    log.info('Going to create Flamenco job:\n%s',
+             json.dumps(job_attrs, indent=4, sort_keys=True))
+
+    job = Job(job_attrs)
+    await pillar_call(job.create)
+
+    log.info('Job created succesfully: %s', job._id)
+    return job.to_dict()
+
+
+def is_image_type(render_output_type: str) -> bool:
+    """Determines whether the render output type is an image (True) or video (False)."""
+
+    # This list is taken from rna_scene.c:273, rna_enum_image_type_items.
+    video_types = {'AVI_JPEG', 'AVI_RAW', 'FRAMESERVER', 'FFMPEG', 'QUICKTIME'}
+    return render_output_type not in video_types
+
+
+@functools.lru_cache(1)
+def _render_output_path(
+        local_project_path: str,
+        blend_filepath: Path,
+        flamenco_job_output_strip_components: int,
+        flamenco_job_output_path: str,
+        render_image_format: str,
+        flamenco_render_frame_range: str,
+) -> typing.Optional[PurePath]:
+    """Cached version of render_output_path()
+
+    This ensures that redraws of the Flamenco Render and Add-on preferences panels
+    is fast.
+    """
+
+    try:
+        project_path = Path(bpy.path.abspath(local_project_path)).resolve()
+    except FileNotFoundError:
+        # Path.resolve() will raise a FileNotFoundError if the project path doesn't exist.
+        return None
+
+    try:
+        proj_rel = blend_filepath.parent.relative_to(project_path)
+    except ValueError:
+        return None
+
+    rel_parts = proj_rel.parts[flamenco_job_output_strip_components:]
+    output_top = Path(flamenco_job_output_path)
+
+    # Strip off '.flamenco' too; we use 'xxx.flamenco.blend' as job file, but
+    # don't want to have all the output paths ending in '.flamenco'.
+    stem = blend_filepath.stem
+    if stem.endswith('.flamenco'):
+        stem = stem[:-9]
+
+    dir_components = output_top.joinpath(*rel_parts) / stem
+
+    # Blender will have to append the file extensions by itself.
+    if is_image_type(render_image_format):
+        return dir_components / '######'
+    return dir_components / flamenco_render_frame_range
+
+
+def render_output_path(context, filepath: Path = None) -> typing.Optional[PurePath]:
+    """Returns the render output path to be sent to Flamenco.
+
+    :param context: the Blender context (used to find Flamenco preferences etc.)
+    :param filepath: the Path of the blend file to render, or None for the current file.
+
+    Returns None when the current blend file is outside the project path.
+    """
+
+    from ..blender import preferences
+
+    scene = context.scene
+    prefs = preferences()
+
+    if filepath is None:
+        filepath = Path(context.blend_data.filepath)
+
+    return _render_output_path(
+        prefs.cloud_project_local_path,
+        filepath,
+        prefs.flamenco_job_output_strip_components,
+        prefs.flamenco_job_output_path,
+        scene.render.image_settings.file_format,
+        scene.flamenco_render_frame_range,
+    )
+
+
+class FLAMENCO_PT_render(bpy.types.Panel, FlamencoPollMixin):
+    bl_label = "Flamenco Render"
+    bl_space_type = 'PROPERTIES'
+    bl_region_type = 'WINDOW'
+    bl_context = "render"
+    bl_options = {'DEFAULT_CLOSED'}
+
+    def draw(self, context):
+        layout = self.layout
+
+        from ..blender import preferences
+
+        prefs = preferences()
+
+        labeled_row = layout.split(0.25, align=True)
+        labeled_row.label('Job Type:')
+        labeled_row.prop(context.scene, 'flamenco_render_job_type', text='')
+
+        labeled_row = layout.split(0.25, align=True)
+        labeled_row.label('Frame Range:')
+        prop_btn_row = labeled_row.row(align=True)
+        prop_btn_row.prop(context.scene, 'flamenco_render_frame_range', text='')
+        prop_btn_row.operator('flamenco.scene_to_frame_range', text='', icon='ARROW_LEFTRIGHT')
+
+        layout.prop(context.scene, 'flamenco_render_job_priority')
+        layout.prop(context.scene, 'flamenco_render_fchunk_size')
+
+        if getattr(context.scene, 'flamenco_render_job_type', None) == 'blender-render-progressive':
+            layout.prop(context.scene, 'flamenco_render_schunk_count')
+
+        readonly_stuff = layout.column(align=True)
+        labeled_row = readonly_stuff.split(0.25, align=True)
+        labeled_row.label('Storage:')
+        prop_btn_row = labeled_row.row(align=True)
+        prop_btn_row.label(prefs.flamenco_job_file_path)
+        props = prop_btn_row.operator(FLAMENCO_OT_explore_file_path.bl_idname,
+                                      text='', icon='DISK_DRIVE')
+        props.path = prefs.flamenco_job_file_path
+
+        labeled_row = readonly_stuff.split(0.25, align=True)
+        labeled_row.label('Output:')
+        prop_btn_row = labeled_row.row(align=True)
+        render_output = render_output_path(context)
+
+        if render_output is None:
+            prop_btn_row.label('Unable to render with Flamenco, outside of project directory.')
+        else:
+            prop_btn_row.label(str(render_output))
+            props = prop_btn_row.operator(FLAMENCO_OT_explore_file_path.bl_idname,
+                                          text='', icon='DISK_DRIVE')
+            props.path = str(render_output.parent)
+
+            flamenco_status = context.window_manager.flamenco_status
+            if flamenco_status == 'IDLE':
+                layout.operator(FLAMENCO_OT_render.bl_idname,
+                                text='Render on Flamenco',
+                                icon='RENDER_ANIMATION')
+            elif flamenco_status == 'PACKING':
+                layout.label('Flamenco is packing your file + dependencies')
+            elif flamenco_status == 'COMMUNICATING':
+                layout.label('Communicating with Flamenco Server')
+            else:
+                layout.label('Unknown Flamenco status %s' % flamenco_status)
+
+
+def activate():
+    """Activates draw callbacks, menu items etc. for Flamenco."""
+
+    global flamenco_is_active
+    log.info('Activating Flamenco')
+    flamenco_is_active = True
+
+
+def deactivate():
+    """Deactivates draw callbacks, menu items etc. for Flamenco."""
+
+    global flamenco_is_active
+    log.info('Deactivating Flamenco')
+    flamenco_is_active = False
+
+
+def register():
+    from ..utils import redraw
+
+    bpy.utils.register_class(FlamencoManagerGroup)
+    bpy.utils.register_class(FLAMENCO_OT_fmanagers)
+    bpy.utils.register_class(FLAMENCO_OT_render)
+    bpy.utils.register_class(FLAMENCO_OT_scene_to_frame_range)
+    bpy.utils.register_class(FLAMENCO_OT_copy_files)
+    bpy.utils.register_class(FLAMENCO_OT_explore_file_path)
+    bpy.utils.register_class(FLAMENCO_PT_render)
+
+    scene = bpy.types.Scene
+    scene.flamenco_render_fchunk_size = IntProperty(
+        name='Frame Chunk Size',
+        description='Maximum number of frames to render per task',
+        min=1,
+        default=1,
+    )
+    scene.flamenco_render_schunk_count = IntProperty(
+        name='Number of Sample Chunks',
+        description='Number of Cycles samples chunks to use per frame',
+        min=2,
+        default=3,
+        soft_max=10,
+    )
+    scene.flamenco_render_frame_range = StringProperty(
+        name='Frame Range',
+        description='Frames to render, in "printer range" notation'
+    )
+    scene.flamenco_render_job_type = EnumProperty(
+        name='Job Type',
+        items=[
+            ('blender-render', 'Simple Render', 'Simple frame-by-frame render'),
+            ('blender-render-progressive', 'Progressive Render',
+             'Each frame is rendered multiple times with different Cycles sample chunks, then combined'),
+        ]
+    )
+
+    scene.flamenco_render_job_priority = IntProperty(
+        name='Job Priority',
+        min=0,
+        default=50,
+        max=100,
+        description='Higher numbers mean higher priority'
+    )
+
+    bpy.types.WindowManager.flamenco_status = EnumProperty(
+        items=[
+            ('IDLE', 'IDLE', 'Not doing anything.'),
+            ('PACKING', 'PACKING', 'BAM-packing all dependencies.'),
+            ('COMMUNICATING', 'COMMUNICATING', 'Communicating with Flamenco Server.'),
+        ],
+        name='flamenco_status',
+        default='IDLE',
+        description='Current status of the Flamenco add-on',
+        update=redraw)
+
+
+def unregister():
+    deactivate()
+    bpy.utils.unregister_module(__name__)
+
+    try:
+        del bpy.types.Scene.flamenco_render_fchunk_size
+    except AttributeError:
+        pass
+    try:
+        del bpy.types.Scene.flamenco_render_schunk_count
+    except AttributeError:
+        pass
+    try:
+        del bpy.types.Scene.flamenco_render_frame_range
+    except AttributeError:
+        pass
+    try:
+        del bpy.types.Scene.flamenco_render_job_type
+    except AttributeError:
+        pass
+    try:
+        del bpy.types.Scene.flamenco_render_job_priority
+    except AttributeError:
+        pass
+    try:
+        del bpy.types.WindowManager.flamenco_status
+    except AttributeError:
+        pass

blender_cloud/flamenco/bam_interface.py

@@ -0,0 +1,144 @@
+"""BAM packing interface for Flamenco."""
+
+import logging
+from pathlib import Path
+import typing
+
+# Timeout of the BAM subprocess, in seconds.
+SUBPROC_READLINE_TIMEOUT = 600
+log = logging.getLogger(__name__)
+
+
+class CommandExecutionError(Exception):
+    """Raised when there was an error executing a BAM command."""
+    pass
+
+
+async def bam_copy(base_blendfile: Path, target_blendfile: Path) -> typing.List[Path]:
+    """Uses BAM to copy the given file and dependencies to the target blendfile.
+
+    Due to the way blendfile_pack.py is programmed/structured, we cannot import it
+    and call a function; it has to be run in a subprocess.
+
+    :raises: asyncio.CanceledError if the task was cancelled.
+    :raises: asyncio.TimeoutError if reading a line from the BAM process timed out.
+    :raises: CommandExecutionError if the subprocess failed or output invalid UTF-8.
+    :returns: a list of missing sources; hopefully empty.
+    """
+
+    import asyncio
+    import shlex
+    import subprocess
+
+    import bpy
+    import io_blend_utils
+
+    args = [
+        bpy.app.binary_path_python,
+        '-m', 'bam.pack',
+        '--input', str(base_blendfile),
+        '--output', str(target_blendfile),
+        '--mode', 'FILE',
+    ]
+
+    cmd_to_log = ' '.join(shlex.quote(s) for s in args)
+    log.info('Executing %s', cmd_to_log)
+
+    proc = await asyncio.create_subprocess_exec(
+        *args,
+        env={'PYTHONPATH': io_blend_utils.pythonpath()},
+        stdin=subprocess.DEVNULL,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+    )
+
+    missing_sources = []
+
+    try:
+        while not proc.stdout.at_eof():
+            line = await asyncio.wait_for(proc.stdout.readline(),
+                                          SUBPROC_READLINE_TIMEOUT)
+            if not line:
+                # EOF received, so let's bail.
+                break
+
+            try:
+                line = line.decode('utf8')
+            except UnicodeDecodeError as ex:
+                raise CommandExecutionError('Command produced non-UTF8 output, '
+                                            'aborting: %s' % ex)
+
+            line = line.rstrip()
+            if 'source missing:' in line:
+                path = parse_missing_source(line)
+                missing_sources.append(path)
+                log.warning('Source is missing: %s', path)
+
+            log.info('  %s', line)
+    finally:
+        if proc.returncode is None:
+            # Always wait for the process, to avoid zombies.
+            try:
+                proc.kill()
+            except ProcessLookupError:
+                # The process is already stopped, so killing is impossible. That's ok.
+                log.debug("The process was already stopped, aborting is impossible. That's ok.")
+            await proc.wait()
+        log.info('The process stopped with status code %i', proc.returncode)
+
+    if proc.returncode:
+        raise CommandExecutionError('Process stopped with status %i' % proc.returncode)
+
+    return missing_sources
+
+
+def parse_missing_source(line: str) -> Path:
+    r"""Parses a "missing source" line into a pathlib.Path.
+
+    >>> parse_missing_source(r"  source missing: b'D\xc3\xaffficult \xc3\x9cTF-8 filename'")
+    PosixPath('Dïfficult ÜTF-8 filename')
+    >>> parse_missing_source(r"  source missing: b'D\xfffficult Win1252 f\xeflen\xe6me'")
+    PosixPath('D<EFBFBD>fficult Win1252 f<>len<65>me')
+    """
+
+    _, missing_source = line.split(': ', 1)
+    missing_source_as_bytes = parse_byte_literal(missing_source.strip())
+
+    # The file could originate from any platform, so UTF-8 and the current platform's
+    # filesystem encodings are just guesses.
+    try:
+        missing_source = missing_source_as_bytes.decode('utf8')
+    except UnicodeDecodeError:
+        import sys
+        try:
+            missing_source = missing_source_as_bytes.decode(sys.getfilesystemencoding())
+        except UnicodeDecodeError:
+            missing_source = missing_source_as_bytes.decode('ascii', errors='replace')
+
+    path = Path(missing_source)
+
+    return path
+
+
+def parse_byte_literal(bytes_literal: str) -> bytes:
+    r"""Parses a repr(bytes) output into a bytes object.
+
+    >>> parse_byte_literal(r"b'D\xc3\xaffficult \xc3\x9cTF-8 filename'")
+    b'D\xc3\xaffficult \xc3\x9cTF-8 filename'
+    >>> parse_byte_literal(r"b'D\xeffficult Win1252 f\xeflen\xe6me'")
+    b'D\xeffficult Win1252 f\xeflen\xe6me'
+    """
+
+    # Some very basic assertions to make sure we have a proper bytes literal.
+    assert bytes_literal[0] == "b"
+    assert bytes_literal[1] in {'"', "'"}
+    assert bytes_literal[-1] == bytes_literal[1]
+
+    import ast
+    return ast.literal_eval(bytes_literal)
+
+
+if __name__ == '__main__':
+    import doctest
+
+    doctest.testmod()

blender_cloud/flamenco/sdk.py

@@ -0,0 +1,13 @@
+from pillarsdk.resource import List, Find, Create
+
+
+class Manager(List, Find):
+    """Manager class wrapping the REST nodes endpoint"""
+    path = 'flamenco/managers'
+
+
+class Job(List, Find, Create):
+    """Job class wrapping the REST nodes endpoint
+    """
+    path = 'flamenco/jobs'
+    ensure_query_projections = {'project': 1}

blender_cloud/home_project.py

@@ -0,0 +1,50 @@
+# ##### 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 #####
+
+import logging
+
+import pillarsdk
+from pillarsdk import exceptions as sdk_exceptions
+from .pillar import pillar_call
+
+log = logging.getLogger(__name__)
+HOME_PROJECT_ENDPOINT = '/bcloud/home-project'
+
+
+async def get_home_project(params=None) -> pillarsdk.Project:
+    """Returns the home project."""
+
+    log.debug('Getting home project')
+    try:
+        return await pillar_call(pillarsdk.Project.find_from_endpoint,
+                                 HOME_PROJECT_ENDPOINT, params=params)
+    except sdk_exceptions.ForbiddenAccess:
+        log.warning('Access to the home project was denied. '
+                    'Double-check that you are logged in with valid BlenderID credentials.')
+        raise
+    except sdk_exceptions.ResourceNotFound:
+        log.warning('No home project available.')
+        raise
+
+
+async def get_home_project_id() -> str:
+    """Returns just the ID of the home project."""
+
+    home_proj = await get_home_project({'projection': {'_id': 1}})
+    home_proj_id = home_proj['_id']
+    return home_proj_id

blender_cloud/image_sharing.py

@@ -0,0 +1,334 @@
+# ##### 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 #####
+
+import logging
+import os.path
+import tempfile
+import datetime
+
+import bpy
+import pillarsdk
+from pillarsdk import exceptions as sdk_exceptions
+from .pillar import pillar_call
+from . import async_loop, pillar, home_project, blender
+
+REQUIRES_ROLES_FOR_IMAGE_SHARING = {'subscriber', 'demo'}
+IMAGE_SHARING_GROUP_NODE_NAME = 'Image sharing'
+log = logging.getLogger(__name__)
+
+
+async def find_image_sharing_group_id(home_project_id, user_id):
+    # Find the top-level image sharing group node.
+    try:
+        share_group, created = await pillar.find_or_create_node(
+            where={'project': home_project_id,
+                   'node_type': 'group',
+                   'parent': None,
+                   'name': IMAGE_SHARING_GROUP_NODE_NAME},
+            additional_create_props={
+                'user': user_id,
+                'properties': {},
+            },
+            projection={'_id': 1},
+            may_create=True)
+    except pillar.PillarError:
+        log.exception('Pillar error caught')
+        raise pillar.PillarError('Unable to find image sharing folder on the Cloud')
+
+    return share_group['_id']
+
+
+class PILLAR_OT_image_share(pillar.PillarOperatorMixin,
+                            async_loop.AsyncModalOperatorMixin,
+                            bpy.types.Operator):
+    bl_idname = 'pillar.image_share'
+    bl_label = 'Share an image/screenshot via Blender Cloud'
+    bl_description = 'Uploads an image for sharing via Blender Cloud'
+
+    log = logging.getLogger('bpy.ops.%s' % bl_idname)
+
+    home_project_id = None
+    home_project_url = 'home'
+    share_group_id = None  # top-level share group node ID
+    user_id = None
+
+    target = bpy.props.EnumProperty(
+        items=[
+            ('FILE', 'File', 'Share an image file'),
+            ('DATABLOCK', 'Datablock', 'Share an image datablock'),
+            ('SCREENSHOT', 'Screenshot', 'Share a screenshot'),
+        ],
+        name='target',
+        default='SCREENSHOT')
+
+    name = bpy.props.StringProperty(name='name',
+                                    description='File or datablock name to sync')
+
+    screenshot_show_multiview = bpy.props.BoolProperty(
+        name='screenshot_show_multiview',
+        description='Enable Multi-View',
+        default=False)
+
+    screenshot_use_multiview = bpy.props.BoolProperty(
+        name='screenshot_use_multiview',
+        description='Use Multi-View',
+        default=False)
+
+    screenshot_full = bpy.props.BoolProperty(
+        name='screenshot_full',
+        description='Full Screen, Capture the whole window (otherwise only capture the active area)',
+        default=False)
+
+    def invoke(self, context, event):
+        # Do a quick test on datablock dirtyness. If it's not packed and dirty,
+        # the user should save it first.
+        if self.target == 'DATABLOCK':
+            if not self.name:
+                self.report({'ERROR'}, 'No name given of the datablock to share.')
+                return {'CANCELLED'}
+
+            datablock = bpy.data.images[self.name]
+            if datablock.type == 'IMAGE' and datablock.is_dirty and not datablock.packed_file:
+                self.report({'ERROR'}, 'Datablock is dirty, save it first.')
+                return {'CANCELLED'}
+
+        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')
+
+        try:
+            # Refresh credentials
+            try:
+                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.')
+                self._state = 'QUIT'
+                return
+            except pillar.UserNotLoggedInError:
+                self.log.exception('Error checking/refreshing credentials.')
+                self.report({'ERROR'}, 'Please log in on Blender ID first.')
+                self._state = 'QUIT'
+                return
+
+            # Find the home project.
+            try:
+                home_proj = await home_project.get_home_project({
+                    'projection': {'_id': 1, 'url': 1}
+                })
+            except sdk_exceptions.ForbiddenAccess:
+                self.log.exception('Forbidden access to home project.')
+                self.report({'ERROR'}, 'Did not get access to home project.')
+                self._state = 'QUIT'
+                return
+            except sdk_exceptions.ResourceNotFound:
+                self.report({'ERROR'}, 'Home project not found.')
+                self._state = 'QUIT'
+                return
+
+            self.home_project_id = home_proj['_id']
+            self.home_project_url = home_proj['url']
+
+            try:
+                gid = await find_image_sharing_group_id(self.home_project_id,
+                                                        self.user_id)
+                self.share_group_id = gid
+                self.log.debug('Found group node ID: %s', self.share_group_id)
+            except sdk_exceptions.ForbiddenAccess:
+                self.log.exception('Unable to find Group ID')
+                self.report({'ERROR'}, 'Unable to find sync folder.')
+                self._state = 'QUIT'
+                return
+
+            await self.share_image(context)
+        except Exception as ex:
+            self.log.exception('Unexpected exception caught.')
+            self.report({'ERROR'}, 'Unexpected error %s: %s' % (type(ex), ex))
+
+        self._state = 'QUIT'
+
+    async def share_image(self, context):
+        """Sends files to the Pillar server."""
+
+        if self.target == 'FILE':
+            self.report({'INFO'}, "Uploading %s '%s'" % (self.target.lower(), self.name))
+            node = await self.upload_file(self.name)
+        elif self.target == 'SCREENSHOT':
+            node = await self.upload_screenshot(context)
+        else:
+            self.report({'INFO'}, "Uploading %s '%s'" % (self.target.lower(), self.name))
+            node = await self.upload_datablock(context)
+
+        self.report({'INFO'}, 'Upload complete, creating link to share.')
+        share_info = await pillar_call(node.share)
+        url = share_info.get('short_link')
+        context.window_manager.clipboard = url
+        self.report({'INFO'}, 'The link has been copied to your clipboard: %s' % url)
+
+        await self.maybe_open_browser(url)
+
+    async def upload_file(self, filename: str, fileobj=None) -> pillarsdk.Node:
+        """Uploads a file to the cloud, attached to the image sharing node.
+
+        Returns the node.
+        """
+
+        self.log.info('Uploading file %s', filename)
+        node = await pillar_call(pillarsdk.Node.create_asset_from_file,
+                                 self.home_project_id,
+                                 self.share_group_id,
+                                 'image',
+                                 filename,
+                                 extra_where={'user': self.user_id},
+                                 always_create_new_node=True,
+                                 fileobj=fileobj,
+                                 caching=False)
+        node_id = node['_id']
+        self.log.info('Created node %s', node_id)
+        self.report({'INFO'}, 'File succesfully uploaded to the cloud!')
+
+        return node
+
+    async def maybe_open_browser(self, url):
+        prefs = blender.preferences()
+        if not prefs.open_browser_after_share:
+            return
+
+        import webbrowser
+
+        self.log.info('Opening browser at %s', url)
+        webbrowser.open_new_tab(url)
+
+    async def upload_datablock(self, context) -> pillarsdk.Node:
+        """Saves a datablock to file if necessary, then upload.
+
+        Returns the node.
+        """
+
+        self.log.info("Uploading datablock '%s'" % self.name)
+        datablock = bpy.data.images[self.name]
+
+        if datablock.type == 'RENDER_RESULT':
+            # Construct a sensible name for this render.
+            filename = '%s-%s-render%s' % (
+                os.path.splitext(os.path.basename(context.blend_data.filepath))[0],
+                context.scene.name,
+                context.scene.render.file_extension)
+            return await self.upload_via_tempdir(datablock, filename)
+
+        if datablock.packed_file is not None:
+            return await self.upload_packed_file(datablock)
+
+        if datablock.is_dirty:
+            # We can handle dirty datablocks like this if we want.
+            # However, I (Sybren) do NOT think it's a good idea to:
+            # - Share unsaved data to the cloud; users can assume it's saved
+            #   to disk and close blender, losing their file.
+            # - Save unsaved data first; this can overwrite a file a user
+            #   didn't want to overwrite.
+            filename = bpy.path.basename(datablock.filepath)
+            return await self.upload_via_tempdir(datablock, filename)
+
+        filepath = bpy.path.abspath(datablock.filepath)
+        return await self.upload_file(filepath)
+
+    async def upload_via_tempdir(self, datablock, filename_on_cloud) -> pillarsdk.Node:
+        """Saves the datablock to file, and uploads it to the cloud.
+
+        Saving is done to a temporary directory, which is removed afterwards.
+
+        Returns the node.
+        """
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            filepath = os.path.join(tmpdir, filename_on_cloud)
+            self.log.debug('Saving %s to %s', datablock, filepath)
+            datablock.save_render(filepath)
+            return await self.upload_file(filepath)
+
+    async def upload_packed_file(self, datablock) -> pillarsdk.Node:
+        """Uploads a packed file directly from memory.
+
+        Returns the node.
+        """
+
+        import io
+
+        filename = '%s.%s' % (datablock.name, datablock.file_format.lower())
+        fileobj = io.BytesIO(datablock.packed_file.data)
+        fileobj.seek(0)  # ensure PillarSDK reads the file from the beginning.
+        self.log.info('Uploading packed file directly from memory to %r.', filename)
+        return await self.upload_file(filename, fileobj=fileobj)
+
+    async def upload_screenshot(self, context) -> pillarsdk.Node:
+        """Takes a screenshot, saves it to a temp file, and uploads it."""
+
+        self.name = datetime.datetime.now().strftime('Screenshot-%Y-%m-%d-%H%M%S.png')
+        self.report({'INFO'}, "Uploading %s '%s'" % (self.target.lower(), self.name))
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            filepath = os.path.join(tmpdir, self.name)
+            self.log.debug('Saving screenshot to %s', filepath)
+            bpy.ops.screen.screenshot(filepath=filepath,
+                                      show_multiview=self.screenshot_show_multiview,
+                                      use_multiview=self.screenshot_use_multiview,
+                                      full=self.screenshot_full)
+            return await self.upload_file(filepath)
+
+
+def image_editor_menu(self, context):
+    image = context.space_data.image
+
+    box = self.layout.row()
+    if image and image.has_data:
+        text = 'Share on Blender Cloud'
+        if image.type == 'IMAGE' and image.is_dirty and not image.packed_file:
+            box.enabled = False
+            text = 'Save image before sharing on Blender Cloud'
+
+        props = box.operator(PILLAR_OT_image_share.bl_idname, text=text,
+                             icon_value=blender.icon('CLOUD'))
+        props.target = 'DATABLOCK'
+        props.name = image.name
+
+
+def window_menu(self, context):
+    props = self.layout.operator(PILLAR_OT_image_share.bl_idname,
+                                 text='Share screenshot via Blender Cloud',
+                                 icon_value=blender.icon('CLOUD'))
+    props.target = 'SCREENSHOT'
+    props.screenshot_full = True
+
+
+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)
+
+
+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)

blender_cloud/pillar.py

@@ -1,9 +1,29 @@
+# ##### 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 #####
+
 import asyncio
+import datetime
 import json
 import os
 import functools
 import logging
 from contextlib import closing, contextmanager
+import urllib.parse
 import pathlib
 
 import requests
@@ -16,8 +36,11 @@ from pillarsdk.utils import sanitize_filename
 from . import cache
 
 SUBCLIENT_ID = 'PILLAR'
+TEXTURE_NODE_TYPES = {'texture', 'hdri'}
 
-_pillar_api = None  # will become a pillarsdk.Api object.
+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__)
 uncached_session = requests.session()
 _testing_blender_id_profile = None  # Just for testing, overrides what is returned by blender_id_profile.
@@ -109,18 +132,9 @@ def blender_id_profile() -> 'blender_id.BlenderIdProfile':
     return blender_id.get_active_profile()
 
 
-def pillar_api(pillar_endpoint: str = None) -> pillarsdk.Api:
-    """Returns the Pillar SDK API object for the current user.
+def blender_id_subclient() -> dict:
+    """Returns the subclient dict, containing the 'subclient_user_id' and 'token' keys."""
 
-    The user must be logged in.
-
-    :param pillar_endpoint: URL of the Pillar server, for testing purposes. If not specified,
-        it will use the addon preferences.
-    """
-
-    global _pillar_api
-
-    # Only return the Pillar API object if the user is still logged in.
     profile = blender_id_profile()
     if not profile:
         raise UserNotLoggedInError()
@@ -129,40 +143,95 @@ def pillar_api(pillar_endpoint: str = None) -> pillarsdk.Api:
     if not subclient:
         raise CredentialsNotSyncedError()
 
-    if _pillar_api is None:
+    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.
+
+    The user must be logged in.
+
+    :param pillar_endpoint: URL of the Pillar server, for testing purposes. If not specified,
+        it will use the addon preferences.
+    :param caching: whether to return a caching or non-caching API
+    """
+
+    global _pillar_api
+
+    # Only return the Pillar API object if the user is still logged in.
+    subclient = blender_id_subclient()
+
+    if not _pillar_api:
         # Allow overriding the endpoint before importing Blender-specific stuff.
         if pillar_endpoint is None:
             from . import blender
             pillar_endpoint = blender.preferences().pillar_server
 
-        pillarsdk.Api.requests_session = cache.requests_session()
+        _caching_api = pillarsdk.Api(endpoint=pillar_endpoint,
+                                     username=subclient['subclient_user_id'],
+                                     password=SUBCLIENT_ID,
+                                     token=subclient['token'])
+        _caching_api.requests_session = cache.requests_session()
 
-        _pillar_api = pillarsdk.Api(endpoint=pillar_endpoint,
-                                    username=subclient['subclient_user_id'],
-                                    password=SUBCLIENT_ID,
-                                    token=subclient['token'])
+        _noncaching_api = pillarsdk.Api(endpoint=pillar_endpoint,
+                                        username=subclient['subclient_user_id'],
+                                        password=SUBCLIENT_ID,
+                                        token=subclient['token'])
+        _noncaching_api.requests_session = uncached_session
 
-    return _pillar_api
+        # Send the addon version as HTTP header.
+        from blender_cloud import bl_info
+        addon_version = '.'.join(str(v) for v in bl_info['version'])
+        _caching_api.global_headers['Blender-Cloud-Addon'] = addon_version
+        _noncaching_api.global_headers['Blender-Cloud-Addon'] = addon_version
+
+        _pillar_api = {
+            True: _caching_api,
+            False: _noncaching_api,
+        }
+
+    return _pillar_api[caching]
 
 
 # No more than this many Pillar calls should be made simultaneously
 pillar_semaphore = asyncio.Semaphore(3)
 
 
-async def pillar_call(pillar_func, *args, **kwargs):
-    partial = functools.partial(pillar_func, *args, api=pillar_api(), **kwargs)
+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:
         return await loop.run_in_executor(None, partial)
 
 
-async def check_pillar_credentials():
+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):
     """Tries to obtain the user at Pillar using the user's credentials.
 
+    :param required_roles: set of roles to require -- having one of those is enough.
     :raises UserNotLoggedInError: when the user is not logged in on Blender ID.
     :raises CredentialsNotSyncedError: when the user is logged in on Blender ID but
         doesn't have a valid subclient token for Pillar.
+    :returns: the Pillar User ID of the current user.
     """
 
     profile = blender_id_profile()
@@ -178,21 +247,23 @@ async def check_pillar_credentials():
         raise CredentialsNotSyncedError()
 
     try:
-        db_user = await pillar_call(pillarsdk.User.find, pillar_user_id)
-    except (pillarsdk.UnauthorizedAccess, pillarsdk.ResourceNotFound):
+        db_user = await pillar_call(pillarsdk.User.me)
+    except (pillarsdk.UnauthorizedAccess, pillarsdk.ResourceNotFound, pillarsdk.ForbiddenAccess):
         raise CredentialsNotSyncedError()
 
-    roles = db_user.roles
+    roles = db_user.roles or set()
     log.debug('User has roles %r', roles)
-    if not roles or not {'subscriber', 'demo'}.intersection(set(roles)):
+    if required_roles and not required_roles.intersection(set(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 db_user
 
-async def refresh_pillar_credentials():
+
+async def refresh_pillar_credentials(required_roles: set):
     """Refreshes the authentication token on Pillar.
 
     :raises blender_id.BlenderIdCommError: when Blender ID refuses to send a token to Pillar.
@@ -204,7 +275,7 @@ async def refresh_pillar_credentials():
     import blender_id
 
     from . import blender
-    pillar_endpoint = blender.preferences().pillar_server.rstrip('/')
+    pillar_endpoint = blender.preferences().pillar_server
 
     # Create a subclient token and send it to Pillar.
     # May raise a blender_id.BlenderIdCommError
@@ -216,7 +287,7 @@ async def refresh_pillar_credentials():
 
     # Test the new URL
     _pillar_api = None
-    await check_pillar_credentials()
+    return await check_pillar_credentials(required_roles)
 
 
 async def get_project_uuid(project_url: str) -> str:
@@ -236,7 +307,7 @@ async def get_project_uuid(project_url: str) -> str:
 
 
 async def get_nodes(project_uuid: str = None, parent_node_uuid: str = None,
-                    node_type = None) -> list:
+                    node_type=None, max_results=None) -> list:
     """Gets nodes for either a project or given a parent node.
 
     @param project_uuid: the UUID of the project, or None if only querying by parent_node_uuid.
@@ -264,25 +335,37 @@ async def get_nodes(project_uuid: str = None, parent_node_uuid: str = None,
         if isinstance(node_type, str):
             where['node_type'] = node_type
         else:
-            where['node_type'] = {'$in': node_type}
+            # Convert set & tuple to list
+            where['node_type'] = {'$in': list(node_type)}
 
-    children = await pillar_call(pillarsdk.Node.all, {
-        'projection': {'name': 1, 'parent': 1, 'node_type': 1,
-                       'properties.order': 1, 'properties.status': 1,
-                       'properties.files': 1,
-                       'properties.content_type': 1, 'picture': 1},
-        'where': where,
-        'embed': ['parent']})
+    params = {'projection': {'name': 1, 'parent': 1, 'node_type': 1, 'properties.order': 1,
+                             'properties.status': 1, 'properties.files': 1,
+                             'properties.content_type': 1, 'picture': 1},
+              'where': where,
+              'embed': ['parent']}
+
+    # Pagination
+    if max_results:
+        params['max_results'] = int(max_results)
+
+    children = await pillar_call(pillarsdk.Node.all, params)
 
     return children['_items']
 
 
-async def get_texture_projects() -> list:
+async def get_texture_projects(max_results=None) -> list:
     """Returns project dicts that contain textures."""
 
+    params = {}
+
+    # Pagination
+    if max_results:
+        params['max_results'] = int(max_results)
+
     try:
         children = await pillar_call(pillarsdk.Project.all_from_endpoint,
-                                     '/bcloud/texture-libraries')
+                                     '/bcloud/texture-libraries',
+                                     params=params)
     except pillarsdk.ResourceNotFound as ex:
         log.warning('Unable to find texture projects: %s', ex)
         raise PillarError('Unable to find texture projects: %s' % ex)
@@ -437,7 +520,7 @@ async def fetch_texture_thumbs(parent_node_uuid: str, desired_size: str,
     # Download all texture nodes in parallel.
     log.debug('Getting child nodes of node %r', parent_node_uuid)
     texture_nodes = await get_nodes(parent_node_uuid=parent_node_uuid,
-                                    node_type='texture')
+                                    node_type=TEXTURE_NODE_TYPES)
 
     if is_cancelled(future):
         log.warning('fetch_texture_thumbs: Texture downloading cancelled')
@@ -463,7 +546,7 @@ async def download_texture_thumbnail(texture_node, desired_size: str,
                                      thumbnail_loaded: callable,
                                      future: asyncio.Future = None):
     # Skip non-texture nodes, as we can't thumbnail them anyway.
-    if texture_node['node_type'] != 'texture':
+    if texture_node['node_type'] not in TEXTURE_NODE_TYPES:
         return
 
     if is_cancelled(future):
@@ -491,7 +574,8 @@ async def download_texture_thumbnail(texture_node, desired_size: str,
     # Load the File that belongs to this texture node's picture.
     loop.call_soon_threadsafe(thumbnail_loading, texture_node, texture_node)
     file_desc = await pillar_call(pillarsdk.File.find, pic_uuid, params={
-        'projection': {'filename': 1, 'variations': 1, 'width': 1, 'height': 1},
+        'projection': {'filename': 1, 'variations': 1, 'width': 1, 'height': 1,
+                       'length': 1},
     })
 
     if file_desc is None:
@@ -520,14 +604,80 @@ async def download_texture_thumbnail(texture_node, desired_size: str,
     loop.call_soon_threadsafe(thumbnail_loaded, texture_node, file_desc, thumb_path)
 
 
+async def fetch_node_files(node: pillarsdk.Node,
+                           *,
+                           file_doc_loading: callable,
+                           file_doc_loaded: callable,
+                           future: asyncio.Future = None):
+    """Fetches all files of a texture/hdri node.
+
+    @param node: Node document to fetch all file docs for.
+    @param file_doc_loading: callback function that takes (file_id, ) parameters,
+        which is called before a file document will be downloaded. This allows you to
+        show a "downloading" indicator.
+    @param file_doc_loaded: callback function that takes (file_id, pillarsdk.File object)
+        parameters, which is called for every thumbnail after it's been downloaded.
+    @param future: Future that's inspected; if it is not None and cancelled, texture downloading
+        is aborted.
+    """
+
+    # Download all thumbnails in parallel.
+    if is_cancelled(future):
+        log.warning('fetch_texture_thumbs: Texture downloading cancelled')
+        return
+
+    coros = (download_file_doc(file_ref.file,
+                               file_doc_loading=file_doc_loading,
+                               file_doc_loaded=file_doc_loaded,
+                               future=future)
+             for file_ref in node.properties.files)
+
+    # raises any exception from failed handle_texture_node() calls.
+    await asyncio.gather(*coros)
+
+    log.info('fetch_node_files: Done downloading %i files', len(node.properties.files))
+
+
+async def download_file_doc(file_id,
+                            *,
+                            file_doc_loading: callable,
+                            file_doc_loaded: callable,
+                            future: asyncio.Future = None):
+
+    if is_cancelled(future):
+        log.debug('fetch_texture_thumbs cancelled before finding File for file_id %s', file_id)
+        return
+
+    loop = asyncio.get_event_loop()
+
+    # Load the File that belongs to this texture node's picture.
+    loop.call_soon_threadsafe(file_doc_loading, file_id)
+    file_desc = await pillar_call(pillarsdk.File.find, file_id, params={
+        'projection': {'filename': 1, 'variations': 1, 'width': 1, 'height': 1,
+                       'length': 1},
+    })
+
+    if file_desc is None:
+        log.warning('Unable to find File for file_id %s', file_id)
+
+    loop.call_soon_threadsafe(file_doc_loaded, file_id, file_desc)
+
+
 async def download_file_by_uuid(file_uuid,
                                 target_directory: str,
                                 metadata_directory: str,
                                 *,
+                                filename: str = None,
                                 map_type: str = None,
-                                file_loading: callable,
-                                file_loaded: callable,
+                                file_loading: callable = None,
+                                file_loaded: callable = None,
+                                file_loaded_sync: callable = None,
                                 future: asyncio.Future):
+    """Downloads a file from Pillar by its UUID.
+
+    :param filename: overrules the filename in file_doc['filename'] if given.
+        The extension from file_doc['filename'] is still used, though.
+    """
     if is_cancelled(future):
         log.debug('download_file_by_uuid(%r) cancelled.', file_uuid)
         return
@@ -536,15 +686,18 @@ async def download_file_by_uuid(file_uuid,
 
     # Find the File document.
     file_desc = await pillar_call(pillarsdk.File.find, file_uuid, params={
-        'projection': {'link': 1, 'filename': 1},
+        'projection': {'link': 1, 'filename': 1, 'length': 1},
     })
 
     # Save the file document to disk
     metadata_file = os.path.join(metadata_directory, 'files', '%s.json' % file_uuid)
     save_as_json(file_desc, metadata_file)
 
+    # Let the caller override the filename root.
     root, ext = os.path.splitext(file_desc['filename'])
-    if root.endswith(map_type):
+    if filename:
+        root, _ = os.path.splitext(filename)
+    if not map_type or root.endswith(map_type):
         target_filename = '%s%s' % (root, ext)
     else:
         target_filename = '%s-%s%s' % (root, map_type, ext)
@@ -552,7 +705,8 @@ async def download_file_by_uuid(file_uuid,
     file_path = os.path.join(target_directory, sanitize_filename(target_filename))
     file_url = file_desc['link']
     # log.debug('Texture %r:\n%s', file_uuid, pprint.pformat(file_desc.to_dict()))
-    loop.call_soon_threadsafe(file_loading, file_path, file_desc)
+    if file_loading is not None:
+        loop.call_soon_threadsafe(file_loading, file_path, file_desc, map_type)
 
     # Cached headers are stored in the project space
     header_store = os.path.join(metadata_directory, 'files',
@@ -560,7 +714,10 @@ async def download_file_by_uuid(file_uuid,
 
     await download_to_file(file_url, file_path, header_store=header_store, future=future)
 
-    loop.call_soon_threadsafe(file_loaded, file_path, file_desc)
+    if file_loaded is not None:
+        loop.call_soon_threadsafe(file_loaded, file_path, file_desc, map_type)
+    if file_loaded_sync is not None:
+        await file_loaded_sync(file_path, file_desc, map_type)
 
 
 async def download_texture(texture_node,
@@ -570,23 +727,221 @@ async def download_texture(texture_node,
                            texture_loading: callable,
                            texture_loaded: callable,
                            future: asyncio.Future):
-    if texture_node['node_type'] != 'texture':
-        raise TypeError("Node type should be 'texture', not %r" % texture_node['node_type'])
+    node_type_name = texture_node['node_type']
+    if node_type_name not in TEXTURE_NODE_TYPES:
+        raise TypeError("Node type should be in %r, not %r" %
+                        (TEXTURE_NODE_TYPES, node_type_name))
+
+    filename = '%s.taken_from_file' % sanitize_filename(texture_node['name'])
 
     # Download every file. Eve doesn't support embedding from a list-of-dicts.
-    downloaders = (download_file_by_uuid(file_info['file'],
-                                         target_directory,
-                                         metadata_directory,
-                                         map_type=file_info['map_type'],
-                                         file_loading=texture_loading,
-                                         file_loaded=texture_loaded,
-                                         future=future)
-                   for file_info in texture_node['properties']['files'])
+    downloaders = []
+    for file_info in texture_node['properties']['files']:
+        dlr = download_file_by_uuid(file_info['file'],
+                                    target_directory,
+                                    metadata_directory,
+                                    filename=filename,
+                                    map_type=file_info.map_type or file_info.resolution,
+                                    file_loading=texture_loading,
+                                    file_loaded=texture_loaded,
+                                    future=future)
+        downloaders.append(dlr)
 
     return await asyncio.gather(*downloaders, return_exceptions=True)
 
 
+async def upload_file(project_id: str, file_path: pathlib.Path, *,
+                      future: asyncio.Future) -> str:
+    """Uploads a file to the Blender Cloud, returning a file document ID."""
+
+    from .blender import PILLAR_SERVER_URL
+
+    loop = asyncio.get_event_loop()
+    url = urllib.parse.urljoin(PILLAR_SERVER_URL, '/storage/stream/%s' % project_id)
+
+    # Upload the file in a different thread.
+    def upload():
+        auth_token = blender_id_subclient()['token']
+
+        with file_path.open(mode='rb') as infile:
+            return uncached_session.post(url,
+                                         files={'file': infile},
+                                         auth=(auth_token, SUBCLIENT_ID))
+
+    # Check for cancellation even before we start our POST request
+    if is_cancelled(future):
+        log.debug('Uploading was cancelled before doing the POST')
+        raise asyncio.CancelledError('Uploading was cancelled')
+
+    log.debug('Performing POST %s', url)
+    response = await loop.run_in_executor(None, upload)
+    log.debug('Status %i from POST %s', response.status_code, url)
+    response.raise_for_status()
+
+    resp = response.json()
+    log.debug('Upload response: %s', resp)
+
+    try:
+        file_id = resp['file_id']
+    except KeyError:
+        log.error('No file ID in upload response: %s', resp)
+        raise PillarError('No file ID in upload response: %s' % resp)
+
+    log.info('Uploaded %s to file ID %s', file_path, file_id)
+    return file_id
+
+
 def is_cancelled(future: asyncio.Future) -> bool:
     # assert future is not None  # for debugging purposes.
     cancelled = future is not None and future.cancelled()
     return cancelled
+
+
+class PillarOperatorMixin:
+    async def check_credentials(self, context, required_roles) -> bool:
+        """Checks credentials with Pillar, and if ok returns the user document from Pillar/MongoDB.
+
+        :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:
+            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 db_user
+
+        try:
+            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 db_user
+
+    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')
+
+
+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
+
+
+
+async def find_or_create_node(where: dict,
+                              additional_create_props: dict = None,
+                              projection: dict = None,
+                              may_create: bool = True) -> (pillarsdk.Node, bool):
+    """Finds a node by the `filter_props`, creates it using the additional props.
+
+    :returns: tuple (node, created), where 'created' is a bool indicating whether
+              a new node was created, or an exising one is returned.
+    """
+
+    params = {
+        'where': where,
+    }
+    if projection:
+        params['projection'] = projection
+
+    found_node = await pillar_call(pillarsdk.Node.find_first, params, caching=False)
+
+    if found_node is not None:
+        return found_node, False
+
+    if not may_create:
+        return None, False
+
+    # Augment the node properties to form a complete node.
+    node_props = where.copy()
+    if additional_create_props:
+        node_props.update(additional_create_props)
+
+    log.debug('Creating new node %s', node_props)
+    created_node = pillarsdk.Node.new(node_props)
+    created_ok = await pillar_call(created_node.create)
+    if not created_ok:
+        log.error('Blender Cloud addon: unable to create node on the Cloud.')
+        raise PillarError('Unable to create node on the Cloud')
+
+    return created_node, True
+
+
+async def attach_file_to_group(file_path: pathlib.Path,
+                               home_project_id: str,
+                               group_node_id: str,
+                               user_id: str = None) -> pillarsdk.Node:
+    """Creates an Asset node and attaches a file document to it."""
+
+    node = await pillar_call(pillarsdk.Node.create_asset_from_file,
+                             home_project_id,
+                             group_node_id,
+                             'file',
+                             str(file_path),
+                             extra_where=user_id and {'user': user_id},
+                             caching=False)
+
+    return node
+
+
+def node_to_id(node: pillarsdk.Node) -> dict:
+    """Converts a Node to a dict we can store in an ID property.
+
+    ID properties only support a handful of Python classes, so we have
+    to convert datetime.datetime to a string and remove None values.
+    """
+
+    def to_rna(value):
+        if isinstance(value, dict):
+            return {k: to_rna(v) for k, v in value.items()}
+        if isinstance(value, datetime.datetime):
+            return value.strftime(RFC1123_DATE_FORMAT)
+        return value
+
+    as_dict = to_rna(node.to_dict())
+    return pillarsdk.utils.remove_none_attributes(as_dict)

blender_cloud/settings_sync.py

@@ -0,0 +1,523 @@
+# ##### 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 #####
+
+"""Synchronises settings & startup file with the Cloud.
+Caching is disabled on many PillarSDK calls, as synchronisation can happen
+rapidly between multiple machines. This means that information can be outdated
+in seconds, rather than the minutes the cache system assumes.
+"""
+import functools
+import logging
+import pathlib
+import tempfile
+import shutil
+
+import bpy
+
+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
+
+SETTINGS_FILES_TO_UPLOAD = ['userpref.blend', 'startup.blend']
+
+# These are RNA keys inside the userpref.blend file, and their
+# Python properties names. These settings will not be synced.
+LOCAL_SETTINGS_RNA = [
+    (b'dpi', 'system.dpi'),
+    (b'virtual_pixel', 'system.virtual_pixel_mode'),
+    (b'compute_device_id', 'system.compute_device'),
+    (b'compute_device_type', 'system.compute_device_type'),
+    (b'fontdir', 'filepaths.font_directory'),
+    (b'textudir', 'filepaths.texture_directory'),
+    (b'renderdir', 'filepaths.render_output_directory'),
+    (b'pythondir', 'filepaths.script_directory'),
+    (b'sounddir', 'filepaths.sound_directory'),
+    (b'tempdir', 'filepaths.temporary_directory'),
+    (b'render_cachedir', 'filepaths.render_cache_directory'),
+    (b'i18ndir', 'filepaths.i18n_branches_directory'),
+    (b'image_editor', 'filepaths.image_editor'),
+    (b'anim_player', 'filepaths.animation_player'),
+]
+
+REQUIRES_ROLES_FOR_SYNC = set()  # no roles needed.
+SYNC_GROUP_NODE_NAME = 'Blender Sync'
+SYNC_GROUP_NODE_DESC = 'The [Blender Cloud Addon](https://cloud.blender.org/services' \
+                       '#blender-addon) will synchronize your Blender settings here.'
+log = logging.getLogger(__name__)
+
+
+def set_blender_sync_status(set_status: str):
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            bss = bpy.context.window_manager.blender_sync_status
+            bss.status = set_status
+            try:
+                return func(*args, **kwargs)
+            finally:
+                bss.status = 'IDLE'
+
+        return wrapper
+
+    return decorator
+
+
+def async_set_blender_sync_status(set_status: str):
+    def decorator(func):
+        @functools.wraps(func)
+        async def wrapper(*args, **kwargs):
+            bss = bpy.context.window_manager.blender_sync_status
+            bss.status = set_status
+            try:
+                return await func(*args, **kwargs)
+            finally:
+                bss.status = 'IDLE'
+
+        return wrapper
+
+    return decorator
+
+
+async def find_sync_group_id(home_project_id: str,
+                             user_id: str,
+                             blender_version: str,
+                             *,
+                             may_create=True) -> 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.
+    """
+
+    # Find the top-level sync group node. This should have been
+    # created by Pillar while creating the home project.
+    try:
+        sync_group, created = await pillar.find_or_create_node(
+            where={'project': home_project_id,
+                   'node_type': 'group',
+                   'parent': None,
+                   'name': SYNC_GROUP_NODE_NAME,
+                   'user': user_id},
+            projection={'_id': 1},
+            may_create=False)
+    except pillar.PillarError:
+        raise pillar.PillarError('Unable to find sync folder on the Cloud')
+
+    if not may_create and sync_group is None:
+        log.info("Sync folder doesn't exist, and not creating it either.")
+        return None, None
+
+    # Find/create the sub-group for the requested Blender version
+    try:
+        sub_sync_group, created = await pillar.find_or_create_node(
+            where={'project': home_project_id,
+                   'node_type': 'group',
+                   'parent': sync_group['_id'],
+                   'name': blender_version,
+                   'user': user_id},
+            additional_create_props={
+                'description': 'Sync folder for Blender %s' % blender_version,
+                'properties': {'status': 'published'},
+            },
+            projection={'_id': 1},
+            may_create=may_create)
+    except pillar.PillarError:
+        raise pillar.PillarError('Unable to create sync folder on the Cloud')
+
+    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'], sub_sync_group['_id']
+
+
+@functools.lru_cache()
+async def available_blender_versions(home_project_id: str, user_id: str) -> list:
+    bss = bpy.context.window_manager.blender_sync_status
+
+    # Get the available Blender versions.
+    sync_group = await pillar_call(
+        pillarsdk.Node.find_first,
+        params={
+            'where': {'project': home_project_id,
+                      'node_type': 'group',
+                      'parent': None,
+                      'name': SYNC_GROUP_NODE_NAME,
+                      'user': user_id},
+            'projection': {'_id': 1},
+        },
+        caching=False)
+
+    if sync_group is None:
+        bss.report({'ERROR'}, 'No synced Blender settings in your Blender Cloud')
+        log.debug('-- unable to find sync group for home_project_id=%r and user_id=%r',
+                  home_project_id, user_id)
+        return []
+
+    sync_nodes = await pillar_call(
+        pillarsdk.Node.all,
+        params={
+            'where': {'project': home_project_id,
+                      'node_type': 'group',
+                      'parent': sync_group['_id'],
+                      'user': user_id},
+            'projection': {'_id': 1, 'name': 1},
+            'sort': '-name',
+        },
+        caching=False)
+
+    if not sync_nodes or not sync_nodes._items:
+        bss.report({'ERROR'}, 'No synced Blender settings in your Blender Cloud.')
+        return []
+
+    versions = [node.name for node in sync_nodes._items]
+    log.debug('Versions: %s', versions)
+
+    return versions
+
+
+# noinspection PyAttributeOutsideInit
+class PILLAR_OT_sync(pillar.PillarOperatorMixin,
+                     async_loop.AsyncModalOperatorMixin,
+                     bpy.types.Operator):
+    bl_idname = 'pillar.sync'
+    bl_label = 'Synchronise with Blender Cloud'
+    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.
+
+    action = bpy.props.EnumProperty(
+        items=[
+            ('PUSH', 'Push', 'Push settings to the Blender Cloud'),
+            ('PULL', 'Pull', 'Pull settings from the Blender Cloud'),
+            ('REFRESH', 'Refresh', 'Refresh available versions'),
+            ('SELECT', 'Select', 'Select version to sync'),
+        ],
+        name='action')
+
+    CURRENT_BLENDER_VERSION = '%i.%i' % bpy.app.version[:2]
+    blender_version = bpy.props.StringProperty(name='blender_version',
+                                               description='Blender version to sync for',
+                                               default=CURRENT_BLENDER_VERSION)
+
+    def bss_report(self, level, message):
+        bss = bpy.context.window_manager.blender_sync_status
+        bss.report(level, message)
+
+    def invoke(self, context, event):
+        if self.action == 'SELECT':
+            # Synchronous action
+            return self.action_select(context)
+
+        if self.action in {'PUSH', 'PULL'} and not self.blender_version:
+            self.bss_report({'ERROR'}, 'No Blender version to sync for was given.')
+            return {'CANCELLED'}
+
+        return async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
+
+    def action_select(self, context):
+        """Allows selection of the Blender version to use.
+
+        This is a synchronous action, as it requires a dialog box.
+        """
+
+        self.log.info('Performing action SELECT')
+
+        # Do a refresh before we can show the dropdown.
+        fut = asyncio.ensure_future(self.async_execute(context, action_override='REFRESH'))
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(fut)
+
+        self._state = 'SELECTING'
+        return context.window_manager.invoke_props_dialog(self)
+
+    def draw(self, context):
+        bss = bpy.context.window_manager.blender_sync_status
+        self.layout.prop(bss, 'version', text='Blender version')
+
+    def execute(self, context):
+        if self.action != 'SELECT':
+            log.debug('Ignoring execute() for action %r', self.action)
+            return {'FINISHED'}
+
+        log.debug('Performing execute() for action %r', self.action)
+        # Perform the sync when the user closes the dialog box.
+        bss = bpy.context.window_manager.blender_sync_status
+        bpy.ops.pillar.sync('INVOKE_DEFAULT',
+                            action='PULL',
+                            blender_version=bss.version)
+
+        return {'FINISHED'}
+
+    @async_set_blender_sync_status('SYNCING')
+    async def async_execute(self, context, *, action_override=None):
+        """Entry point of the asynchronous operator."""
+
+        action = action_override or self.action
+        self.bss_report({'INFO'}, 'Communicating with Blender Cloud')
+        self.log.info('Performing action %s', action)
+
+        try:
+            # Refresh credentials
+            try:
+                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.')
+                self._state = 'QUIT'
+                return
+            except pillar.UserNotLoggedInError:
+                self.log.exception('Error checking/refreshing credentials.')
+                self.bss_report({'ERROR'}, 'Please log in on Blender ID first.')
+                self._state = 'QUIT'
+                return
+
+            # Find the home project.
+            try:
+                self.home_project_id = await home_project.get_home_project_id()
+            except sdk_exceptions.ForbiddenAccess:
+                self.log.exception('Forbidden access to home project.')
+                self.bss_report({'ERROR'}, 'Did not get access to home project.')
+                self._state = 'QUIT'
+                return
+            except sdk_exceptions.ResourceNotFound:
+                self.bss_report({'ERROR'}, 'Home project not found.')
+                self._state = 'QUIT'
+                return
+
+            # Only create the folder structure if we're pushing.
+            may_create = self.action == 'PUSH'
+            try:
+                gid, subgid = await find_sync_group_id(self.home_project_id,
+                                                       self.user_id,
+                                                       self.blender_version,
+                                                       may_create=may_create)
+                self.sync_group_id = gid
+                self.sync_group_versioned_id = subgid
+                self.log.debug('Found top-level group node ID: %s', self.sync_group_id)
+                self.log.debug('Found group node ID for %s: %s',
+                               self.blender_version, self.sync_group_versioned_id)
+            except sdk_exceptions.ForbiddenAccess:
+                self.log.exception('Unable to find Group ID')
+                self.bss_report({'ERROR'}, 'Unable to find sync folder.')
+                self._state = 'QUIT'
+                return
+
+            # Perform the requested action.
+            action_method = {
+                'PUSH': self.action_push,
+                'PULL': self.action_pull,
+                'REFRESH': self.action_refresh,
+            }[action]
+            await action_method(context)
+        except Exception as ex:
+            self.log.exception('Unexpected exception caught.')
+            self.bss_report({'ERROR'}, 'Unexpected error: %s' % ex)
+
+        self._state = 'QUIT'
+
+    async def action_push(self, context):
+        """Sends files to the Pillar server."""
+
+        self.log.info('Saved user preferences to disk before pushing to cloud.')
+        bpy.ops.wm.save_userpref()
+
+        config_dir = pathlib.Path(bpy.utils.user_resource('CONFIG'))
+
+        for fname in SETTINGS_FILES_TO_UPLOAD:
+            path = config_dir / fname
+            if not path.exists():
+                self.log.debug('Skipping non-existing %s', path)
+                continue
+
+            if self.signalling_future.cancelled():
+                self.bss_report({'WARNING'}, 'Upload aborted.')
+                return
+
+            self.bss_report({'INFO'}, 'Uploading %s' % fname)
+            try:
+                await pillar.attach_file_to_group(path,
+                                                  self.home_project_id,
+                                                  self.sync_group_versioned_id,
+                                                  self.user_id)
+            except sdk_exceptions.RequestEntityTooLarge as ex:
+                self.log.error('File too big to upload: %s' % ex)
+                self.log.error('To upload larger files, please subscribe to Blender Cloud.')
+                self.bss_report({'SUBSCRIBE'}, 'File %s too big to upload. '
+                                               'Subscribe for unlimited space.' % fname)
+                self._state = 'QUIT'
+                return
+
+        await self.action_refresh(context)
+
+        # After pushing, change the 'pull' version to the current version of Blender.
+        # Or to the latest version, if by some mistake somewhere the current push
+        # isn't available after all.
+        bss = bpy.context.window_manager.blender_sync_status
+        if self.CURRENT_BLENDER_VERSION in bss.available_blender_versions:
+            bss.version = self.CURRENT_BLENDER_VERSION
+        else:
+            bss.version = max(bss.available_blender_versions)
+
+        self.bss_report({'INFO'}, 'Settings pushed to Blender Cloud.')
+
+    async def action_pull(self, context):
+        """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:
+            self.bss_report({'ERROR'},
+                            'There are no synced Blender settings in your Blender Cloud.')
+            return
+
+        if self.sync_group_versioned_id is None:
+            self.bss_report({'ERROR'}, 'Therre are no synced Blender settings for version %s' %
+                            self.blender_version)
+            return
+
+        self.bss_report({'INFO'}, 'Pulling settings from Blender Cloud')
+        with tempfile.TemporaryDirectory(prefix='bcloud-sync') as tempdir:
+            for fname in SETTINGS_FILES_TO_UPLOAD:
+                await self.download_settings_file(fname, tempdir)
+
+        self.bss_report({'WARNING'}, 'Settings pulled from Cloud, restart Blender to load them.')
+
+    async def action_refresh(self, context):
+        self.bss_report({'INFO'}, 'Refreshing available Blender versions.')
+
+        # Clear the LRU cache of available_blender_versions so that we can
+        # obtain new versions (if someone synced from somewhere else, for example)
+        available_blender_versions.cache_clear()
+
+        versions = await available_blender_versions(self.home_project_id, self.user_id)
+        bss = bpy.context.window_manager.blender_sync_status
+        bss.available_blender_versions = versions
+
+        if 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'}, '')
+
+    async def download_settings_file(self, fname: str, temp_dir: str):
+        config_dir = pathlib.Path(bpy.utils.user_resource('CONFIG'))
+        meta_path = cache.cache_directory('home-project', 'blender-sync')
+
+        self.bss_report({'INFO'}, 'Downloading %s from Cloud' % fname)
+
+        # Get the asset node
+        node_props = {'project': self.home_project_id,
+                      'node_type': 'asset',
+                      'parent': self.sync_group_versioned_id,
+                      'name': fname}
+        node = await pillar_call(pillarsdk.Node.find_first, {
+            'where': node_props,
+            'projection': {'_id': 1, 'properties.file': 1}
+        }, caching=False)
+        if node is None:
+            self.bss_report({'INFO'}, 'Unable to find %s on Blender Cloud' % fname)
+            self.log.info('Unable to find node on Blender Cloud for %s', fname)
+            return
+
+        async def file_downloaded(file_path: str, file_desc: pillarsdk.File, map_type: str):
+            # Allow the caller to adjust the file before we move it into place.
+
+            if fname.lower() == 'userpref.blend':
+                await self.update_userpref_blend(file_path)
+
+            # Move the file next to the final location; as it may be on a
+            # different filesystem than the temporary directory, this can
+            # fail, and we don't want to destroy the existing file.
+            local_temp = config_dir / (fname + '~')
+            local_final = config_dir / fname
+
+            # Make a backup copy of the file as it was before pulling.
+            if local_final.exists():
+                local_bak = config_dir / (fname + '-pre-bcloud-pull')
+                self.move_file(local_final, local_bak)
+
+            self.move_file(file_path, local_temp)
+            self.move_file(local_temp, local_final)
+
+        file_id = node.properties.file
+        await pillar.download_file_by_uuid(file_id,
+                                           temp_dir,
+                                           str(meta_path),
+                                           file_loaded_sync=file_downloaded,
+                                           future=self.signalling_future)
+
+    def move_file(self, src, dst):
+        self.log.info('Moving %s to %s', src, dst)
+        shutil.move(str(src), str(dst))
+
+    async def update_userpref_blend(self, file_path: str):
+        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
+        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)
+            except ValueError:
+                # Setting doesn't exist. This can happen, for example Cycles
+                # settings on a build that doesn't have Cycles enabled.
+                continue
+
+            # 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)
+            prop = parent.bl_rna.properties[prop_key]
+            if prop.type == 'ENUM':
+                log.debug('Rewriting %s from %r to %r',
+                          python_key, value, prop.enum_items[value].value)
+                value = prop.enum_items[value].value
+            else:
+                log.debug('Keeping value of %s: %r', python_key, value)
+
+            remembered[rna_key] = value
+        log.debug('Overriding values: %s', remembered)
+
+        # Rewrite the userprefs.blend file to override the options.
+        with blendfile.open_blend(file_path, 'rb+') as blend:
+            prefs = next(block for block in blend.blocks
+                         if block.code == b'USER')
+
+            for key, value in remembered.items():
+                self.log.debug('prefs[%r] = %r' % (key, prefs[key]))
+                self.log.debug('  -> setting prefs[%r] = %r' % (key, value))
+                prefs[key] = value
+
+
+def register():
+    bpy.utils.register_class(PILLAR_OT_sync)
+
+
+def unregister():
+    bpy.utils.unregister_class(PILLAR_OT_sync)

blender_cloud/texture_browser.py

@@ -1,68 +1,72 @@
 # ##### BEGIN GPL LICENSE BLOCK #####
 #
-#  Copyright (C) 2014 Blender Aid
-#  http://www.blendearaid.com
-#  blenderaid@gmail.com
-
-#  This program is free software: you can redistribute it and/or modify
-#  it under the terms of the GNU General Public License as published by
-#  the Free Software Foundation, either version 3 of the License, or
-#  (at your option) any later version.
-
+#  This program is 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, see <http://www.gnu.org/licenses/>.
+#  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 #####
+
 import asyncio
 import logging
 import threading
+import os
 
 import bpy
 import bgl
 import blf
-import os
-
-from bpy.types import AddonPreferences
-from bpy.props import (BoolProperty, EnumProperty,
-                       FloatProperty, FloatVectorProperty,
-                       IntProperty, StringProperty)
 
 import pillarsdk
-from . import async_loop, pillar, cache
+from . import async_loop, pillar, cache, blender, utils
 
-icon_width = 128
-icon_height = 128
-target_item_width = 400
-target_item_height = 128
+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):
-    pass
+    NODE_TYPE = 'SPECIAL'
 
 
 class UpNode(SpecialFolderNode):
+    NODE_TYPE = 'UP'
+
     def __init__(self):
         super().__init__()
         self['_id'] = 'UP'
-        self['node_type'] = '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'] = 'PROJECT'
+        self['node_type'] = self.NODE_TYPE
 
 
 class MenuItem:
@@ -80,7 +84,8 @@ class MenuItem:
         'SPINNER': os.path.join(library_icons_path, 'spinner.png'),
     }
 
-    SUPPORTED_NODE_TYPES = {'UP', 'PROJECT', 'group_texture', 'texture'}
+    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__)
@@ -96,8 +101,8 @@ class MenuItem:
         self.label_text = label_text
         self._thumb_path = ''
         self.icon = None
-        self._is_folder = (node['node_type'] == 'group_texture' or
-                           isinstance(node, SpecialFolderNode))
+        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.
@@ -123,6 +128,8 @@ class MenuItem:
 
     @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)
@@ -133,7 +140,13 @@ class MenuItem:
     def node_uuid(self) -> str:
         return self.node['_id']
 
-    def update(self, node, file_desc, thumb_path: str, label_text):
+    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']:
@@ -142,12 +155,18 @@ class MenuItem:
         self.node = node
         self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
         self.thumb_path = thumb_path
-        self.label_text = label_text
+
+        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."""
 
@@ -182,11 +201,11 @@ class MenuItem:
         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.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.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.glVertex2d(self.x + self.icon_margin_x + ICON_WIDTH, self.y)
         bgl.glEnd()
         bgl.glDisable(bgl.GL_TEXTURE_2D)
         bgl.glDisable(bgl.GL_BLEND)
@@ -196,8 +215,8 @@ class MenuItem:
         # 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)
+                     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)
 
@@ -205,37 +224,43 @@ class MenuItem:
         return self.x < mouse_x < self.x + self.width and self.y < mouse_y < self.y + self.height
 
 
-class BlenderCloudBrowser(bpy.types.Operator):
+class BlenderCloudBrowser(pillar.PillarOperatorMixin,
+                          async_loop.AsyncModalOperatorMixin,
+                          bpy.types.Operator):
     bl_idname = 'pillar.browser'
     bl_label = 'Blender Cloud Texture Browser'
 
     _draw_handle = None
 
-    _state = 'INITIALIZING'
-
     current_path = pillar.CloudPath('/')
     project_name = ''
 
     # This contains a stack of Node objects that lead up to the currently browsed node.
     path_stack = []
 
-    async_task = None  # asyncio task for fetching thumbnails
-    signalling_future = None  # asyncio future for signalling that we want to cancel everything.
+    # This contains a stack of MenuItem objects that lead up to the currently browsed node.
+    menu_item_stack = []
+
     timer = None
     log = logging.getLogger('%s.BlenderCloudBrowser' % __name__)
 
     _menu_item_lock = threading.Lock()
-    current_display_content = []
+    current_display_content = []  # list of MenuItems currently displayed
     loaded_images = set()
     thumbnails_cache = ''
     maximized_area = False
 
     mouse_x = 0
     mouse_y = 0
+    scroll_offset = 0
+    scroll_offset_target = 0
+    scroll_offset_max = 0
+    scroll_offset_space_left = 0
 
     def invoke(self, context, event):
-        # Refuse to start if the file hasn't been saved.
-        if not context.blend_data.is_saved:
+        # 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'}
@@ -261,32 +286,22 @@ class BlenderCloudBrowser(bpy.types.Operator):
 
         self.current_display_content = []
         self.loaded_images = set()
-        self.check_credentials()
+        self._scroll_reset()
 
         context.window.cursor_modal_set('DEFAULT')
-        context.window_manager.modal_handler_add(self)
-        self.timer = context.window_manager.event_timer_add(1 / 15, context.window)
-
-        return {'RUNNING_MODAL'}
+        return async_loop.AsyncModalOperatorMixin.invoke(self, context, event)
 
     def modal(self, context, event):
-        task = self.async_task
-        if self._state != 'EXCEPTION' and task.done() and not task.cancelled():
-            ex = task.exception()
-            if ex is not None:
-                self._state = 'EXCEPTION'
-                self.log.error('Exception while running task: %s', ex)
-                return {'RUNNING_MODAL'}
-
-        if self._state == 'QUIT':
-            self._finish(context)
-            return {'FINISHED'}
+        result = async_loop.AsyncModalOperatorMixin.modal(self, context, event)
+        if not {'PASS_THROUGH', 'RUNNING_MODAL'}.intersection(result):
+            return result
 
         if event.type == 'TAB' and event.value == 'RELEASE':
             self.log.info('Ensuring async loop is running')
             async_loop.ensure_async_loop()
 
         if event.type == 'TIMER':
+            self._scroll_smooth()
             context.area.tag_redraw()
             return {'RUNNING_MODAL'}
 
@@ -305,24 +320,37 @@ class BlenderCloudBrowser(bpy.types.Operator):
             selected = self.get_clicked()
 
             if selected:
-                context.window.cursor_set('HAND')
+                if selected.is_spinning:
+                    context.window.cursor_set('WAIT')
+                else:
+                    context.window.cursor_set('HAND')
             else:
                 context.window.cursor_set('DEFAULT')
 
+            # Scrolling
+            if event.type == 'WHEELUPMOUSE':
+                self._scroll_by(MOUSE_SCROLL_PIXELS_PER_TICK)
+                context.area.tag_redraw()
+            elif event.type == 'WHEELDOWNMOUSE':
+                self._scroll_by(-MOUSE_SCROLL_PIXELS_PER_TICK)
+                context.area.tag_redraw()
+            elif event.type == 'TRACKPADPAN':
+                self._scroll_by(event.mouse_prev_y - event.mouse_y,
+                                smooth=False)
+                context.area.tag_redraw()
+
             if left_mouse_release:
                 if selected is None:
                     # No item clicked, ignore it.
                     return {'RUNNING_MODAL'}
 
+                if selected.is_spinning:
+                    # This can happen when the thumbnail information isn't loaded yet.
+                    return {'RUNNING_MODAL'}
+
                 if selected.is_folder:
-                    self.descend_node(selected.node)
+                    self.descend_node(selected)
                 else:
-                    if selected.file_desc is None:
-                        # This can happen when the thumbnail information isn't loaded yet.
-                        # Just ignore the click for now.
-                        # TODO: think of a way to handle this properly.
-                        self.log.debug('Selected item %r has no file_desc', selected)
-                        return {'RUNNING_MODAL'}
                     self.handle_item_selection(context, selected)
 
         if event.type in {'RIGHTMOUSE', 'ESC'}:
@@ -331,42 +359,21 @@ class BlenderCloudBrowser(bpy.types.Operator):
 
         return {'RUNNING_MODAL'}
 
-    def check_credentials(self):
+    async def async_execute(self, context):
         self._state = 'CHECKING_CREDENTIALS'
         self.log.debug('Checking credentials')
-        self._new_async_task(self._check_credentials())
-
-    async def _check_credentials(self):
-        """Checks credentials with Pillar, and if ok goes to the BROWSING state."""
 
         try:
-            await pillar.check_pillar_credentials()
+            db_user = 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()
-            return
-        except pillar.CredentialsNotSyncedError:
-            self.log.info('Credentials not synced, re-syncing automatically.')
-        else:
-            self.log.info('Credentials okay, browsing assets.')
-            await self.async_download_previews()
-            return
+            return None
 
-        try:
-            await pillar.refresh_pillar_credentials()
-        except pillar.NotSubscribedToCloudError:
-            self.log.info('User is not a Blender Cloud subscriber.')
-            self._show_subscribe_screen()
-            return
-        except pillar.UserNotLoggedInError:
-            self.log.error('User not logged in on Blender ID.')
-        else:
-            self.log.info('Credentials refreshed and ok, browsing assets.')
-            await self.async_download_previews()
-            return
+        if db_user is None:
+            raise pillar.UserNotLoggedInError()
 
-        raise pillar.UserNotLoggedInError()
-        # self._new_async_task(self._check_credentials())
+        await self.async_download_previews()
 
     def _show_subscribe_screen(self):
         """Shows the "You need to subscribe" screen."""
@@ -374,12 +381,13 @@ class BlenderCloudBrowser(bpy.types.Operator):
         self._state = 'PLEASE_SUBSCRIBE'
         bpy.context.window.cursor_set('HAND')
 
-    def descend_node(self, node):
-        """Descends the node hierarchy by visiting this node.
+    def descend_node(self, menu_item: 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.
         """
 
+        node = menu_item.node
         assert isinstance(node, pillarsdk.Node), 'Wrong type %s' % node
 
         if isinstance(node, UpNode):
@@ -388,6 +396,8 @@ class BlenderCloudBrowser(bpy.types.Operator):
             self.current_path = self.current_path.parent
             if self.path_stack:
                 self.path_stack.pop()
+            if self.menu_item_stack:
+                self.menu_item_stack.pop()
             if not self.path_stack:
                 self.project_name = ''
         else:
@@ -398,6 +408,7 @@ class BlenderCloudBrowser(bpy.types.Operator):
             self.current_path /= node['_id']
             self.log.debug('Going down to %r', self.current_path)
             self.path_stack.append(node)
+            self.menu_item_stack.append(menu_item)
 
         self.browse_assets()
 
@@ -407,43 +418,12 @@ class BlenderCloudBrowser(bpy.types.Operator):
             return None
         return self.path_stack[-1]
 
-    def _stop_async_task(self):
-        self.log.debug('Stopping async task')
-        if self.async_task is None:
-            self.log.debug('No async task, trivially stopped')
-            return
-
-        # Signal that we want to stop.
-        self.async_task.cancel()
-        if not self.signalling_future.done():
-            self.log.info("Signalling that we want to cancel anything that's running.")
-            self.signalling_future.cancel()
-
-        # Wait until the asynchronous task is done.
-        if not self.async_task.done():
-            self.log.info("blocking until async task is done.")
-            loop = asyncio.get_event_loop()
-            try:
-                loop.run_until_complete(self.async_task)
-            except asyncio.CancelledError:
-                self.log.info('Asynchronous task was cancelled')
-                return
-
-        # noinspection PyBroadException
-        try:
-            self.async_task.result()  # This re-raises any exception of the task.
-        except asyncio.CancelledError:
-            self.log.info('Asynchronous task was cancelled')
-        except Exception:
-            self.log.exception("Exception from asynchronous task")
-
     def _finish(self, context):
         self.log.debug('Finishing the modal operator')
-        self._stop_async_task()
+        async_loop.AsyncModalOperatorMixin._finish(self, context)
         self.clear_images()
 
         context.space_data.draw_handler_remove(self._draw_handle, 'WINDOW')
-        context.window_manager.event_timer_remove(self.timer)
         context.window.cursor_modal_restore()
 
         if self.maximized_area:
@@ -483,7 +463,7 @@ class BlenderCloudBrowser(bpy.types.Operator):
         # Just make this thread-safe to be on the safe side.
         with self._menu_item_lock:
             for menu_item in self.current_display_content:
-                if menu_item.node_uuid == node_uuid:
+                if menu_item.represents(node):
                     menu_item.update(node, *args)
                     self.loaded_images.add(menu_item.icon.filepath_raw)
                     break
@@ -508,12 +488,7 @@ class BlenderCloudBrowser(bpy.types.Operator):
         self.log.info('Asynchronously downloading previews to %r', thumbnails_directory)
         self.log.info('Current BCloud path is %r', self.current_path)
         self.clear_images()
-
-        def thumbnail_loading(node, texture_node):
-            self.add_menu_item(node, None, 'SPINNER', texture_node['name'])
-
-        def thumbnail_loaded(node, file_desc, thumb_path):
-            self.update_menu_item(node, file_desc, thumb_path, file_desc['filename'])
+        self._scroll_reset()
 
         project_uuid = self.current_path.project_uuid
         node_uuid = self.current_path.node_uuid
@@ -522,16 +497,16 @@ class BlenderCloudBrowser(bpy.types.Operator):
             # Query for sub-nodes of this node.
             self.log.debug('Getting subnodes for parent node %r', node_uuid)
             children = await pillar.get_nodes(parent_node_uuid=node_uuid,
-                                              node_type='group_texture')
+                                              node_type={'group_texture', 'group_hdri'})
         elif project_uuid:
             # Query for top-level nodes.
             self.log.debug('Getting subnodes for project node %r', project_uuid)
             children = await pillar.get_nodes(project_uuid=project_uuid,
                                               parent_node_uuid='',
-                                              node_type='group_texture')
+                                              node_type={'group_texture', 'group_hdri'})
         else:
             # Query for projects
-            self.log.debug('No node UUID and no project UUID, listing all projects')
+            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'])
@@ -558,6 +533,13 @@ class BlenderCloudBrowser(bpy.types.Operator):
         os.makedirs(directory, exist_ok=True)
 
         self.log.debug('Fetching texture thumbnails for node %r', node_uuid)
+
+        def thumbnail_loading(node, texture_node):
+            self.add_menu_item(node, None, 'SPINNER', texture_node['name'])
+
+        def thumbnail_loaded(node, file_desc, thumb_path):
+            self.update_menu_item(node, file_desc, thumb_path)
+
         await pillar.fetch_texture_thumbs(node_uuid, 's', directory,
                                           thumbnail_loading=thumbnail_loading,
                                           thumbnail_loaded=thumbnail_loaded,
@@ -567,24 +549,11 @@ class BlenderCloudBrowser(bpy.types.Operator):
         self.log.debug('Browsing assets at %r', self.current_path)
         self._new_async_task(self.async_download_previews())
 
-    def _new_async_task(self, async_task: asyncio.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)
-        self._stop_async_task()
-
-        # Download the previews asynchronously.
-        self.signalling_future = future or asyncio.Future()
-        self.async_task = asyncio.ensure_future(async_task)
-        self.log.debug('Created new task %r', self.async_task)
-
-        # Start the async manager so everything happens.
-        async_loop.ensure_async_loop()
-
     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,
@@ -614,36 +583,49 @@ class BlenderCloudBrowser(bpy.types.Operator):
     def _draw_browser(self, context):
         """OpenGL drawing code for the BROWSING state."""
 
-        margin_x = 5
-        margin_y = 5
-        padding_x = 5
-
         window_region = self._window_region(context)
-        content_width = window_region.width - margin_x * 2
-        content_height = window_region.height - margin_y * 2
+        content_width = window_region.width - ITEM_MARGIN_X * 2
+        content_height = window_region.height - ITEM_MARGIN_Y * 2
 
-        content_x = margin_x
-        content_y = context.area.height - margin_y - target_item_height
+        content_x = ITEM_MARGIN_X
+        content_y = context.area.height - ITEM_MARGIN_Y - TARGET_ITEM_HEIGHT
 
-        col_count = content_width // target_item_width
+        col_count = content_width // TARGET_ITEM_WIDTH
 
-        item_width = (content_width - (col_count * padding_x)) / col_count
-        item_height = target_item_height
+        item_width = (content_width - (col_count * ITEM_PADDING_X)) / col_count
+        item_height = TARGET_ITEM_HEIGHT
 
-        block_width = item_width + padding_x
-        block_height = item_height + margin_y
+        block_width = item_width + ITEM_PADDING_X
+        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)
 
         if self.current_display_content:
+            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
+
             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
+                y = content_y - (item_idx // col_count) * block_height - self.scroll_offset
 
                 item.update_placement(x, y, item_width, item_height)
-                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"
@@ -672,6 +654,13 @@ class BlenderCloudBrowser(bpy.types.Operator):
                                   'Checking login credentials',
                                   (0.0, 0.0, 0.2, 0.6))
 
+    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, bgcolour):
         content_height, content_width = self._window_size(context)
         bgl.glEnable(bgl.GL_BLEND)
@@ -764,23 +753,53 @@ class BlenderCloudBrowser(bpy.types.Operator):
         self.log.debug('Metadata will be stored at %s', meta_path)
 
         file_paths = []
+        select_dblock = None
+        node = item.node
 
-        def texture_downloading(file_path, file_desc, *args):
+        def texture_downloading(file_path, *_):
             self.log.info('Texture downloading to %s', file_path)
 
-        def texture_downloaded(file_path, file_desc, *args):
+        def texture_downloaded(file_path, file_desc, map_type):
+            nonlocal select_dblock
+
             self.log.info('Texture downloaded to %r.', file_path)
+
+            if context.scene.local_texture_dir.startswith('//'):
+                file_path = bpy.path.relpath(file_path)
+
             image_dblock = bpy.data.images.load(filepath=file_path)
             image_dblock['bcloud_file_uuid'] = file_desc['_id']
-            image_dblock['bcloud_texture_node_uuid'] = item.node_uuid
+            image_dblock['bcloud_node_uuid'] = node['_id']
+            image_dblock['bcloud_node_type'] = node['node_type']
+            image_dblock['bcloud_node'] = pillar.node_to_id(node)
+
+            if node['node_type'] == 'hdri':
+                # All HDRi variations should use the same image datablock, hence once name.
+                image_dblock.name = node['name']
+            else:
+                # All texture variations are loaded at once, and thus need the map type in the name.
+                image_dblock.name = '%s-%s' % (node['name'], map_type)
+
+            # Select the image in the image editor (if the context is right).
+            # Just set the first image we download,
+            if context.area.type == 'IMAGE_EDITOR':
+                if select_dblock is None or file_desc.map_type == 'color':
+                    select_dblock = image_dblock
+                    context.space_data.image = select_dblock
+
             file_paths.append(file_path)
 
         def texture_download_completed(_):
             self.log.info('Texture download complete, inspect:\n%s', '\n'.join(file_paths))
             self._state = 'QUIT'
 
+        # For HDRi nodes: only download the first file.
+        download_node = pillarsdk.Node.new(node)
+        if node['node_type'] == 'hdri':
+            download_node.properties.files = [download_node.properties.files[0]]
+
         signalling_future = asyncio.Future()
-        self._new_async_task(pillar.download_texture(item.node, local_path,
+        self._new_async_task(pillar.download_texture(download_node, local_path,
                                                      metadata_directory=meta_path,
                                                      texture_loading=texture_downloading,
                                                      texture_loaded=texture_downloaded,
@@ -794,20 +813,209 @@ class BlenderCloudBrowser(bpy.types.Operator):
 
         self.report({'INFO'}, 'We just started a browser for you.')
 
+    def _scroll_smooth(self):
+        diff = self.scroll_offset_target - self.scroll_offset
+        if diff == 0:
+            return
+
+        if abs(round(diff)) < 1:
+            self.scroll_offset = self.scroll_offset_target
+            return
+
+        self.scroll_offset += diff * 0.5
+
+    def _scroll_by(self, amount, *, smooth=True):
+        # Slow down scrolling up
+        if smooth and amount < 0 and -amount > self.scroll_offset_space_left / 4:
+            amount = -self.scroll_offset_space_left / 4
+
+        self.scroll_offset_target = min(0,
+                                        max(self.scroll_offset_max,
+                                            self.scroll_offset_target + amount))
+
+        if not smooth:
+            self._scroll_offset = self.scroll_offset_target
+
+    def _scroll_reset(self):
+        self.scroll_offset_target = self.scroll_offset = 0
+
+
+class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
+                            async_loop.AsyncModalOperatorMixin,
+                            bpy.types.Operator):
+    bl_idname = 'pillar.switch_hdri'
+    bl_label = 'Switch with another variation'
+    bl_description = 'Downloads the selected variation of an HDRi, ' \
+                     'replacing the current image'
+
+    log = logging.getLogger('bpy.ops.%s' % bl_idname)
+
+    image_name = bpy.props.StringProperty(name='image_name',
+                                          description='Name of the image block to replace')
+
+    file_uuid = bpy.props.StringProperty(name='file_uuid',
+                                         description='File ID to download')
+
+    async def async_execute(self, context):
+        """Entry point of the asynchronous operator."""
+
+        self.report({'INFO'}, 'Communicating with Blender Cloud')
+
+        try:
+            try:
+                db_user = await self.check_credentials(context, REQUIRED_ROLES_FOR_TEXTURE_BROWSER)
+                user_id = db_user['_id']
+            except pillar.NotSubscribedToCloudError:
+                self.log.exception('User not subscribed to cloud.')
+                self.report({'ERROR'}, 'Please subscribe to the Blender Cloud.')
+                self._state = 'QUIT'
+                return
+            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 not user_id:
+                raise pillar.UserNotLoggedInError()
+
+            await self.download_and_replace(context)
+        except Exception as ex:
+            self.log.exception('Unexpected exception caught.')
+            self.report({'ERROR'}, 'Unexpected error %s: %s' % (type(ex), ex))
+
+        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'])
+
+        local_path = os.path.dirname(bpy.path.abspath(current_image.filepath))
+        top_texture_directory = bpy.path.abspath(context.scene.local_texture_dir)
+        meta_path = os.path.join(top_texture_directory, '.blender_cloud')
+
+        file_uuid = self.file_uuid
+        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)
+
+        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']))
+
+        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)
+            current_image['bcloud_file_uuid'] = file_uuid
+            current_image.filepath = file_path  # This automatically reloads the image from disk.
+
+        await pillar.download_file_by_uuid(file_uuid,
+                                           local_path,
+                                           meta_path,
+                                           filename=filename,
+                                           map_type=resolution,
+                                           file_loading=file_loading,
+                                           file_loaded_sync=file_loaded,
+                                           future=self.signalling_future)
+
+        self.report({'INFO'}, 'Image download complete')
+
 
 # store keymaps here to access after registration
 addon_keymaps = []
 
 
-def menu_draw(self, context):
-    layout = self.layout
-    layout.separator()
-    layout.operator(BlenderCloudBrowser.bl_idname, icon='MOD_SCREW')
+def image_editor_menu(self, context):
+    self.layout.operator(BlenderCloudBrowser.bl_idname,
+                         text='Get image from Blender Cloud',
+                         icon_value=blender.icon('CLOUD'))
+
+
+def hdri_download_panel__image_editor(self, context):
+    _hdri_download_panel(self, context.edit_image)
+
+
+def hdri_download_panel__node_editor(self, context):
+    if context.active_node.type not in {'TEX_ENVIRONMENT', 'TEX_IMAGE'}:
+        return
+
+    _hdri_download_panel(self, context.active_node.image)
+
+
+def _hdri_download_panel(self, current_image):
+    if not current_image:
+        return
+    if 'bcloud_node_type' not in current_image:
+        return
+    if current_image['bcloud_node_type'] != 'hdri':
+        return
+    try:
+        current_variation = current_image['bcloud_file_uuid']
+    except KeyError:
+        log.warning('Image %r has a bcloud_node_type but no bcloud_file_uuid property.',
+                    current_image.name)
+        return
+
+    row = self.layout.row(align=True).split(0.3)
+    row.label('HDRi', icon_value=blender.icon('CLOUD'))
+    row.prop(current_image, 'hdri_variation', text='')
+
+    if current_image.hdri_variation != current_variation:
+        props = row.operator(PILLAR_OT_switch_hdri.bl_idname,
+                             text='Replace',
+                             icon='FILE_REFRESH')
+        props.image_name = current_image.name
+        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
+    elif context.area.type == 'NODE_EDITOR':
+        image = context.active_node.image
+    else:
+        return []
+
+    if 'bcloud_node' not in image:
+        return []
+
+    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
 
 
 def register():
     bpy.utils.register_class(BlenderCloudBrowser)
-    # bpy.types.INFO_MT_mesh_add.append(menu_draw)
+    bpy.utils.register_class(PILLAR_OT_switch_hdri)
+    bpy.types.IMAGE_MT_image.prepend(image_editor_menu)
+    bpy.types.IMAGE_PT_image_properties.append(hdri_download_panel__image_editor)
+    bpy.types.NODE_PT_active_node_properties.append(hdri_download_panel__node_editor)
+
+    # HDRi resolution switcher/chooser.
+    # TODO: when an image is selected, switch this property to its current resolution.
+    bpy.types.Image.hdri_variation = bpy.props.EnumProperty(
+        name='HDRi variations',
+        items=hdri_variation_choices,
+        description='Select a variation with which to replace this image'
+    )
 
     # handle the keymap
     wm = bpy.context.window_manager
@@ -822,13 +1030,16 @@ def register():
 
 
 def unregister():
-    bpy.utils.unregister_class(BlenderCloudBrowser)
-
     # handle the keymap
     for km, kmi in addon_keymaps:
         km.keymap_items.remove(kmi)
     addon_keymaps.clear()
 
+    if hasattr(bpy.types.Image, 'hdri_variation'):
+        del bpy.types.Image.hdri_variation
 
-if __name__ == "__main__":
-    register()
+    bpy.types.IMAGE_MT_image.remove(image_editor_menu)
+    bpy.types.IMAGE_PT_image_properties.remove(hdri_download_panel__image_editor)
+    bpy.types.NODE_PT_active_node_properties.remove(hdri_download_panel__node_editor)
+    bpy.utils.unregister_class(BlenderCloudBrowser)
+    bpy.utils.unregister_class(PILLAR_OT_switch_hdri)

blender_cloud/utils.py

@@ -0,0 +1,102 @@
+# ##### 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 #####
+
+import pathlib
+
+
+def sizeof_fmt(num: int, suffix='B') -> str:
+    """Returns a human-readable size.
+
+    Source: http://stackoverflow.com/a/1094933/875379
+    """
+
+    for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
+        if abs(num) < 1024:
+            return '%.1f %s%s' % (num, unit, suffix)
+        num /= 1024
+
+    return '%.1f Yi%s' % (num, suffix)
+
+
+def find_in_path(path: pathlib.Path, filename: str) -> 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:
+                rna_type, rna_info = getattr(self.bl_rna, propname)
+                rna_info['_cached_result'] = result
+        return wrapper
+    return decorator
+
+
+def redraw(self, context):
+    context.area.tag_redraw()

blender_cloud/wheels/__init__.py

@@ -1,3 +1,21 @@
+# ##### 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 #####
+
 """External dependencies loader."""
 
 import glob
@@ -31,7 +49,9 @@ def load_wheel(module_name, fname_prefix):
     if not wheels:
         raise RuntimeError('Unable to find wheel at %r' % path_pattern)
 
-    sys.path.append(wheels[0])
+    # 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__)
 

clear_wheels.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+git clean -n -d -X blender_cloud/wheels/
+
+echo "Press [ENTER] to actually delete those files."
+read dummy
+
+git clean -f -d -X blender_cloud/wheels/

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,7 +1,7 @@
 # Primary requirements:
-CacheControl==0.11.6
+-e git+https://github.com/sybrenstuvel/cachecontrol.git@sybren-filecache-delete-crash-fix#egg=CacheControl
 lockfile==0.12.2
-pillarsdk==1.2.0
+pillarsdk==1.6.1
 wheel==0.29.0
 
 # Secondary requirements:

setup.py

@@ -1,10 +1,30 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
+# ##### 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 #####
+
 import glob
+import os
 import sys
 import shutil
 import subprocess
 import re
 import pathlib
+import zipfile
 
 from distutils import log
 from distutils.core import Command
@@ -14,6 +34,7 @@ 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
 
 
 def set_default_path(var, default):
@@ -83,9 +104,13 @@ class BuildWheels(Command):
         # Build CacheControl.
         if not list(self.wheels_path.glob('CacheControl*.whl')):
             log.info('Building CacheControl in %s', self.cachecontrol_path)
+            # self.git_clone(self.cachecontrol_path,
+            #                'https://github.com/ionrock/cachecontrol.git',
+            #                'v%s' % requirements['CacheControl'][1])
+            # FIXME: we need my clone until pull request #125 has been merged & released
             self.git_clone(self.cachecontrol_path,
-                           'https://github.com/ionrock/cachecontrol.git',
-                           'v%s' % requirements['CacheControl'][1])
+                           'https://github.com/sybrenstuvel/cachecontrol.git',
+                           'sybren-filecache-delete-crash-fix')
             self.build_copy_wheel(self.cachecontrol_path)
 
         # Ensure that the wheels are added to the data files.
@@ -145,6 +170,34 @@ class BlenderAddonBdist(bdist):
         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."""
@@ -168,16 +221,17 @@ 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.1.0',
+    version='1.6.3',
     author='Sybren A. Stüvel',
     author_email='sybren@stuvel.eu',
     packages=find_packages('.'),
-    data_files=[('blender_cloud', ['README.md']),
+    data_files=[('blender_cloud', ['README.md', 'README-flamenco.md']),
                 ('blender_cloud/icons', glob.glob('blender_cloud/icons/*'))],
     scripts=[],
     url='https://developer.blender.org/diffusion/BCA/',

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,19 @@
+#!/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\'