#!/usr/bin/env python # # Copyright (C) 2021 GNS3 Technologies Inc. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . """ API routes for user groups. """ from fastapi import APIRouter, Depends, Response, status from uuid import UUID from typing import List from gns3server import schemas from gns3server.controller.controller_error import ( ControllerError, ControllerBadRequestError, ControllerNotFoundError, ControllerForbiddenError, ) from gns3server.db.repositories.users import UsersRepository from gns3server.db.repositories.rbac import RbacRepository from .dependencies.database import get_repository import logging log = logging.getLogger(__name__) router = APIRouter() @router.get("", response_model=List[schemas.UserGroup]) async def get_user_groups( users_repo: UsersRepository = Depends(get_repository(UsersRepository)) ) -> List[schemas.UserGroup]: """ Get all user groups. """ return await users_repo.get_user_groups() @router.post( "", response_model=schemas.UserGroup, status_code=status.HTTP_201_CREATED ) async def create_user_group( user_group_create: schemas.UserGroupCreate, users_repo: UsersRepository = Depends(get_repository(UsersRepository)) ) -> schemas.UserGroup: """ Create a new user group. """ if await users_repo.get_user_group_by_name(user_group_create.name): raise ControllerBadRequestError(f"User group '{user_group_create.name}' already exists") return await users_repo.create_user_group(user_group_create) @router.get("/{user_group_id}", response_model=schemas.UserGroup) async def get_user_group( user_group_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)), ) -> schemas.UserGroup: """ Get an user group. """ user_group = await users_repo.get_user_group(user_group_id) if not user_group: raise ControllerNotFoundError(f"User group '{user_group_id}' not found") return user_group @router.put("/{user_group_id}", response_model=schemas.UserGroup) async def update_user_group( user_group_id: UUID, user_group_update: schemas.UserGroupUpdate, users_repo: UsersRepository = Depends(get_repository(UsersRepository)) ) -> schemas.UserGroup: """ Update an user group. """ user_group = await users_repo.get_user_group(user_group_id) if not user_group: raise ControllerNotFoundError(f"User group '{user_group_id}' not found") if user_group.is_builtin: raise ControllerForbiddenError(f"Built-in user group '{user_group_id}' cannot be updated") return await users_repo.update_user_group(user_group_id, user_group_update) @router.delete( "/{user_group_id}", status_code=status.HTTP_204_NO_CONTENT ) async def delete_user_group( user_group_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)), ) -> Response: """ Delete an user group """ user_group = await users_repo.get_user_group(user_group_id) if not user_group: raise ControllerNotFoundError(f"User group '{user_group_id}' not found") if user_group.is_builtin: raise ControllerForbiddenError(f"Built-in user group '{user_group_id}' cannot be deleted") success = await users_repo.delete_user_group(user_group_id) if not success: raise ControllerError(f"User group '{user_group_id}' could not be deleted") return Response(status_code=status.HTTP_204_NO_CONTENT) @router.get("/{user_group_id}/members", response_model=List[schemas.User]) async def get_user_group_members( user_group_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)) ) -> List[schemas.User]: """ Get all user group members. """ return await users_repo.get_user_group_members(user_group_id) @router.put( "/{user_group_id}/members/{user_id}", status_code=status.HTTP_204_NO_CONTENT ) async def add_member_to_group( user_group_id: UUID, user_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)) ) -> Response: """ Add member to an user group. """ user = await users_repo.get_user(user_id) if not user: raise ControllerNotFoundError(f"User '{user_id}' not found") user_group = await users_repo.add_member_to_user_group(user_group_id, user) if not user_group: raise ControllerNotFoundError(f"User group '{user_group_id}' not found") return Response(status_code=status.HTTP_204_NO_CONTENT) @router.delete( "/{user_group_id}/members/{user_id}", status_code=status.HTTP_204_NO_CONTENT ) async def remove_member_from_group( user_group_id: UUID, user_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)), ) -> Response: """ Remove member from an user group. """ user = await users_repo.get_user(user_id) if not user: raise ControllerNotFoundError(f"User '{user_id}' not found") user_group = await users_repo.remove_member_from_user_group(user_group_id, user) if not user_group: raise ControllerNotFoundError(f"User group '{user_group_id}' not found") return Response(status_code=status.HTTP_204_NO_CONTENT) @router.get("/{user_group_id}/roles", response_model=List[schemas.Role]) async def get_user_group_roles( user_group_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)) ) -> List[schemas.Role]: """ Get all user group roles. """ return await users_repo.get_user_group_roles(user_group_id) @router.put( "/{user_group_id}/roles/{role_id}", status_code=status.HTTP_204_NO_CONTENT ) async def add_role_to_group( user_group_id: UUID, role_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)), rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)) ) -> Response: """ Add role to an user group. """ role = await rbac_repo.get_role(role_id) if not role: raise ControllerNotFoundError(f"Role '{role_id}' not found") user_group = await users_repo.add_role_to_user_group(user_group_id, role) if not user_group: raise ControllerNotFoundError(f"User group '{user_group_id}' not found") return Response(status_code=status.HTTP_204_NO_CONTENT) @router.delete( "/{user_group_id}/roles/{role_id}", status_code=status.HTTP_204_NO_CONTENT ) async def remove_role_from_group( user_group_id: UUID, role_id: UUID, users_repo: UsersRepository = Depends(get_repository(UsersRepository)), rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)) ) -> Response: """ Remove role from an user group. """ role = await rbac_repo.get_role(role_id) if not role: raise ControllerNotFoundError(f"Role '{role_id}' not found") user_group = await users_repo.remove_role_from_user_group(user_group_id, role) if not user_group: raise ControllerNotFoundError(f"User group '{user_group_id}' not found") return Response(status_code=status.HTTP_204_NO_CONTENT)