General: Connect to AYON server (base) (#3924)

* implemented 'get_workfile_info' in entities

* removed 'prepare_asset_update_data' which is not used

* disable settings and project manager if in v4 mode

* prepared conversion helper functions for v4 entities

* prepared conversion functions for hero versions

* fix hero versions

* implemented get_archived_representations

* fix get latest versions

* return prepared changes

* handle archived representation

* raise exception on failed json conversion

* map archived to active properly

* make sure default fields are added

* fix conversion of hero version entity

* fix conversion of archived representations

* fix some conversions of representations and versions

* changed active behavior in queries

* fixed hero versions

* implemented basic thumbnail caching

* added raw variants of crud methods

* implemented methods to get and create thumbnail

* fix from flat dict

* implemented some basic folder conversion for updates

* fix thumbnail updates for version

* implemented v4 thumbnail integrator

* simplified data mapping

* 'get_thumbnail' function also expect entity type and entity id for which is the thumbnail received

* implemented 'get_thumbnail' for server

* fix how thumbnail id is received from entity

* removed unnecessary method 'get_thumbnail_id_from_source'

* implemented thumbnail resolver for v4

* removed unnecessary print

* move create and delete project directly to server api

* disable local settings action too on v4

* OP-3521 - added method to check and download updated addons from v4 server

* OP-3521 - added more descriptive error message for missing source

* OP-3521 - added default implementation of addon downloader to import

* OP-3521 - added check for dependency package zips

WIP - server doesn't contain required endpoint. Testing only with mockup data for now.

* OP-3521 - fixed parsing of DependencyItem

Added Server Url type and ServerAddonDownloader - v4 server doesn't know its own DNS for static files so it is sending unique name and url must be created during runtime.

* OP-3521 - fixed creation of targed directories

* change nev keys to look for and don't set them automatically

* fix task type conversion

* implemented base of loading v4 addons in v3

* Refactored argument name in Downloaders

* Updated parsing to DependencyItem according to current schema

* Implemented downloading of package from server

* Updated resolving of failures

Uses Enum items.

* Introduced passing of authorization token

Better to inject it than to have it from env var.

* Remove weird parsing of server_url

Not necessary, endpoints have same prefix.

* Fix doubling asset version name in addons folder

Zip file should already contain `addonName_addonVersion` as first subfolder

* Fix doubling asset version name in addons folder

Zip file should already contain `addonName_addonVersion` as first subfolder

* Made server_endpoint optional

Argument should be better for testing, but for calling from separate methods it would be better to encapsulate it.

Removed unwanted temporary productionPackage value

* Use existing method to pull addon info from Server to load v4 version of addon

* Raise exception when server doesn't have any production dependency package

* added ability to specify v3 alias of addon name

* expect v3_alias as uppered constant

* Re-implemented method to get addon info

Previous implementation wouldn't work in Python2 hosts.
Will be refactored in the future.

* fix '__getattr__'

* added ayon api to pyproject.toml and lock file

* use ayon api in common connection

* added mapping for label

* use ayon_api in client codebase

* separated clearing cache of url and username

* bump ayon api version

* rename env 'OP4_TEST' to 'USE_AYON_SERVER'

* Move and renamend get_addons_info to get_addons_info_as_dict in addon_distribution

Should be moved to ayon_api later

* Replaced requests calls with ayon_api

* Replaced OP4_TEST_ENABLED with AYON_SERVER_ENABLED

fixed endpoints

* Hound

* Hound

* OP-3521 - fix wrong key in get_representation_parents

parents overloads parents

* OP-3521 - changes for v4 of SiteSync addon

* OP-3521 - fix names

* OP-3521 - remove storing project_name

It should be safer to go thorug self.dbcon apparently

* OP-3521 - remove unwanted

"context["folder"]" can be only in dummy test data

* OP-3521 - move site sync loaders to addon

* Use only project instead of self.project

* OP-3521 - added missed get_progress_for_repre

* base of settings conversion script

* simplified ayon functions in start.py

* added loading of settings from ayon server

* added a note about colors

* fix global and local settings functions

* AvalonMongoDB is not using mongo connection on ayon server enabled

* 'get_dynamic_modules_dirs' is not checking system settings for paths in setting

* log viewer is disabled when ayon server is enabled

* basic logic of enabling/disabled addons

* don't use mongo logging if ayon server is enabled

* update ayon api

* bump ayon api again

* use ayon_api to get addons info in modules/base

* update ayon api

* moved helper functions to get addons and dependencies dir to common functions

* Initialization of AddonInfo is not crashing on unkonwn sources

* renamed 'DependencyDownloader' to 'AyonServerDownloader'

* renamed function 'default_addon_downloader' to 'get_default_addon_downloader'

* Added ability to convert 'WebAddonSource' to 'ServerResourceSorce'

* missing dependency package on server won't cause crash

* data sent to downloaders don't contain ayon specific headers

* modified addon distribution to not duplicate 'ayon_api' functionality

* fix doubled function defintioin

* unzip client file to addon destination

* formatting - unify quotes

* disable usage of mongo connection if in ayon mode

* renamed window.py to login_window.py

* added webpublisher settings conversion

* added maya conversion function

* reuse variable

* reuse variable (similar to previous commit)

* fix ayon addons loading

* fix typo 'AyonSettingsCahe' -> 'AyonSettingsCache'

* fix enabled state changes

* fix rr_path in royal render conversion

* avoid mongo calls in AYON state

* implemented custom AYON start script

* fix formatting (after black)

* ayon_start cleanup

* 'get_addons_dir' and 'get_dependencies_dir' store value to environment variable

* add docstrings to local dir functions

* addon info has full name

* fix modules enabled states

* removed unused 'run_disk_mapping_commands'

* removed ayon logic from 'start.py'

* fix warning message

* renamed 'openpype_common' to 'ayon_common'

* removed unused import

* don't import igniter

* removed startup validations of third parties

* change what's shown in version info

* fix which keys are applied from ayon values

* fix method name

* get applications from attribs

* Implemented UI basics to be able change user or logout

* merged server.py and credentials.py

* add more metadata to urls

* implemented change token

* implemented change user ui functionality

* implemented change user ui

* modify window to handle username and token value

* pass username to add server

* fix show UI cases

* added loggin action to tray

* update ayon api

* added missing dependency

* convert applications to config in a right way

* initial implementation of 'nuke' settings conversion

* removed few nuke comments

* implemented hiero conversion

* added imageio conversion

* added run ayon tray script

* fix few settings conversions

* Renamed class of source classes as they are not just for addons

* implemented objec to track source transfer progress

* Implemented distribution item with multiple sources

* Implemented ayon distribution wrapper to care about multiple things during distribution

* added 'cleanup' method for downlaoders

* download gets tranfer progress object

* Change UploadState enum

* added missing imports

* use AyonDistribution in ayon_start.py

* removed unused functions

* removed implemented TODOs

* fix import

* fix key used for Web source

* removed temp development fix

* formatting fix

* keep information if source require distribution

* handle 'require_distribution' attribute in distribution process

* added path attribute to server source

* added option to pass addons infor to ayon distribution

* fix tests

* fix formatting

* Fix typo

* Fix typo

* remove '_try_convert_to_server_source'

* renamed attributes and methods to match their content

* it is possible to pass dependency package info to AyonDistribution

* fix called methods in tests

* added public properties for error message and error detail

* Added filename to WebSourceInfo

Useful for GDrive sharable links where target file name is unknown/unparsable, it should be provided explicitly.

* unify source conversion by adding 'convert_source' function

* Fix error message

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

* added docstring for 'transfer_progress'

* don't create metadata file on read

* added few docstrings

* add default folder fields to folder/task queries

* fix generators

* add dependencies when runnign from code

* add sys paths from distribution to pythonpath env

* fix missing applications

* added missing conversions for maya renderers

* fix formatting

* update ayon api

* fix hashes in lock file

* Use better exception

Co-authored-by: Ondřej Samohel <33513211+antirotor@users.noreply.github.com>

* Use Python 3 syntax

Co-authored-by: Ondřej Samohel <33513211+antirotor@users.noreply.github.com>

* apply some of sugested changes in ayon_start

* added some docstrings and suggested modifications

* copy create env from develop

* fix rendersettings conversion

* change code by suggestions

* added missing args to docstring

* added missing docstrings

* separated downloader and download factory

* fix ayon settings

* added some basic file docstring to ayon_settings

* join else conditions

* fix project settings conversion

* fix created at conversion

* fix workfile info query

* fix publisher UI

* added utils function 'get_ayon_appdirs'

* fix 'get_all_current_info'

* fix server url assignment when url is set

* updated ayon api

* added utils functions to create local site id for ayon

* added helper functions to create global connection

* create global connection in ayon start to start use site id

* use ayon site id in ayon mode

* formatting cleanup

* added header docstring

* fixes after ayon_api update

* load addons from ynput appdirs

* fix function call

* added docstring

* update ayon pyton api

* fix settings access

* use ayon_api to get root overrides in Anatomy

* bumbayon version to 0.1.13

* nuke: fixing settings keys from settings

* fix burnins definitions

* change v4 to AYON in thumbnail integrate

* fix one more v4 information

* Fixes after rebase

* fix extract burnin conversion

* additional fix of extract burnin

* SiteSync:added missed loaders or v3 compatibility (#4587)

* Added site sync loaders for v3 compatibility

* Fix get_progress_for_repre

* use 'files.name' instead of 'files.baseName'

* update ayon api to 0.1.14

* add common to include files

* change arguments for hero version creation

* skip shotgrid settings conversion if different ayon addon is used

* added ayon icons

* fix labels of application variants

* added option to show login window always on top

* login window on invalid credentials is always on top

* update ayon api

* update ayon api

* add entityType to project and folders

* AYON: Editorial hierarchy creation (#4699)

* disable extract hierarchy avalon when ayon mode is enabled

* implemented extract hierarchy to AYON

---------

Co-authored-by: Petr Kalis <petr.kalis@gmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Ondřej Samohel <33513211+antirotor@users.noreply.github.com>
Co-authored-by: Jakub Jezek <jakubjezek001@gmail.com>

openpype/settings/lib.py

@@ -4,6 +4,9 @@ import functools
 import logging
 import platform
 import copy
+
+from openpype import AYON_SERVER_ENABLED
+
 from .exceptions import (
     SaveWarningExc
 )
@@ -18,6 +21,11 @@ from .constants import (
     DEFAULT_PROJECT_KEY
 )
 
+from .ayon_settings import (
+    get_ayon_project_settings,
+    get_ayon_system_settings
+)
+
 log = logging.getLogger(__name__)
 
 # Py2 + Py3 json decode exception
@@ -40,36 +48,17 @@ _SETTINGS_HANDLER = None
 _LOCAL_SETTINGS_HANDLER = None
 
 
-def require_handler(func):
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs):
-        global _SETTINGS_HANDLER
-        if _SETTINGS_HANDLER is None:
-            _SETTINGS_HANDLER = create_settings_handler()
-        return func(*args, **kwargs)
-    return wrapper
-
-
-def require_local_handler(func):
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs):
-        global _LOCAL_SETTINGS_HANDLER
-        if _LOCAL_SETTINGS_HANDLER is None:
-            _LOCAL_SETTINGS_HANDLER = create_local_settings_handler()
-        return func(*args, **kwargs)
-    return wrapper
-
-
-def create_settings_handler():
-    from .handlers import MongoSettingsHandler
-    # Handler can't be created in global space on initialization but only when
-    # needed. Plus here may be logic: Which handler is used (in future).
-    return MongoSettingsHandler()
-
-
-def create_local_settings_handler():
-    from .handlers import MongoLocalSettingsHandler
-    return MongoLocalSettingsHandler()
+def clear_metadata_from_settings(values):
+    """Remove all metadata keys from loaded settings."""
+    if isinstance(values, dict):
+        for key in tuple(values.keys()):
+            if key in METADATA_KEYS:
+                values.pop(key)
+            else:
+                clear_metadata_from_settings(values[key])
+    elif isinstance(values, list):
+        for item in values:
+            clear_metadata_from_settings(item)
 
 
 def calculate_changes(old_value, new_value):
@@ -91,6 +80,42 @@ def calculate_changes(old_value, new_value):
     return changes
 
 
+def create_settings_handler():
+    if AYON_SERVER_ENABLED:
+        raise RuntimeError("Mongo settings handler was triggered in AYON mode")
+    from .handlers import MongoSettingsHandler
+    # Handler can't be created in global space on initialization but only when
+    # needed. Plus here may be logic: Which handler is used (in future).
+    return MongoSettingsHandler()
+
+
+def create_local_settings_handler():
+    if AYON_SERVER_ENABLED:
+        raise RuntimeError("Mongo settings handler was triggered in AYON mode")
+    from .handlers import MongoLocalSettingsHandler
+    return MongoLocalSettingsHandler()
+
+
+def require_handler(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        global _SETTINGS_HANDLER
+        if _SETTINGS_HANDLER is None:
+            _SETTINGS_HANDLER = create_settings_handler()
+        return func(*args, **kwargs)
+    return wrapper
+
+
+def require_local_handler(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        global _LOCAL_SETTINGS_HANDLER
+        if _LOCAL_SETTINGS_HANDLER is None:
+            _LOCAL_SETTINGS_HANDLER = create_local_settings_handler()
+        return func(*args, **kwargs)
+    return wrapper
+
+
 @require_handler
 def get_system_last_saved_info():
     return _SETTINGS_HANDLER.get_system_last_saved_info()
@@ -494,10 +519,17 @@ def save_local_settings(data):
 
 
 @require_local_handler
-def get_local_settings():
+def _get_local_settings():
     return _LOCAL_SETTINGS_HANDLER.get_local_settings()
 
 
+def get_local_settings():
+    if not AYON_SERVER_ENABLED:
+        return _get_local_settings()
+    # TODO implement ayon implementation
+    return {}
+
+
 def load_openpype_default_settings():
     """Load openpype default settings."""
     return load_jsons_from_dir(DEFAULTS_DIR)
@@ -890,7 +922,7 @@ def apply_local_settings_on_project_settings(
         sync_server_config["remote_site"] = remote_site
 
 
-def get_system_settings(clear_metadata=True, exclude_locals=None):
+def _get_system_settings(clear_metadata=True, exclude_locals=None):
     """System settings with applied studio overrides."""
     default_values = get_default_settings()[SYSTEM_SETTINGS_KEY]
     studio_values = get_studio_system_settings_overrides()
@@ -992,7 +1024,7 @@ def get_anatomy_settings(
     return result
 
 
-def get_project_settings(
+def _get_project_settings(
     project_name, clear_metadata=True, exclude_locals=None
 ):
     """Project settings with applied studio and project overrides."""
@@ -1043,7 +1075,7 @@ def get_current_project_settings():
 
 
 @require_handler
-def get_global_settings():
+def _get_global_settings():
     default_settings = load_openpype_default_settings()
     default_values = default_settings["system_settings"]["general"]
     studio_values = _SETTINGS_HANDLER.get_global_settings()
@@ -1053,7 +1085,14 @@ def get_global_settings():
     }
 
 
-def get_general_environments():
+def get_global_settings():
+    if not AYON_SERVER_ENABLED:
+        return _get_global_settings()
+    default_settings = load_openpype_default_settings()
+    return default_settings["system_settings"]["general"]
+
+
+def _get_general_environments():
     """Get general environments.
 
     Function is implemented to be able load general environments without using
@@ -1082,14 +1121,24 @@ def get_general_environments():
     return environments
 
 
-def clear_metadata_from_settings(values):
-    """Remove all metadata keys from loaded settings."""
-    if isinstance(values, dict):
-        for key in tuple(values.keys()):
-            if key in METADATA_KEYS:
-                values.pop(key)
-            else:
-                clear_metadata_from_settings(values[key])
-    elif isinstance(values, list):
-        for item in values:
-            clear_metadata_from_settings(item)
+def get_general_environments():
+    if not AYON_SERVER_ENABLED:
+        return _get_general_environments()
+    value = get_system_settings()
+    return value["general"]["environment"]
+
+
+def get_system_settings(*args, **kwargs):
+    if not AYON_SERVER_ENABLED:
+        return _get_system_settings(*args, **kwargs)
+
+    default_settings = get_default_settings()[SYSTEM_SETTINGS_KEY]
+    return get_ayon_system_settings(default_settings)
+
+
+def get_project_settings(project_name, *args, **kwargs):
+    if not AYON_SERVER_ENABLED:
+        return _get_project_settings(project_name, *args, **kwargs)
+
+    default_settings = get_default_settings()[PROJECT_SETTINGS_KEY]
+    return get_ayon_project_settings(default_settings, project_name)