girder 5.0.11.dev18__tar.gz → 5.0.11.dev22__tar.gz

{girder-5.0.11.dev18/girder.egg-info → girder-5.0.11.dev22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder
-Version: 5.0.11.dev18
+Version: 5.0.11.dev22
 Summary: Web-based data management platform
 Home-page: https://girder.readthedocs.org
 Author: Kitware, Inc.

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/docs/plugins.rst

@@ -378,6 +378,29 @@ if this is the first time logging in with these OAuth credentials).
   callback does not create a new Girder Token, nor sets a new authentication
   cookie.
 
+Using OAuth2 with external UI
+*****************************
+If your custom UI needs to support OAuth2 login, you can use the redirect query
+parameter on the ``/oauth/provider`` endpoint to specify where to send users
+after a successful authentication.
+
+Successful Login
+^^^^^^^^^^^^^^^^
+Upon successful login, a ``girderToken`` query parameter containing the
+authentication token will be appended to your redirect URL. Your application can
+then extract and store this token.
+
+Login Restrictions
+^^^^^^^^^^^^^^^^^^
+If the authentication succeeds but the user cannot log in due to system
+policies, an ``error`` query parameter will be appended to the redirect URL
+instead. The potential error values are:
+
+* ``disabled``: The user's account has been disabled in Girder.
+* ``emailVerification``: The user has not yet verified their email address.
+* ``accountApproval``: The account is awaiting administrator approval under the
+  current authentication policy.
+
 
 README
 ------

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/girder/api/v1/assetstore.py

@@ -4,7 +4,7 @@ from girder.constants import AccessType, AssetstoreType, TokenScope
 from girder.exceptions import RestException
 from girder.models.assetstore import Assetstore as AssetstoreModel
 from girder.models.file import File
-from girder.tasks import importDataTask
+from girder.tasks import ensure_local_worker_available, importDataTask
 from girder.utility.model_importer import ModelImporter
 from girder.utility.s3_assetstore_adapter import DEFAULT_REGION
 
@@ -139,6 +139,7 @@ class Assetstore(Resource):
         extraParams = dict(kwargs)
         extraParams.update(kwargs.get('params', {}))
 
+        ensure_local_worker_available()
         # Run the import data task on the local celery queue since it can take a long time
         importDataTask.delay(
             assetstoreId=str(assetstore['_id']),

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/girder/api/v1/collection.py

@@ -2,7 +2,7 @@ from girder.api import access
 from girder.constants import AccessType, TokenScope
 from girder.exceptions import AccessException
 from girder.models.collection import Collection as CollectionModel
-from girder.tasks import deleteCollectionTask
+from girder.tasks import deleteCollectionTask, ensure_local_worker_available
 from girder.utility import ziputil
 from girder.utility.progress import ProgressContext
 
@@ -196,6 +196,7 @@ class Collection(Resource):
         .errorResponse('Admin permission denied on the collection.', 403)
     )
     def deleteCollection(self, collection, progress):
+        ensure_local_worker_available()
         deleteCollectionTask.delay(
             collectionId=str(collection['_id']),
             progress=progress,

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/girder/api/v1/folder.py

@@ -2,7 +2,7 @@ from girder.api import access
 from girder.constants import AccessType, SortDir, TokenScope
 from girder.exceptions import RestException
 from girder.models.folder import Folder as FolderModel
-from girder.tasks import copyFolderTask, deleteFolderTask
+from girder.tasks import copyFolderTask, deleteFolderTask, ensure_local_worker_available
 from girder.utility import ziputil
 from girder.utility.model_importer import ModelImporter
 from girder.utility.progress import ProgressContext
@@ -307,6 +307,7 @@ class Folder(Resource):
         .errorResponse('Admin access was denied for the folder.', 403)
     )
     def deleteFolder(self, folder, progress):
