path: root/release/scripts/io/netrender/ui.py

# ##### 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 bpy
import sys, os
import http, http.client, http.server, urllib
import subprocess, shutil, time, hashlib

import netrender
import netrender.slave as slave
import netrender.master as master

from netrender.utils import *

VERSION = b"0.3"

PATH_PREFIX = "/tmp/"

QUEUED = 0
DISPATCHED = 1
DONE = 2
ERROR = 3

def init_file():
    if netrender.init_file != bpy.data.filepath:
        netrender.init_file = bpy.data.filepath
        netrender.init_data = True
        netrender.init_address = True

def init_data(netsettings):
    init_file()

    if netrender.init_data:
        netrender.init_data = False

        netsettings.active_slave_index = 0
        while(len(netsettings.slaves) > 0):
            netsettings.slaves.remove(0)

        netsettings.active_blacklisted_slave_index = 0
        while(len(netsettings.slaves_blacklist) > 0):
            netsettings.slaves_blacklist.remove(0)

        netsettings.active_job_index = 0
        while(len(netsettings.jobs) > 0):
            netsettings.jobs.remove(0)

def verify_address(netsettings):
    init_file()

    if netrender.init_address:
        netrender.init_address = False

        try:
            conn = clientConnection(netsettings.server_address, netsettings.server_port, scan = False)
        except:
            conn = None

        if conn:
            conn.close()
        else:
            netsettings.server_address = "[default]"

class RenderButtonsPanel():
    bl_space_type = "PROPERTIES"
    bl_region_type = "WINDOW"
    bl_context = "render"
    # COMPAT_ENGINES must be defined in each subclass, external engines can add themselves here

    def poll(self, context):
        rd = context.scene.render
        return (rd.use_game_engine==False) and (rd.engine in self.COMPAT_ENGINES)

# Setting panel, use in the scene for now.
class RENDER_PT_network_settings(bpy.types.Panel, RenderButtonsPanel):
    bl_label = "Network Settings"
    COMPAT_ENGINES = {'NET_RENDER'}

    def draw(self, context):
        layout = self.layout

        scene = context.scene
        netsettings = scene.network_render

        verify_address(netsettings)

        layout.prop(netsettings, "mode", expand=True)

        if netsettings.mode in ("RENDER_MASTER", "RENDER_SLAVE"):
            layout.operator("render.netclientstart", icon='PLAY')

        layout.prop(netsettings, "path")

        split = layout.split(percentage=0.7)

        col = split.column()
        col.label(text="Server Adress:")
        col.prop(netsettings, "server_address", text="")

        col = split.column()
        col.label(text="Port:")
        col.prop(netsettings, "server_port", text="")

        if netsettings.mode != "RENDER_MASTER":
            layout.operator("render.netclientscan", icon='FILE_REFRESH', text="")

        layout.operator("render.netclientweb", icon='QUESTION')

class RENDER_PT_network_slave_settings(bpy.types.Panel, RenderButtonsPanel):
    bl_label = "Slave Settings"
    COMPAT_ENGINES = {'NET_RENDER'}

    def poll(self, context):
        scene = context.scene
        return (super().poll(context)
                and scene.network_render.mode == "RENDER_SLAVE")

    def draw(self, context):
        layout = self.layout

        scene = context.scene
        rd = scene.render
        netsettings = scene.network_render

        layout.prop(netsettings, "slave_clear")
        layout.prop(netsettings, "slave_thumb")
        layout.prop(netsettings, "slave_outputlog")
        layout.label(text="Threads:")
        layout.prop(rd, "threads_mode", expand=True)
        sub = layout.column()
        sub.enabled = rd.threads_mode == 'FIXED'
        sub.prop(rd, "threads")

class RENDER_PT_network_master_settings(bpy.types.Panel, RenderButtonsPanel):
    bl_label = "Master Settings"
    COMPAT_ENGINES = {'NET_RENDER'}

    def poll(self, context):
        scene = context.scene
        return (super().poll(context)
                and scene.network_render.mode == "RENDER_MASTER")

    def draw(self, context):
        layout = self.layout

        scene = context.scene
        netsettings = scene.network_render

        layout.prop(netsettings, "master_broadcast")
        layout.prop(netsettings, "master_clear")

