2025-12-01

scripts/addons/blender_kitsu/auth/__init__.py

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import importlib
+from ..auth import ops, ui
+
+
+# ---------REGISTER ----------.
+
+
+def reload():
+    global ops
+    global ui
+
+    ops = importlib.reload(ops)
+    ui = importlib.reload(ui)
+
+
+def register():
+    ops.register()
+    ui.register()
+
+
+def unregister():
+    ui.unregister()
+    ops.unregister()

scripts/addons/blender_kitsu/auth/ops.py

@@ -0,0 +1,145 @@
+# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from typing import Dict, List, Set, Optional, Tuple, Any
+
+import bpy
+import threading
+import gazu
+from .. import cache, prefs
+
+# TODO: restructure this to not access ops_playblast_data.
+from ..playblast import opsdata as ops_playblast_data
+from ..playblast import ops as ops_playblast
+from ..logger import LoggerFactory
+
+logger = LoggerFactory.getLogger()
+
+active_thread = False
+
+
+class KITSU_OT_session_start(bpy.types.Operator):
+    """
+    Starts the Session, which  is stored in blender_kitsu addon preferences.
+    Authenticates user with server until session ends.
+    Host, email and password are retrieved from blender_kitsu addon preferences.
+    """
+
+    bl_idname = "kitsu.session_start"
+    bl_label = "Start Kitsu Session"
+    bl_options = {"INTERNAL"}
+    bl_description = (
+        "Logs in to server with the credentials that are defined in the "
+        "addon preferences. Session is valid until Blender closes"
+    )
+
+    @classmethod
+    def poll(cls, context: bpy.types.Context) -> bool:
+        return True
+
+    def execute(self, context: bpy.types.Context) -> Set[str]:
+        self.thread_login(context)
+        if not prefs.session_get(context).is_auth():
+            self.report({"ERROR"}, "Login data not correct")
+            logger.error("Login data not correct")
+            return {"CANCELLED"}
+
+        # Init cache variables, will skip if cache already initiated.
+        cache.init_cache_variables()
+
+        # Init startup variables, will skip if cache already initiated.
+        cache.init_startup_variables(context)
+
+        # Init playblast version dir model.
+        ops_playblast_data.init_playblast_file_model(context)
+
+        # Check frame range.
+        ops_playblast.load_post_handler_check_frame_range(None)
+        return {"FINISHED"}
+
+    def get_config(self, context: bpy.types.Context) -> Dict[str, str]:
+        addon_prefs = prefs.addon_prefs_get(context)
+        return {
+            "email": addon_prefs.email,
+            "host": addon_prefs.host,
+            "passwd": addon_prefs.passwd,
+        }
+
+    def kitsu_session_start(self, context):
+        session = prefs.session_get(context)
+        session.set_config(self.get_config(context))
+        try:
+            session_data = session.start()
+            self.report({"INFO"}, f"Logged in as {session_data.user['full_name']}")
+        finally:
+            return
+
+    def thread_login(self, context):
+        global active_thread
+        if active_thread:
+            active_thread._stop()
+        active_thread = threading.Thread(
+            target=self.kitsu_session_start(context), daemon=True
+        )
+        active_thread.start()
+
+
+class KITSU_OT_session_end(bpy.types.Operator):
+    """
+    Ends the Session which is stored in blender_kitsu addon preferences.
+    """
+
+    bl_idname = "kitsu.session_end"
+    bl_label = "End Kitsu Session"
+    bl_options = {"INTERNAL"}
+    bl_description = "Logs active user out"
+
+    @classmethod
+    def poll(cls, context: bpy.types.Context) -> bool:
+        return prefs.session_auth(context)
+
+    def execute(self, context: bpy.types.Context) -> Set[str]:
+        session = prefs.session_get(context)
+        session.end()
+
+        # Clear cache variables.
+        cache.clear_cache_variables()
+
+        # Clear startup variables.
+        cache.clear_startup_variables()
+
+        self.report({"INFO"}, "Logged out")
+
+        return {"FINISHED"}
+
+
+def auto_login_on_file_open():
+    context = bpy.context
+    session = prefs.session_get(context)
+    if not session.is_auth() and prefs.addon_prefs_get(context).host:
+        bpy.ops.kitsu.session_start()
+
+
+# ---------REGISTER ----------.
+
+classes = [
+    KITSU_OT_session_start,
+    KITSU_OT_session_end,
+]
+
+
+def register():
+    for cls in classes:
+        bpy.utils.register_class(cls)
+    # Note: Since this timer function does not repeat
+    # (because it doesn't return a value)
+    # it automatically un-registers after it runs.
+    # FIXME: XXX This makes Blender hang if there is no Internet connectivity
+    # TODO: Rewrite this, so the 'auto' login happens out of the main thread
+    bpy.app.timers.register(auto_login_on_file_open, first_interval=0.2)
+
+
+def unregister():
+    for cls in reversed(classes):
+        bpy.utils.unregister_class(cls)

scripts/addons/blender_kitsu/auth/ui.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import bpy
+
+from .. import prefs
+from ..auth.ops import KITSU_OT_session_end, KITSU_OT_session_start
+
+
+class KITSU_PT_vi3d_auth(bpy.types.Panel):
+    """
+    Panel in 3dview that displays email, password and login operator.
+    """
+
+    bl_category = "Kitsu"
+    bl_label = "Login"
+    bl_space_type = "VIEW_3D"
+    bl_region_type = "UI"
+    bl_order = 10
+
+    def draw(self, context: bpy.types.Context) -> None:
+        addon_prefs = prefs.addon_prefs_get(context)
+        session = prefs.session_get(context)
+
+        layout = self.layout
+
+        row = layout.row(align=True)
+        if not session.is_auth():
+            row.label(text=f"Email: {addon_prefs.email}")
+            row = layout.row(align=True)
+            row.label(text=f"Host:  {addon_prefs.host}")
+            row = layout.row(align=True)
+            row.operator(KITSU_OT_session_start.bl_idname, text="Login", icon="PLAY")
+        else:
+            row.label(text=f"Logged in: {session.email}")
+            row = layout.row(align=True)
+            row.operator(
+                KITSU_OT_session_end.bl_idname, text="Logout", icon="PANEL_CLOSE"
+            )
+
+
+class KITSU_PT_sqe_auth(KITSU_PT_vi3d_auth):
+    bl_space_type = "SEQUENCE_EDITOR"
+
+    @classmethod
+    def poll(cls, context: bpy.types.Context) -> bool:
+        return bool(not prefs.session_auth(context))
+
+
+class KITSU_PT_comp_auth(KITSU_PT_vi3d_auth):
+    bl_space_type = "NODE_EDITOR"
+
+    @classmethod
+    def poll(cls, context: bpy.types.Context) -> bool:
+        return bool(not prefs.session_auth(context))
+
+
+# ---------REGISTER ----------
+# classes that inherit from another need to be registered first for some reason
+classes = [KITSU_PT_comp_auth, KITSU_PT_sqe_auth, KITSU_PT_vi3d_auth]
+
+
+def register():
+    for cls in classes:
+        bpy.utils.register_class(cls)
+
+
+def unregister():
+    for cls in reversed(classes):
+        bpy.utils.unregister_class(cls)