com.convergencelabs.convergence.server.api.realtime.protocol.PermissionProtoConverters.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2021 - Convergence Labs, Inc.
 *
 * This file is part of the Convergence Server, which is released under
 * the terms of the GNU General Public License version 3 (GPLv3). A copy
 * of the GPLv3 should have been provided along with this file, typically
 * located in the "LICENSE" file, which is part of this source code package.
 * Alternatively, see  for the
 * full text of the GPLv3 license, if it was not provided.
 */

package com.convergencelabs.convergence.server.api.realtime.protocol

import com.convergencelabs.convergence.proto.core._
import com.convergencelabs.convergence.server.api.realtime.protocol.IdentityProtoConverters._
import com.convergencelabs.convergence.server.backend.services.domain.permissions.{AddPermissions, RemovePermissions, SetGroupPermissions, SetPermissions, SetUserPermissions}
import com.convergencelabs.convergence.server.model.domain.user.DomainUserId

/**
 * A collection of helper methods to translate domain objects to and from
 * the protocol buffer message classes for Permissions.
 */
object PermissionProtoConverters {
  
  /**
   * Converts a map of group permissions in a Protocol Buffer representation
   * into a Set of domain GroupPermissions.
   *
   * @param groupPermissionData The Protocol Buffer group permissions map.
   * @return A Set of domain GroupPermission.
   */
  def protoToGroupPermissions(groupPermissionData: Map[String, PermissionsList]): Map[String, Set[String]] = {
    groupPermissionData.map {
      case (groupId, permissions) =>
        groupId -> permissions.values.toSet
    }
  }

  /**
   * Converts a Seq of user permissions in a Protocol Buffer representation
   * into a Set of domain UserPermissions.
   *
   * @param userPermissionData The Protocol Buffer group permissions map.
   * @return A Set of domain UserPermissions.
   */
  def protoToUserPermissions(userPermissionData: Seq[UserPermissionsEntry]): Map[DomainUserId, Set[String]] = {
    userPermissionData
      .map { p =>
        val userId = protoToDomainUserId(p.user.get)
        userId -> p.permissions.toSet
      }.groupBy(_._1)
      .map { case (userId, allPermissions) =>
        val consolidated = allPermissions.foldLeft(Set[String]())((curr, next) => curr.concat(next._2))
        userId ->  consolidated
      }
  }

  /**
   * Converts a Seq of world permissions in a Protocol Buffer representation
   * into a Set of domain WorldPermissions.
   *
   * @param worldPermissions The Protocol Buffer string sequence.
   * @return A Set of domain WorldPermissions.
   */
  def protoToWorldPermissions(worldPermissions: Seq[String]): Set[String] = {
    worldPermissions.toSet
  }

  def userPermissionsToProto(userPermission: Map[DomainUserId, Set[String]]): Seq[UserPermissionsEntry] = {
    userPermission
      .map(p => UserPermissionsEntry(Some(domainUserIdToProto(p._1)), p._2.toSeq)).toSeq
  }

  def protoToAddPermissions(message: AddPermissionsRequestMessage): AddPermissions = {
    val AddPermissionsRequestMessage(_, worldPermissionData, userPermissionData, groupPermissionData, _) = message
    val worldPermissions = protoToWorldPermissions(worldPermissionData)
    val userPermissions = protoToUserPermissions(userPermissionData)
    val groupPermissions = protoToGroupPermissions(groupPermissionData)
    AddPermissions(worldPermissions, userPermissions, groupPermissions)
  }

  def protoToRemovePermissions(message: RemovePermissionsRequestMessage): RemovePermissions = {
    val RemovePermissionsRequestMessage(_, worldPermissionData, userPermissionData, groupPermissionData, _) = message
    val worldPermissions = protoToWorldPermissions(worldPermissionData)
    val userPermissions = protoToUserPermissions(userPermissionData)
    val groupPermissions = protoToGroupPermissions(groupPermissionData)
    RemovePermissions(worldPermissions, userPermissions, groupPermissions)
  }

  def protoToSetPermissions(message: SetPermissionsRequestMessage): SetPermissions = {
    val SetPermissionsRequestMessage(_, setWorld, setUser, setGroup, _) = message
    val worldPermissions = setWorld.map(v => protoToWorldPermissions(v.permissions))

    val groupPermissions = setGroup.map{v =>
      SetGroupPermissions(PermissionProtoConverters.protoToGroupPermissions(v.permissions), v.replaceAll)
    }

    val userPermissions = setUser.map{ v =>
      SetUserPermissions(PermissionProtoConverters.protoToUserPermissions(v.permissions), v.replaceAll)
    }

    SetPermissions(worldPermissions, userPermissions, groupPermissions)
  }
}