Source code for galaxy.managers.groups

from typing import (
    Any,
    Dict,
    List,
)

from sqlalchemy import false

from galaxy import model
from galaxy.exceptions import (
    Conflict,
    ObjectAttributeMissingException,
    ObjectNotFound,
)
from galaxy.managers.base import decode_id
from galaxy.managers.context import ProvidesAppContext
from galaxy.model.base import transaction
from galaxy.model.scoped_session import galaxy_scoped_session
from galaxy.schema.fields import (
    DecodedDatabaseIdField,
    EncodedDatabaseIdField,
)
from galaxy.structured_app import MinimalManagerApp
from galaxy.web import url_for


[docs]class GroupsManager: """Interface/service object shared by controllers for interacting with groups."""
[docs] def __init__(self, app: MinimalManagerApp) -> None: self._app = app
[docs] def index(self, trans: ProvidesAppContext): """ Displays a collection (list) of groups. """ rval = [] for group in trans.sa_session.query(model.Group).filter(model.Group.deleted == false()): item = group.to_dict(value_mapper={"id": DecodedDatabaseIdField.encode}) encoded_id = DecodedDatabaseIdField.encode(group.id) item["url"] = url_for("group", id=encoded_id) rval.append(item) return rval
[docs] def create(self, trans: ProvidesAppContext, payload: Dict[str, Any]): """ Creates a new group. """ sa_session = trans.sa_session name = payload.get("name", None) if name is None: raise ObjectAttributeMissingException("Missing required name") self._check_duplicated_group_name(sa_session, name) group = model.Group(name=name) sa_session.add(group) encoded_user_ids = payload.get("user_ids", []) users = self._get_users_by_encoded_ids(sa_session, encoded_user_ids) encoded_role_ids = payload.get("role_ids", []) roles = self._get_roles_by_encoded_ids(sa_session, encoded_role_ids) trans.app.security_agent.set_entity_group_associations(groups=[group], roles=roles, users=users) with transaction(sa_session): sa_session.commit() encoded_id = DecodedDatabaseIdField.encode(group.id) item = group.to_dict(view="element", value_mapper={"id": DecodedDatabaseIdField.encode}) item["url"] = url_for("group", id=encoded_id) return [item]
[docs] def show(self, trans: ProvidesAppContext, group_id: int): """ Displays information about a group. """ encoded_id = DecodedDatabaseIdField.encode(group_id) group = self._get_group(trans.sa_session, group_id) item = group.to_dict(view="element", value_mapper={"id": DecodedDatabaseIdField.encode}) item["url"] = url_for("group", id=encoded_id) item["users_url"] = url_for("group_users", group_id=encoded_id) item["roles_url"] = url_for("group_roles", group_id=encoded_id) return item
[docs] def update(self, trans: ProvidesAppContext, group_id: int, payload: Dict[str, Any]): """ Modifies a group. """ sa_session = trans.sa_session group = self._get_group(sa_session, group_id) name = payload.get("name", None) if name: self._check_duplicated_group_name(sa_session, name) group.name = name sa_session.add(group) encoded_user_ids = payload.get("user_ids", []) users = self._get_users_by_encoded_ids(sa_session, encoded_user_ids) encoded_role_ids = payload.get("role_ids", []) roles = self._get_roles_by_encoded_ids(sa_session, encoded_role_ids) self._app.security_agent.set_entity_group_associations( groups=[group], roles=roles, users=users, delete_existing_assocs=False ) with transaction(sa_session): sa_session.commit()
def _check_duplicated_group_name(self, sa_session: galaxy_scoped_session, group_name: str) -> None: if sa_session.query(model.Group).filter(model.Group.name == group_name).first(): raise Conflict(f"A group with name '{group_name}' already exists") def _get_group(self, sa_session: galaxy_scoped_session, group_id: int) -> model.Group: group = sa_session.query(model.Group).get(group_id) if group is None: raise ObjectNotFound("Group with the provided id was not found.") return group def _get_users_by_encoded_ids( self, sa_session: galaxy_scoped_session, encoded_user_ids: List[EncodedDatabaseIdField] ) -> List[model.User]: user_ids = self._decode_ids(encoded_user_ids) users = sa_session.query(model.User).filter(model.User.table.c.id.in_(user_ids)).all() return users def _get_roles_by_encoded_ids( self, sa_session: galaxy_scoped_session, encoded_role_ids: List[EncodedDatabaseIdField] ) -> List[model.Role]: role_ids = self._decode_ids(encoded_role_ids) roles = sa_session.query(model.Role).filter(model.Role.id.in_(role_ids)).all() return roles def _decode_id(self, encoded_id: EncodedDatabaseIdField) -> int: return decode_id(self._app, encoded_id) def _decode_ids(self, encoded_ids: List[EncodedDatabaseIdField]) -> List[int]: return [self._decode_id(encoded_id) for encoded_id in encoded_ids]