class RENDER_PT_network_job(bpy.types.Panel, RenderButtonsPanel):
    bl_label = "Job Settings"
    COMPAT_ENGINES = {'NET_RENDER'}

    def poll(self, context):
        scene = context.scene
        return (super().poll(context)
                and scene.network_render.mode == "RENDER_CLIENT")

    def draw(self, context):
        layout = self.layout

        scene = context.scene
        netsettings = scene.network_render

        verify_address(netsettings)

        if netsettings.server_address != "[default]":
            layout.operator("render.netclientanim", icon='RENDER_ANIMATION')
            layout.operator("render.netclientsend", icon='FILE_BLEND')
            layout.operator("render.netclientsendframe", icon='RENDER_STILL')
            if netsettings.job_id:
                row = layout.row()
                row.operator("render.render", text="Get Image", icon='RENDER_STILL')
                row.operator("render.render", text="Get Animation", icon='RENDER_ANIMATION').animation = True

        split = layout.split(percentage=0.3)

        col = split.column()
        col.label(text="Name:")
        col.label(text="Category:")

        col = split.column()
        col.prop(netsettings, "job_name", text="")
        col.prop(netsettings, "job_category", text="")

        row = layout.row()
        row.prop(netsettings, "priority")
        row.prop(netsettings, "chunks")

class RENDER_PT_network_slaves(bpy.types.Panel, RenderButtonsPanel):
    bl_label = "Slaves Status"
    COMPAT_ENGINES = {'NET_RENDER'}

    def poll(self, context):
        scene = context.scene
        netsettings = scene.network_render
        if netsettings.mode != "RENDER_CLIENT":
            return False
        verify_address(netsettings)
        return (super().poll(context)
                and netsettings.server_address != "[default]")

    def draw(self, context):
        layout = self.layout

        scene = context.scene
        netsettings = scene.network_render

        row = layout.row()
        row.template_list(netsettings, "slaves", netsettings, "active_slave_index", rows=2)

        sub = row.column(align=True)
        sub.operator("render.netclientslaves", icon='FILE_REFRESH', text="")
        sub.operator("render.netclientblacklistslave", icon='ZOOMOUT', text="")

        init_data(netsettings)

        if netsettings.active_slave_index >= 0 and len(netsettings.slaves) > 0:
            layout.separator()

            slave = netrender.slaves[netsettings.active_slave_index]

            layout.label(text="Name: " + slave.name)
            layout.label(text="Address: " + slave.address[0])
            layout.label(text="Seen: " + time.ctime(slave.last_seen))
            layout.label(text="Stats: " + slave.stats)

class RENDER_PT_network_slaves_blacklist(bpy.types.Panel, RenderButtonsPanel):
    bl_label = "Slaves Blacklist"
    COMPAT_ENGINES = {'NET_RENDER'}

    def poll(self, context):
        scene = context.scene
        netsettings = scene.network_render
        if netsettings.mode != "RENDER_CLIENT":
            return False
        verify_address(netsettings)
        return (super().poll(context)
                and netsettings.server_address != "[default]")

    def draw(self, context):
        layout = self.layout

        scene = context.scene
        netsettings = scene.network_render

        row = layout.row()
        row.template_list(netsettings, "slaves_blacklist", netsettings, "active_blacklisted_slave_index", rows=2)

        sub = row.column(align=True)
        sub.operator("render.netclientwhitelistslave", icon='ZOOMOUT', text="")

        init_data(netsettings)

        if netsettings.active_blacklisted_slave_index >= 0 and len(netsettings.slaves_blacklist) > 0:
            layout.separator()

            slave = netrender.blacklist[netsettings.active_blacklisted_slave_index]

            layout.label(text="Name: " + slave.name)
            layout.label(text="Address: " + slave.address[0])
            layout.label(text="Seen: " + time.ctime(slave.last_seen))
            layout.label(text="Stats: " + slave.stats)

class RENDER_PT_network_jobs(bpy.types.Panel, RenderButtonsPanel):
    bl_label = "Jobs"
    COMPAT_ENGINES = {'NET_RENDER'}

    def poll(self, context):
        scene = context.scene
        netsettings = scene.network_render
        if netsettings.mode != "RENDER_CLIENT":
            return False
        verify_address(netsettings)
        return (super().poll(context)
                and netsettings.server_address != "[default]")

    def draw(self, context):
        layout = self.layout

        scene = context.scene
        netsettings = scene.network_render

        row = layout.row()
        row.template_list(netsettings, "jobs", netsettings, "active_job_index", rows=2)

        sub = row.column(align=True)
        sub.operator("render.netclientstatus", icon='FILE_REFRESH', text="")
        sub.operator("render.netclientcancel", icon='ZOOMOUT', text="")
        sub.operator("render.netclientcancelall", icon='PANEL_CLOSE', text="")
        sub.operator("render.netclientdownload", icon='RENDER_ANIMATION', text="")

        init_data(netsettings)

        if netsettings.active_job_index >= 0 and len(netsettings.jobs) > 0:
            layout.separator()

            job = netrender.jobs[netsettings.active_job_index]

            layout.label(text="Name: %s" % job.name)
            layout.label(text="Length: %04i" % len(job))
            layout.label(text="Done: %04i" % job.results[DONE])
            layout.label(text="Error: %04i" % job.results[ERROR])