+        ensure_local_worker_available()
         deleteFolderTask.delay(
             folderId=str(folder['_id']),
             progress=progress,
@@ -365,6 +366,7 @@ class Folder(Resource):
         else:
             parent = None
 
+        ensure_local_worker_available()
         copyFolderTask.delay(
             folderId=str(folder['_id']),
             parentType=parentType,
@@ -389,6 +391,7 @@ class Folder(Resource):
         .errorResponse('Write access was denied on the folder.', 403)
     )
     def deleteContents(self, folder, progress):
+        ensure_local_worker_available()
         deleteFolderTask.delay(
             folderId=str(folder['_id']),
             progress=progress,

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/girder/tasks.py

@@ -1,12 +1,69 @@
+import logging
+
 from girder_worker.app import app
 
 from girder.models.assetstore import Assetstore
 from girder.models.collection import Collection
 from girder.models.folder import Folder
 from girder.models.user import User
+from girder.utility._cache import hourCache as _hourCache
 from girder.utility.model_importer import ModelImporter
 from girder.utility.progress import ProgressContext
 
+logger = logging.getLogger(__name__)
+
+
+@_hourCache.cache_on_arguments()
+def is_local_worker_available():
+    """
+    Check if a local worker is available to process tasks.
+
+    This function checks if at least one worker is actively consuming from the
+    'local' queue by inspecting Celery's control interface.
+    When celery is configured with task_always_eager=True, tasks execute
+    in-process and no external worker is needed. In this case, we return True.
+
+    :returns: True if a worker is available or if running in eager mode.
+    """
+    # If celery is configured for eager execution no worker is needed
+    if app.conf.task_always_eager:
+        return True
+    try:
+        # Get an inspector object to check worker status
+        status = app.control.inspect()
+        # When workers are connected and consuming from queues, stats will
+        # return a dict; otherwise stats will be None
+        stats = status.stats()
+        if stats is None or (isinstance(stats, dict) and len(stats) == 0):
+            return False
+        # Also check active_queues to ensure we have workers on the local queue
+        active_queues = status.active_queues()
+        if active_queues is None:
+            return False
+        # Check if any worker has the 'local' queue
+        for _, queues in active_queues.items():
+            if isinstance(queues, list):
+                for queue_info in queues:
+                    if isinstance(queue_info, dict) and queue_info.get('name') == 'local':
+                        return True
+        return False
+    except Exception as e:
+        logger.warning('Failed to check local worker availability: %s', str(e))
+        return False
+
+
+def ensure_local_worker_available():
+    """
+    Check if a local worker is available, raising an exception if not.
+
+    Call this before sending tasks to the 'local' queue.  It raises a
+    RestException with HTTP 503 status if no worker is available.
+    """
+    from girder.exceptions import RestException
+
+    if not is_local_worker_available():
+        raise RestException('No local worker is available to process this request.', code=503)
+
 
 @app.task(queue='local')
 def importDataTask(

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/girder/utility/_cache.py

@@ -66,6 +66,10 @@ register_backend('cherrypy_request', 'girder.utility._cache', 'CherrypyRequestBa
 cache = make_region(name='girder.cache').configure(backend='dogpile.cache.null')
 requestCache = make_region(name='girder.request').configure(backend='dogpile.cache.null')
 
+# This is a one hour TTL cache; it is not set to be reconfigured
+hourCache = make_region(name='girder.hour_cache').configure(
+    backend='dogpile.cache.memory', expiration_time=3600)
+
 # This cache is not configurable by the user, and will always be configured when the server is.
 # It holds data for rate limiting, which is ephemeral, but must be persisted (i.e. it's not optional
 # or best-effort).

{girder-5.0.11.dev18 → girder-5.0.11.dev22/girder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder
-Version: 5.0.11.dev18
+Version: 5.0.11.dev22
 Summary: Web-based data management platform
 Home-page: https://girder.readthedocs.org
 Author: Kitware, Inc.

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/scripts/publicNames.txt

@@ -734,7 +734,10 @@ girder
         copyFolderTask
         deleteCollectionTask
         deleteFolderTask
+        ensure_local_worker_available
         importDataTask
+        is_local_worker_available
+        logger
     utility
         JsonEncoder
             default

{girder-5.0.11.dev18 → girder-5.0.11.dev22}/tox.ini

@@ -89,6 +89,12 @@ allowlist_externals =
 commands =
     {toxinidir}/scripts/test_names.sh
 
+[testenv:public-names-update]
+allowlist_externals =
+    bash
+commands =
+    bash -c 'python {toxinidir}/scripts/publicNames.py > {toxinidir}/scripts/publicNames.txt'
+
 [testenv:pytest_circleci]
 passenv =
     DOCKER_HOST