This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for galaxy.managers.roles

Manager and Serializer for Roles.
import logging
from typing import List, Optional

from pydantic import (
from sqlalchemy import false
from sqlalchemy.orm import exc as sqlalchemy_exceptions

import galaxy.exceptions
from galaxy import model
from galaxy.exceptions import RequestParameterInvalidException
from galaxy.managers import base
from galaxy.schema.fields import EncodedDatabaseIdField
from galaxy.util import unicodify

log = logging.getLogger(__name__)

RoleIdField = Field("ID", description="Encoded ID of the role")
RoleNameField = Field(title="Name", description="Name of the role")
RoleDescriptionField = Field(title="Description", description="Description of the role")

[docs]class RoleModel(BaseModel): id: EncodedDatabaseIdField = RoleIdField name: str = RoleNameField description: str = RoleDescriptionField type: str = Field(title="Type", description="Type or category of the role") url: str = Field(title="URL", description="URL for the role") model_class: str = Field(title="Model class", description="Database model class (Role)")
[docs]class RoleDefinitionModel(BaseModel): name: str = RoleNameField description: str = RoleDescriptionField user_ids: Optional[List[EncodedDatabaseIdField]] = Field(title="User IDs", default=[]) group_ids: Optional[List[EncodedDatabaseIdField]] = Field(title="Group IDs", default=[])
[docs]class RoleManager(base.ModelManager): """ Business logic for roles. """ model_class = model.Role foreign_key_name = 'role' user_assoc = model.UserRoleAssociation group_assoc = model.GroupRoleAssociation
[docs] def __init__(self, app): super().__init__(app)
[docs] def get(self, trans, decoded_role_id): """ Method loads the role from the DB based on the given role id. :param decoded_role_id: id of the role to load from the DB :type decoded_role_id: int :returns: the loaded Role object :rtype: galaxy.model.Role :raises: InconsistentDatabase, RequestParameterInvalidException, InternalServerError """ try: role = (self.session().query(self.model_class) .filter(self.model_class.id == decoded_role_id).one()) except sqlalchemy_exceptions.MultipleResultsFound: raise galaxy.exceptions.InconsistentDatabase('Multiple roles found with the same id.') except sqlalchemy_exceptions.NoResultFound: raise galaxy.exceptions.RequestParameterInvalidException('No accessible role found with the id provided.') except Exception as e: raise galaxy.exceptions.InternalServerError('Error loading from the database.' + unicodify(e)) if not (trans.user_is_admin or trans.app.security_agent.ok_to_display(trans.user, role)): raise galaxy.exceptions.RequestParameterInvalidException('No accessible role found with the id provided.') return role
[docs] def list_displayable_roles(self, trans): roles = [] for role in trans.sa_session.query(trans.app.model.Role).filter(trans.app.model.Role.table.c.deleted == false()): if trans.user_is_admin or trans.app.security_agent.ok_to_display(trans.user, role): roles.append(role) return roles
[docs] def create(self, trans, role_definition_model): name = role_definition_model.name description = role_definition_model.description user_ids = role_definition_model.user_ids or [] group_ids = role_definition_model.group_ids or [] if trans.sa_session.query(trans.app.model.Role).filter(trans.app.model.Role.table.c.name == name).first(): raise RequestParameterInvalidException(f"A role with that name already exists [{name}]") role_type = trans.app.model.Role.types.ADMIN # TODO: allow non-admins to create roles role = trans.app.model.Role(name=name, description=description, type=role_type) trans.sa_session.add(role) users = [trans.sa_session.query(trans.model.User).get(trans.security.decode_id(i)) for i in user_ids] groups = [trans.sa_session.query(trans.model.Group).get(trans.security.decode_id(i)) for i in group_ids] # Create the UserRoleAssociations for user in users: trans.app.security_agent.associate_user_role(user, role) # Create the GroupRoleAssociations for group in groups: trans.app.security_agent.associate_group_role(group, role) trans.sa_session.flush() return role