class NetRenderSettings(bpy.types.IDPropertyGroup):
    pass

class NetRenderSlave(bpy.types.IDPropertyGroup):
    pass

class NetRenderJob(bpy.types.IDPropertyGroup):
    pass

def addProperties():
    bpy.types.Scene.PointerProperty(attr="network_render", type=NetRenderSettings, name="Network Render", description="Network Render Settings")
    
    NetRenderSettings.StringProperty( attr="server_address",
                    name="Server address",
                    description="IP or name of the master render server",
                    maxlen = 128,
                    default = "[default]")
    
    NetRenderSettings.IntProperty( attr="server_port",
                    name="Server port",
                    description="port of the master render server",
                    default = 8000,
                    min=1,
                    max=65535)
    
    NetRenderSettings.BoolProperty( attr="master_broadcast",
                    name="Broadcast",
                    description="broadcast master server address on local network",
                    default = True)
    
    NetRenderSettings.BoolProperty( attr="slave_clear",
                    name="Clear on exit",
                    description="delete downloaded files on exit",
                    default = True)
    
    NetRenderSettings.BoolProperty( attr="slave_thumb",
                    name="Generate thumbnails",
                    description="Generate thumbnails on slaves instead of master",
                    default = False)
    
    NetRenderSettings.BoolProperty( attr="slave_outputlog",
                    name="Output render log on console",
                    description="Output render text log to console as well as sending it to the master",
                    default = True)
    
    NetRenderSettings.BoolProperty( attr="master_clear",
                    name="Clear on exit",
                    description="delete saved files on exit",
                    default = False)
    
    default_path = os.environ.get("TEMP")
    
    if not default_path:
        if os.name == 'nt':
            default_path = "c:/tmp/"
        else:
            default_path = "/tmp/"
    elif not default_path.endswith(os.sep):
        default_path += os.sep
    
    NetRenderSettings.StringProperty( attr="path",
                    name="Path",
                    description="Path for temporary files",
                    maxlen = 128,
                    default = default_path,
                    subtype='FILE_PATH')
    
    NetRenderSettings.StringProperty( attr="job_name",
                    name="Job name",
                    description="Name of the job",
                    maxlen = 128,
                    default = "[default]")
    
    NetRenderSettings.StringProperty( attr="job_category",
                    name="Job category",
                    description="Category of the job",
                    maxlen = 128,
                    default = "")
    
    NetRenderSettings.IntProperty( attr="chunks",
                    name="Chunks",
                    description="Number of frame to dispatch to each slave in one chunk",
                    default = 5,
                    min=1,
                    max=65535)
    
    NetRenderSettings.IntProperty( attr="priority",
                    name="Priority",
                    description="Priority of the job",
                    default = 1,
                    min=1,
                    max=10)
    
    NetRenderSettings.StringProperty( attr="job_id",
                    name="Network job id",
                    description="id of the last sent render job",
                    maxlen = 64,
                    default = "")
    
    NetRenderSettings.IntProperty( attr="active_slave_index",
                    name="Index of the active slave",
                    description="",
                    default = -1,
                    min= -1,
                    max=65535)
    
    NetRenderSettings.IntProperty( attr="active_blacklisted_slave_index",
                    name="Index of the active slave",
                    description="",
                    default = -1,
                    min= -1,
                    max=65535)
    
    NetRenderSettings.IntProperty( attr="active_job_index",
                    name="Index of the active job",
                    description="",
                    default = -1,
                    min= -1,
                    max=65535)
    
    NetRenderSettings.EnumProperty(attr="mode",
                            items=(
                                            ("RENDER_CLIENT", "Client", "Act as render client"),
                                            ("RENDER_MASTER", "Master", "Act as render master"),
                                            ("RENDER_SLAVE", "Slave", "Act as render slave"),
                                        ),
                            name="Network mode",
                            description="Mode of operation of this instance",
                            default="RENDER_CLIENT")
    
    NetRenderSettings.CollectionProperty(attr="slaves", type=NetRenderSlave, name="Slaves", description="")
    NetRenderSettings.CollectionProperty(attr="slaves_blacklist", type=NetRenderSlave, name="Slaves Blacklist", description="")
    NetRenderSettings.CollectionProperty(attr="jobs", type=NetRenderJob, name="Job List", description="")
    
    NetRenderSlave.StringProperty( attr="name",
                    name="Name of the slave",
                    description="",
                    maxlen = 64,
                    default = "")
    
    NetRenderJob.StringProperty( attr="name",
                    name="Name of the job",
                    description="",
                    maxlen = 128,
                    default = "")